import type { App } from '../models/App'; import type { AppConnectionStatus } from '../models/AppConnectionStatus'; import type { AppListItem } from '../models/AppListItem'; import type { AppPatch } from '../models/AppPatch'; import type { AppResponse } from '../models/AppResponse'; import type { AppResponseGeneric } from '../models/AppResponseGeneric'; import type { AppStatus } from '../models/AppStatus'; import type { CommonName } from '../models/CommonName'; import type { CommonUserName } from '../models/CommonUserName'; import type { Credentials } from '../models/Credentials'; import type { CredentialsArray } from '../models/CredentialsArray'; import type { WebHook } from '../models/WebHook'; import type { WebHookNameList } from '../models/WebHookNameList'; export declare class AppsService { /** * @returns AppResponse list of apps * @throws ApiError */ static listDeveloperApps({ organizationName, developerUsername, status, pageSize, pageNumber, sortFieldName, sortDirection, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** username of developer **/ developerUsername: CommonUserName; status?: AppStatus; /** The number of items to get per page. Min: 1 Max: 100 **/ pageSize?: number; /** The page number to get. Min: 1 **/ pageNumber?: number; /** name of a field to sort on **/ sortFieldName?: string; /** sort direction **/ sortDirection?: 'asc' | 'desc'; }): Promise>; /** * @returns AppResponse New app * @throws ApiError */ static createDeveloperApp({ organizationName, developerUsername, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** username of developer **/ developerUsername: CommonUserName; /** App information **/ requestBody?: App; }): Promise; /** * @returns AppResponse an app * @throws ApiError */ static getDeveloperApp({ organizationName, developerUsername, appName, topicSyntax, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** username of developer **/ developerUsername: CommonUserName; /** the name of the app **/ appName: string; topicSyntax?: 'smf' | 'mqtt'; }): Promise; /** * @returns AppResponse App * @throws ApiError */ static updateDeveloperApp({ organizationName, developerUsername, appName, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** username of developer **/ developerUsername: CommonUserName; /** the name of the app **/ appName: string; /** Provide the etag value for a previous GET request of a resource on update (PATCH) in order to avoid "lost updates" **/ ifMatch?: string; requestBody?: AppPatch; }): Promise; /** * @returns void * @throws ApiError */ static deleteDeveloperApp({ organizationName, developerUsername, appName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** username of developer **/ developerUsername: CommonUserName; /** the name of the app **/ appName: string; }): Promise; /** * @returns WebHookNameList list of webhooks * @throws ApiError */ static listDeveloperAppWebHooks({ organizationName, developerUsername, appName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** username of developer **/ developerUsername: CommonUserName; /** the name of the app **/ appName: string; }): Promise; /** * @returns WebHook new webhook * @throws ApiError */ static createDeveloperAppWebHook({ organizationName, developerUsername, appName, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** username of developer **/ developerUsername: CommonUserName; /** the name of the app **/ appName: string; /** new webhook **/ requestBody?: WebHook; }): Promise; /** * @returns WebHook the webhook * @throws ApiError */ static getDeveloperAppWebHook({ organizationName, developerUsername, appName, webhookName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** username of developer **/ developerUsername: CommonUserName; /** the name of the app **/ appName: string; webhookName: string; }): Promise; /** * @returns WebHook WebHook * @throws ApiError */ static updateDeveloperAppWebHook({ organizationName, developerUsername, appName, webhookName, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** username of developer **/ developerUsername: CommonUserName; /** the name of the app **/ appName: string; webhookName: string; /** Provide the etag value for a previous GET request of a resource on update (PATCH) in order to avoid "lost updates" **/ ifMatch?: string; /** webhook **/ requestBody?: WebHook; }): Promise; /** * @returns void * @throws ApiError */ static deleteDeveloperAppWebHook({ organizationName, developerUsername, appName, webhookName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** username of developer **/ developerUsername: CommonUserName; /** the name of the app **/ appName: string; webhookName: string; }): Promise; /** * @returns CredentialsArray list of credentials * @throws ApiError */ static listDeveloperAppCredentials({ organizationName, developerUsername, appName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** username of developer **/ developerUsername: CommonUserName; /** the name of the app **/ appName: string; }): Promise; /** * @returns Credentials new credentials * @throws ApiError */ static createDeveloperAppCredentials({ organizationName, developerUsername, appName, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** username of developer **/ developerUsername: CommonUserName; /** the name of the app **/ appName: string; /** new credentials request **/ requestBody?: Credentials; }): Promise; /** * @returns Credentials Credentials * @throws ApiError */ static updateDeveloperAppCredentials({ organizationName, developerUsername, appName, consumerKey, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** username of developer **/ developerUsername: CommonUserName; /** the name of the app **/ appName: string; consumerKey: string; /** Provide the etag value for a previous GET request of a resource on update (PATCH) in order to avoid "lost updates" **/ ifMatch?: string; /** Credentials **/ requestBody?: Credentials; }): Promise; /** * @returns void * @throws ApiError */ static deleteDeveloperAppCredentials({ organizationName, developerUsername, appName, consumerKey, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** username of developer **/ developerUsername: CommonUserName; /** the name of the app **/ appName: string; consumerKey: string; }): Promise; /** * @returns AppResponse list of apps * @throws ApiError */ static listTeamApps({ organizationName, teamName, status, pageSize, pageNumber, sortFieldName, sortDirection, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** name of a team **/ teamName: string; status?: AppStatus; /** The number of items to get per page. Min: 1 Max: 100 **/ pageSize?: number; /** The page number to get. Min: 1 **/ pageNumber?: number; /** name of a field to sort on **/ sortFieldName?: string; /** sort direction **/ sortDirection?: 'asc' | 'desc'; }): Promise>; /** * @returns AppResponse New app * @throws ApiError */ static createTeamApp({ organizationName, teamName, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** name of a team **/ teamName: string; /** App information **/ requestBody?: App; }): Promise; /** * @returns AppResponse an app * @throws ApiError */ static getTeamApp({ organizationName, teamName, appName, topicSyntax, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** name of a team **/ teamName: string; /** the name of the app **/ appName: string; topicSyntax?: 'smf' | 'mqtt'; }): Promise; /** * @returns AppResponse App * @throws ApiError */ static updateTeamApp({ organizationName, teamName, appName, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** name of a team **/ teamName: string; /** the name of the app **/ appName: string; /** Provide the etag value for a previous GET request of a resource on update (PATCH) in order to avoid "lost updates" **/ ifMatch?: string; requestBody?: AppPatch; }): Promise; /** * @returns void * @throws ApiError */ static deleteTeamApp({ organizationName, teamName, appName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** name of a team **/ teamName: string; /** the name of the app **/ appName: string; }): Promise; /** * @returns WebHookNameList list of webhooks * @throws ApiError */ static listTeamAppWebHooks({ organizationName, teamName, appName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** name of a team **/ teamName: string; /** the name of the app **/ appName: string; }): Promise; /** * @returns WebHook new webhook * @throws ApiError */ static createTeamAppWebHook({ organizationName, teamName, appName, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** name of a team **/ teamName: string; /** the name of the app **/ appName: string; /** new webhook **/ requestBody?: WebHook; }): Promise; /** * @returns WebHook the webhook * @throws ApiError */ static getTeamAppWebHook({ organizationName, teamName, appName, webhookName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** name of a team **/ teamName: string; /** the name of the app **/ appName: string; webhookName: string; }): Promise; /** * @returns WebHook WebHook * @throws ApiError */ static updateTeamAppWebHook({ organizationName, teamName, appName, webhookName, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** name of a team **/ teamName: string; /** the name of the app **/ appName: string; webhookName: string; /** Provide the etag value for a previous GET request of a resource on update (PATCH) in order to avoid "lost updates" **/ ifMatch?: string; requestBody?: WebHook; }): Promise; /** * @returns void * @throws ApiError */ static deleteTeamAppWebHook({ organizationName, teamName, appName, webhookName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** name of a team **/ teamName: string; /** the name of the app **/ appName: string; webhookName: string; }): Promise; /** * @returns CredentialsArray list of credentials * @throws ApiError */ static listTeamAppCredentials({ organizationName, teamName, appName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** name of a team **/ teamName: string; /** the name of the app **/ appName: string; }): Promise; /** * @returns Credentials new credentials * @throws ApiError */ static createTeamAppCredentials({ organizationName, teamName, appName, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** name of a team **/ teamName: string; /** the name of the app **/ appName: string; /** new credentials request **/ requestBody?: Credentials; }): Promise; /** * @returns Credentials Credentials * @throws ApiError */ static updateTeamAppCredentials({ organizationName, teamName, appName, consumerKey, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** name of a team **/ teamName: string; /** the name of the app **/ appName: string; consumerKey: string; /** Provide the etag value for a previous GET request of a resource on update (PATCH) in order to avoid "lost updates" **/ ifMatch?: string; /** Credentials **/ requestBody?: Credentials; }): Promise; /** * @returns void * @throws ApiError */ static deleteTeamAppCredentials({ organizationName, teamName, appName, consumerKey, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** name of a team **/ teamName: string; /** the name of the app **/ appName: string; consumerKey: string; }): Promise; /** * @returns AppListItem list of apps * @throws ApiError */ static listApps({ organizationName, status, pageSize, pageNumber, sortFieldName, sortDirection, filter, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; status?: AppStatus; /** The number of items to get per page. Min: 1 Max: 100 **/ pageSize?: number; /** The page number to get. Min: 1 **/ pageNumber?: number; /** name of a field to sort on **/ sortFieldName?: string; /** sort direction **/ sortDirection?: 'asc' | 'desc'; /** specify search terms to filter results on, multiple search terms can be supplied. Search will return results matching any of the terms (OR). Enclose search terms in quotes to limit results to recoirds matching ALL terms (AND).) **/ filter?: string; }): Promise>; /** * @returns AppResponseGeneric an app * @throws ApiError */ static getApp({ organizationName, appName, topicSyntax, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the app **/ appName: string; topicSyntax?: 'smf' | 'mqtt'; }): Promise; /** * @returns AppConnectionStatus status of the app - connections, webhooks, associated queues * @throws ApiError */ static getAppStatus({ organizationName, appName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the app **/ appName: string; }): Promise; /** * @returns CommonName api names associated with the app * @throws ApiError */ static listAppApiSpecifications({ organizationName, appName, pageSize, pageNumber, sortFieldName, sortDirection, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the app **/ appName: string; /** The number of items to get per page. Min: 1 Max: 100 **/ pageSize?: number; /** The page number to get. Min: 1 **/ pageNumber?: number; /** name of a field to sort on **/ sortFieldName?: string; /** sort direction **/ sortDirection?: 'asc' | 'desc'; }): Promise>; /** * @returns any async api sepc * @throws ApiError */ static getAppApiSpecification({ appName, organizationName, apiName, format, }: { /** the name of the app **/ appName: string; /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; format?: 'application/json' | 'application/x-yaml' | 'application/zip'; }): Promise; }