yellowgrid-api-ts 3.2.39-dev.0 → 3.2.40-dev.0

package/dist/src/apis/OAuth20Api.d.ts

@@ -0,0 +1,185 @@
+/**
+ * Yellowgrid
+ * Welcome to the Yellowgrid API documentation.      This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.      ## Key Features:    - **Accounts**: View and manage account details, contacts, client credentials, and verification.    - **Provisioning**: Automate setup and configuration of devices and groups.    - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.    - **Messaging**: Send SMS messages securely via the messaging gateway.    - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.      ## Authentication:    The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.            ## Base URL:    `http://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ *
+ * The version of the OpenAPI document: 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 { AuthCodeResponseModel, ClientDetailsModel, PortalLoginModel, ScopeModel, TokenResponseModel } from '../models/index';
+export interface PostAccessTokenRequest {
+    clientId?: string | null;
+    clientSecret?: string | null;
+    grantType?: PostAccessTokenGrantTypeEnum;
+    scope?: PostAccessTokenScopeEnum;
+    redirectUri?: string | null;
+    code?: string | null;
+    refreshToken?: string | null;
+    codeVerifier?: string | null;
+    token?: string | null;
+    tokenExchangeType?: PostAccessTokenTokenExchangeTypeEnum;
+    licenceKey?: string | null;
+    endUser?: boolean | null;
+}
+export interface PostAuthoriseRequest {
+    clientId: string;
+    responseType: string;
+    scope: PostAuthoriseScopeEnum;
+    redirectUri?: string;
+    state?: string;
+    codeChallenge?: string;
+    codeChallengeMethod?: string;
+}
+export interface PostPortalLoginRequest {
+    portalLoginModel?: PortalLoginModel;
+}
+/**
+ *
+ */
+export declare class OAuth20Api extends runtime.BaseAPI {
+    /**
+     * Get MFA QR Code
+     * Get MFA QR Code
+     */
+    getGetMfaQrCodeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Get MFA QR Code
+     * Get MFA QR Code
+     */
+    getGetMfaQrCode(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Get Scopes
+     * Get Scopes
+     */
+    getGetScopesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ScopeModel>>>;
+    /**
+     * Get Scopes
+     * Get Scopes
+     */
+    getGetScopes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ScopeModel>>;
+    /**
+     * Get an OAuth 2.0 access token
+     * Validates client credentials and returns access token
+     */
+    postAccessTokenRaw(requestParameters: PostAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenResponseModel>>;
+    /**
+     * Get an OAuth 2.0 access token
+     * Validates client credentials and returns access token
+     */
+    postAccessToken(requestParameters?: PostAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenResponseModel>;
+    /**
+     * Get an OAuth 2.0 auth code
+     * Get OAuth2.0 Auth Code
+     */
+    postAuthoriseRaw(requestParameters: PostAuthoriseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Get an OAuth 2.0 auth code
+     * Get OAuth2.0 Auth Code
+     */
+    postAuthorise(requestParameters: PostAuthoriseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get Token Identity
+     * Get Token Identity
+     */
+    postGetIdentityRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientDetailsModel>>;
+    /**
+     * Get Token Identity
+     * Get Token Identity
+     */
+    postGetIdentity(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientDetailsModel>;
+    /**
+     * Portal Login
+     * Portal Login
+     */
+    postPortalLoginRaw(requestParameters: PostPortalLoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthCodeResponseModel>>;
+    /**
+     * Portal Login
+     * Portal Login
+     */
+    postPortalLogin(requestParameters?: PostPortalLoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthCodeResponseModel>;
+}
+/**
+ * @export
+ */
+export declare const PostAccessTokenGrantTypeEnum: {
+    readonly ClientCredentials: "client_credentials";
+    readonly Code: "code";
+    readonly RefreshToken: "refresh_token";
+    readonly AuthorizationCode: "authorization_code";
+    readonly MsAuth: "ms_auth";
+    readonly TokenExchange: "token_exchange";
+    readonly Password: "password";
+};
+export type PostAccessTokenGrantTypeEnum = typeof PostAccessTokenGrantTypeEnum[keyof typeof PostAccessTokenGrantTypeEnum];
+/**
+ * @export
+ */
+export declare const PostAccessTokenScopeEnum: {
+    readonly Star: "*";
+    readonly Fdps: "fdps";
+    readonly Scope: "scope";
+    readonly Portal: "portal";
+    readonly TcxWizard: "tcx_wizard";
+    readonly AccountsRead: "accounts.read";
+    readonly AccountsWrite: "accounts.write";
+    readonly PricingRead: "pricing.read";
+    readonly OrdersRead: "orders.read";
+    readonly OrdersWrite: "orders.write";
+    readonly ProductsRead: "products.read";
+    readonly ProvisioningRead: "provisioning.read";
+    readonly ProvisioningWrite: "provisioning.write";
+    readonly TrunksRead: "trunks.read";
+    readonly TrunksWrite: "trunks.write";
+    readonly TcxIntegrationsRead: "tcx_integrations.read";
+    readonly TcxIntegrationsWrite: "tcx_integrations.write";
+    readonly TcxLicenceDetailsRead: "tcx_licence_details.read";
+    readonly TcxInstallationsRead: "tcx_installations.read";
+    readonly TcxInstallationsWrite: "tcx_installations.write";
+    readonly TcxMtRead: "tcx_mt.read";
+    readonly TcxMtWrite: "tcx_mt.write";
+    readonly TicketsRead: "tickets.read";
+    readonly TicketsWrite: "tickets.write";
+};
+export type PostAccessTokenScopeEnum = typeof PostAccessTokenScopeEnum[keyof typeof PostAccessTokenScopeEnum];
+/**
+ * @export
+ */
+export declare const PostAccessTokenTokenExchangeTypeEnum: {
+    readonly TcxWizard: "tcx_wizard";
+    readonly Portal: "portal";
+};
+export type PostAccessTokenTokenExchangeTypeEnum = typeof PostAccessTokenTokenExchangeTypeEnum[keyof typeof PostAccessTokenTokenExchangeTypeEnum];
+/**
+ * @export
+ */
+export declare const PostAuthoriseScopeEnum: {
+    readonly Star: "*";
+    readonly Fdps: "fdps";
+    readonly Scope: "scope";
+    readonly Portal: "portal";
+    readonly TcxWizard: "tcx_wizard";
+    readonly AccountsRead: "accounts.read";
+    readonly AccountsWrite: "accounts.write";
+    readonly PricingRead: "pricing.read";
+    readonly OrdersRead: "orders.read";
+    readonly OrdersWrite: "orders.write";
+    readonly ProductsRead: "products.read";
+    readonly ProvisioningRead: "provisioning.read";
+    readonly ProvisioningWrite: "provisioning.write";
+    readonly TrunksRead: "trunks.read";
+    readonly TrunksWrite: "trunks.write";
+    readonly TcxIntegrationsRead: "tcx_integrations.read";
+    readonly TcxIntegrationsWrite: "tcx_integrations.write";
+    readonly TcxLicenceDetailsRead: "tcx_licence_details.read";
+    readonly TcxInstallationsRead: "tcx_installations.read";
+    readonly TcxInstallationsWrite: "tcx_installations.write";
+    readonly TcxMtRead: "tcx_mt.read";
+    readonly TcxMtWrite: "tcx_mt.write";
+    readonly TicketsRead: "tickets.read";
+    readonly TicketsWrite: "tickets.write";
+};
+export type PostAuthoriseScopeEnum = typeof PostAuthoriseScopeEnum[keyof typeof PostAuthoriseScopeEnum];