initial
This commit is contained in:
@@ -0,0 +1,9 @@
|
||||
export * from './loint-reception.apitoken.js';
|
||||
export * from './loint-reception.authorization.js';
|
||||
export * from './loint-reception.billingplan.js';
|
||||
export * from './loint-reception.jwt.js';
|
||||
export * from './loint-reception.login.js';
|
||||
export * from './loint-reception.organization.js';
|
||||
export * from './loint-reception.plan.js';
|
||||
export * from './loint-reception.registration.js';
|
||||
export * from './loint-reception.user.js';
|
||||
@@ -0,0 +1 @@
|
||||
export {};
|
||||
@@ -0,0 +1,19 @@
|
||||
import * as plugins from '../loint-reception.plugins.js';
|
||||
import { type IUser, type IRole } from '../data/index.js';
|
||||
|
||||
export interface IReq_InternalAuthorization
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_InternalAuthorization
|
||||
> {
|
||||
method: '';
|
||||
request: {
|
||||
accountData: IUser;
|
||||
jwt: string;
|
||||
};
|
||||
response: {
|
||||
accountData: IUser;
|
||||
jwt: string;
|
||||
relevantRoles: IRole[];
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
import * as plugins from '../loint-reception.plugins.js';
|
||||
import * as data from '../data/index.js';
|
||||
|
||||
export interface IReq_UpdatePaymentMethod
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_UpdatePaymentMethod
|
||||
> {
|
||||
method: 'updatePaymentMethod';
|
||||
request: {
|
||||
jwtString: string;
|
||||
orgId: string;
|
||||
paddle?: {
|
||||
checkoutId: string;
|
||||
};
|
||||
};
|
||||
response: {
|
||||
billingPlan: plugins.tsclass.typeFest.PartialDeep<data.IBillingPlan>;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* allows getting the billing plan for a user
|
||||
*/
|
||||
export interface IReq_GetBillingPlan
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_GetBillingPlan
|
||||
> {
|
||||
method: 'getBillingPlan';
|
||||
request: {
|
||||
jwtString: string;
|
||||
orgId: string;
|
||||
billingPlanId: string;
|
||||
};
|
||||
response: {
|
||||
billingPlan: data.IBillingPlan;
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,45 @@
|
||||
import * as data from '../data/index.js';
|
||||
import * as plugins from '../loint-reception.plugins.js';
|
||||
|
||||
export interface IReq_GetPublicKeyForValidation
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_GetPublicKeyForValidation
|
||||
> {
|
||||
method: 'getPublicKeyForValidation';
|
||||
request: {
|
||||
backendToken: string;
|
||||
};
|
||||
response: {
|
||||
publicKeyPem: string;
|
||||
};
|
||||
}
|
||||
|
||||
export interface IReq_PushPublicKeyForValidation
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_PushPublicKeyForValidation
|
||||
> {
|
||||
method: 'pushPublicKeyForValidation';
|
||||
request: {
|
||||
publicKeyPem: string;
|
||||
};
|
||||
response: {};
|
||||
}
|
||||
|
||||
/**
|
||||
* allows getting or pushing a blocklist of jwt ids
|
||||
*/
|
||||
export interface IReq_PushOrGetJwtIdBlocklist
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_PushOrGetJwtIdBlocklist
|
||||
> {
|
||||
method: 'pushOrGetJwtIdBlocklist';
|
||||
request: {
|
||||
blockedJwtIds?: string[];
|
||||
};
|
||||
response: {
|
||||
blockedJwtIds?: string[];
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,180 @@
|
||||
import * as plugins from '../loint-reception.plugins.js';
|
||||
import * as data from '../data/index.js';
|
||||
|
||||
export interface IReq_LoginWithEmailOrUsernameAndPassword
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_LoginWithEmailOrUsernameAndPassword
|
||||
> {
|
||||
method: 'loginWithEmailOrUsernameAndPassword';
|
||||
request: {
|
||||
username: string;
|
||||
password: string;
|
||||
};
|
||||
response: {
|
||||
refreshToken?: string;
|
||||
twoFaNeeded: boolean;
|
||||
};
|
||||
}
|
||||
|
||||
export interface IReq_LoginWithEmail
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_LoginWithEmailOrUsernameAndPassword
|
||||
> {
|
||||
method: 'loginWithEmail';
|
||||
request: {
|
||||
email: string;
|
||||
};
|
||||
response: {
|
||||
status: 'ok' | 'not ok';
|
||||
testOnlyToken?: string;
|
||||
};
|
||||
}
|
||||
|
||||
export interface IReq_LoginWithEmailAfterEmailTokenAquired
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_LoginWithEmailOrUsernameAndPassword
|
||||
> {
|
||||
method: 'loginWithEmailAfterEmailTokenAquired';
|
||||
request: {
|
||||
email: string;
|
||||
token: string;
|
||||
};
|
||||
response: {
|
||||
refreshToken: string;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* in case you authenticate with a long lived api token
|
||||
*/
|
||||
export interface IReq_LoginWithApiToken
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_LoginWithApiToken
|
||||
> {
|
||||
method: 'loginWithApiToken';
|
||||
request: {
|
||||
apiToken: string;
|
||||
};
|
||||
response: {
|
||||
jwt?: string;
|
||||
};
|
||||
}
|
||||
|
||||
export interface ILogoutRequest
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
ILogoutRequest
|
||||
> {
|
||||
method: 'logout';
|
||||
request: {
|
||||
refreshToken: string;
|
||||
};
|
||||
response: {};
|
||||
}
|
||||
|
||||
export interface IReq_RefreshJwt
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_RefreshJwt
|
||||
> {
|
||||
method: 'refreshJwt';
|
||||
request: {
|
||||
refreshToken: string;
|
||||
};
|
||||
response: {
|
||||
status: data.TLoginStatus;
|
||||
jwt: string;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* allows the exchange between refreshToken and transferTokens
|
||||
*/
|
||||
export interface IReq_ExchangeRefreshTokenAndTransferToken
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_ExchangeRefreshTokenAndTransferToken
|
||||
> {
|
||||
method: 'exchangeRefreshTokenAndTransferToken';
|
||||
request: {
|
||||
transferToken?: string;
|
||||
refreshToken?: string;
|
||||
appData: data.IApp;
|
||||
};
|
||||
response: {
|
||||
refreshToken?: string;
|
||||
transferToken?: string;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* in case you authenticate with a long lived api token
|
||||
*/
|
||||
export interface IReq_ResetPassword
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_ResetPassword
|
||||
> {
|
||||
method: 'resetPassword';
|
||||
request: {
|
||||
email: string;
|
||||
};
|
||||
response: {
|
||||
status: 'ok' | 'not ok';
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* in cse you authenticate with a long lived api token
|
||||
*/
|
||||
export interface IReq_SetNewPassword
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_SetNewPassword
|
||||
> {
|
||||
method: 'setNewPassword';
|
||||
request: {
|
||||
email: string;
|
||||
oldPassword?: string;
|
||||
tokenArg?: string;
|
||||
newPassword: string;
|
||||
};
|
||||
response: {
|
||||
status: 'ok' | 'not ok';
|
||||
};
|
||||
}
|
||||
|
||||
export interface IReq_ObtainDeviceId
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_ObtainDeviceId
|
||||
> {
|
||||
method: 'obtainDeviceId';
|
||||
request: {};
|
||||
response: {
|
||||
deviceId: data.IDevice;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* allows attaching a device id to a login session
|
||||
* to share a login session across contexts
|
||||
*/
|
||||
export interface IReq_AttachDeviceId
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_AttachDeviceId
|
||||
> {
|
||||
method: 'attachDeviceId';
|
||||
request: {
|
||||
jwt: string;
|
||||
deviceId: string;
|
||||
};
|
||||
response: {
|
||||
ok: boolean;
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
import * as data from '../data/index.js';
|
||||
import * as plugins from '../loint-reception.plugins.js';
|
||||
|
||||
export interface IReq_GetOrganizationById
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_GetOrganizationById
|
||||
> {
|
||||
method: 'getOrganizationById';
|
||||
request: {
|
||||
jwt: string;
|
||||
id: string;
|
||||
};
|
||||
response: {
|
||||
organization: data.IOrganization;
|
||||
};
|
||||
}
|
||||
|
||||
export interface IReq_CreateOrganization
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_CreateOrganization
|
||||
> {
|
||||
method: 'createOrganization';
|
||||
request: {
|
||||
jwt: string;
|
||||
userId: string;
|
||||
organizationName: string;
|
||||
organizationSlug: string;
|
||||
action: 'checkAvailability' | 'manifest';
|
||||
};
|
||||
response: {
|
||||
nameAvailable: boolean;
|
||||
resultingOrganization?: data.IOrganization;
|
||||
role?: data.IRole;
|
||||
};
|
||||
}
|
||||
|
||||
export interface IReq_UpdateOrganization
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_UpdateOrganization
|
||||
> {
|
||||
method: 'updateOrganization';
|
||||
request: {
|
||||
organization: data.IOrganization;
|
||||
};
|
||||
response: {
|
||||
organization: data.IOrganization;
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
import * as data from '../data/index.js';
|
||||
import * as plugins from '../loint-reception.plugins.js';
|
||||
|
||||
export interface IReq_GetPlansForOrganizationId
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_GetPlansForOrganizationId
|
||||
> {
|
||||
method: 'getBillingPlansForOrganizationId';
|
||||
request: {
|
||||
jwt: string;
|
||||
organizationId: string;
|
||||
};
|
||||
response: {
|
||||
billingPlans: data.IBillingPlan[];
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,90 @@
|
||||
import * as plugins from '../loint-reception.plugins.js';
|
||||
import { type IUser } from '../data/index.js';
|
||||
|
||||
export interface IReq_FirstRegistration
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_FirstRegistration
|
||||
> {
|
||||
method: 'firstRegistrationRequest';
|
||||
request: {
|
||||
email: string;
|
||||
productSlugOfInterest: string;
|
||||
};
|
||||
response: {
|
||||
status: 'ok' | 'not ok';
|
||||
testOnlyToken?: string;
|
||||
};
|
||||
}
|
||||
|
||||
export interface IReq_AfterRegistrationEmailClicked
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_AfterRegistrationEmailClicked
|
||||
> {
|
||||
method: 'afterRegistrationEmailClicked';
|
||||
request: {
|
||||
/**
|
||||
* the token that has been sent with the registation email to verify access
|
||||
*/
|
||||
token: string;
|
||||
};
|
||||
response: {
|
||||
status: 'ok' | 'not ok';
|
||||
/**
|
||||
* the email thats associated with the given request token
|
||||
*/
|
||||
email: string;
|
||||
};
|
||||
}
|
||||
|
||||
export interface IReq_SetDataForRegistration
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_SetDataForRegistration
|
||||
> {
|
||||
method: 'setDataForRegistration';
|
||||
request: {
|
||||
token: string;
|
||||
userData: IUser['data'];
|
||||
};
|
||||
response: {
|
||||
status: 'ok' | 'not ok';
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Should be used to verify a mobile number for an verifcation
|
||||
*/
|
||||
export interface IReq_MobileVerificationForRegistration
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_MobileVerificationForRegistration
|
||||
> {
|
||||
method: 'mobileVerificationForRegistration';
|
||||
request: {
|
||||
token: string;
|
||||
mobileNumber?: string;
|
||||
verificationCode?: string;
|
||||
};
|
||||
response: {
|
||||
messageSent?: boolean;
|
||||
verficationCodeOk?: boolean;
|
||||
testOnlySmsCode?: string;
|
||||
};
|
||||
}
|
||||
|
||||
export interface IReq_FinishRegistration
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_FinishRegistration
|
||||
> {
|
||||
method: 'finishRegistration';
|
||||
request: {
|
||||
token: string;
|
||||
};
|
||||
response: {
|
||||
status: 'ok' | 'not ok';
|
||||
userData?: IUser['data'];
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,76 @@
|
||||
import * as data from '../data/index.js';
|
||||
import * as plugins from '../loint-reception.plugins.js';
|
||||
|
||||
export interface IReq_GetUserData
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_GetUserData
|
||||
> {
|
||||
method: 'getUserData';
|
||||
request: {
|
||||
refreshToken: string;
|
||||
};
|
||||
response: {
|
||||
jwt: string;
|
||||
};
|
||||
}
|
||||
|
||||
export interface IReq_SetUserData
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_SetUserData
|
||||
> {
|
||||
method: 'setUserData';
|
||||
request: {
|
||||
refreshToken: string;
|
||||
};
|
||||
response: {
|
||||
oneTimeTransferCode: string;
|
||||
};
|
||||
}
|
||||
|
||||
export interface IReq_SuspendUser
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_SuspendUser
|
||||
> {
|
||||
method: 'suspendUser';
|
||||
request: {
|
||||
jwt: string;
|
||||
userId: string;
|
||||
};
|
||||
response: {
|
||||
publicKeyPem: string;
|
||||
};
|
||||
}
|
||||
|
||||
export interface IDeleteSuspendedUser
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IDeleteSuspendedUser
|
||||
> {
|
||||
method: 'deleteSuspendedUser';
|
||||
request: {
|
||||
backendToken: string;
|
||||
};
|
||||
response: {
|
||||
ok: boolean;
|
||||
errorText?: string;
|
||||
};
|
||||
}
|
||||
|
||||
export interface IReq_GetRolesAndOrganizationsForUserId
|
||||
extends plugins.typedRequestInterfaces.implementsTR<
|
||||
plugins.typedRequestInterfaces.ITypedRequest,
|
||||
IReq_GetRolesAndOrganizationsForUserId
|
||||
> {
|
||||
method: 'getRolesAndOrganizationsForUserId';
|
||||
request: {
|
||||
jwt: string;
|
||||
userId: string;
|
||||
};
|
||||
response: {
|
||||
roles: data.IRole[];
|
||||
organizations: data.IOrganization[];
|
||||
};
|
||||
}
|
||||
Reference in New Issue
Block a user