sowhat-types 2.0.4 → 2.0.6

package/dist/index.d.mts

@@ -0,0 +1,354 @@
+declare enum AssetTypeEnum {
+    REAL_ESTATE = "REAL_ESTATE",
+    MOBILITY = "MOBILITY",
+    STOCK_EXCHANGE = "STOCK_EXCHANGE",
+    CRYPTOCURRENCY = "CRYPTOCURRENCY",
+    OTHER = "OTHER"
+}
+
+declare enum AuthenticationMethodEnum {
+    PHONE = "PHONE",
+    EMAIL = "EMAIL"
+}
+
+declare enum BankAccountSchemeNameEnum {
+    IBAN = "IBAN",
+    BBAN = "BBAN",
+    SORT_CODE_ACCOUNT_NUMBER = "SORT_CODE_ACCOUNT_NUMBER",
+    CPAN = "CPAN",
+    TPAN = "TPAN"
+}
+
+declare enum BankAccountTransactionTypeEnum {
+    TRANSFER = "TRANSFER",// Transfer
+    ORDER = "ORDER",// Order
+    CHECK = "CHECK",// Check
+    DEPOSIT = "DEPOSIT",// Mandatory/voluntary deposits, contributions, money transfers
+    PAYBACK = "PAYBACK",// Payback
+    WITHDRAWAL = "WITHDRAWAL",// Withdrawal
+    LOAN_REPAYMENT = "LOAN_REPAYMENT",// Loan payment
+    BANK = "BANK",// Bank fees
+    CARD = "CARD",// Card operation
+    DEFERRED_CARD = "DEFERRED_CARD",// Deferred card operation
+    SUMMARY_CARD = "SUMMARY_CARD",// Monthly debit of a deferred card
+    UNKNOWN = "UNKNOWN",//Unknown transaction type
+    MARKET_ORDER = "MARKET_ORDER",// Market order
+    MARKET_FEE = "MARKET_FEE",// Fees regarding a market order
+    ARBITRAGE = "ARBITRAGE",// Arbitrage
+    PROFIT = "PROFIT"
+}
+
+declare enum BankAccountTypeEnum {
+    CHECKING = "CHECKING",
+    SAVINGS = "SAVINGS",
+    OTHER = "OTHER"
+}
+
+declare enum MobilityTypeEnum {
+    CAR = "CAR",
+    MOTORCYCLE = "MOTORCYCLE",
+    BICYCLE = "BICYCLE",
+    OTHER = "OTHER"
+}
+
+declare enum PowensUserStatusEnum {
+    REGISTERED = "REGISTERED",
+    ATTEMPTING_NEW_CONNECTION = "ATTEMPTING_NEW_CONNECTION",
+    ON_ERROR = "ON_ERROR",
+    DELETED = "DELETED"
+}
+
+declare enum UserStatusEnum {
+    ANONYMOUS = "ANONYMOUS",
+    REGISTERED = "REGISTERED",
+    DELETED = "DELETED",
+    BLACK_LISTED = "BLACK_LISTED"
+}
+
+interface CreateAssetCoOwnerInput {
+    id: string;
+    coOwnershipShare: number;
+    coOwnerFinancialShare: number;
+}
+
+interface CreateAssetDateOfAcquisitionInput {
+    month: number;
+    year: number;
+}
+
+interface FetchUserBankAccountsInput {
+    userId: string;
+    accountId: number;
+}
+
+interface CreateMobilityInput {
+    userId: string;
+    customTitle: string;
+    customImage: string | null;
+    price: number;
+    licenceNumber: string | null;
+    dateOfAcquisition: CreateAssetDateOfAcquisitionInput | null;
+    mobilityType: MobilityTypeEnum;
+    mileage: number | null;
+    note: string | null;
+    gotLoan: boolean;
+    coOwner: CreateAssetCoOwnerInput | null;
+}
+
+interface CreateRealEstateInput {
+    userId: string;
+    gotLoan: boolean;
+    customTitle: string;
+    customImage: string | null;
+    price: number;
+    note: string | null;
+    isMainResidence: boolean;
+    coOwner: CreateAssetCoOwnerInput | null;
+}
+
+interface LogoutUserInput {
+    userId: string;
+}
+
+interface CreateUserCoOwnerInput {
+    userId: string;
+    customName: string;
+    email: string | null;
+    phone: string | null;
+    customImage: string | null;
+}
+
+interface DeleteUserCoOwnerInput {
+    userId: string;
+    coOwnerId: string;
+}
+
+interface FetchUserCoOwnerInput {
+    userId: string;
+    coOwnerId: string;
+}
+
+interface BankAccountBalancesResponse {
+    /**
+     * total balance for checking type accounts
+     */
+    checking: number | null;
+    /**
+     * total incoming balance for checking type accounts
+     */
+    incomingChecking: number | null;
+    /**
+     * total balance for savings type accounts
+     */
+    savings: number | null;
+    /**
+     * total incoming balance for savings type accounts
+     */
+    incomingSavings: number | null;
+    /**
+     * e.g. '€'
+     */
+    currency: string;
+}
+
+interface BankAccountOriginalTransactionResponse {
+    value: number;
+    currency: string;
+    commission: number | null;
+    commissionCurrency: string | null;
+}
+
+interface BankAccountTransactionCounterpartyResponse {
+    label: string | null;
+    accountScheme: BankAccountSchemeNameEnum | null;
+    type: string | null;
+}
+
+interface BankAccountTransactionExtraDataResponse {
+    datetime: Date | null;
+    counterparty: BankAccountTransactionCounterpartyResponse | null;
+    country: string | null;
+}
+
+interface BankAccountTransactionWordingResponse {
+    original: string;
+    stemmed: string;
+    simplified: string;
+    /**
+     * The one that can be edited by the user and update in the transaction by Powens API
+     */
+    custom: string | null;
+}
+
+interface BankAccountTransactionResponse {
+    id: string;
+    accountId: string;
+    date: Date;
+    value: number | null;
+    currency: string | null;
+    wording: BankAccountTransactionWordingResponse;
+    coming: boolean;
+    active: boolean;
+    comment: string | null;
+    lastUpdate: Date | null;
+    deleted: Date | null;
+    cardNumber: string | null;
+    type: BankAccountTransactionTypeEnum;
+    new: boolean;
+    originalTransaction: BankAccountOriginalTransactionResponse | null;
+    extraData: BankAccountTransactionExtraDataResponse;
+}
+
+interface BankAccountTransactionsResponse {
+    transactions: BankAccountTransactionResponse[];
+}
+
+interface BankAccountResponse {
+    id: number;
+    balance: number | null;
+    name: string;
+    originalName: string;
+    currency: string;
+    type: BankAccountTypeEnum;
+    gotLoan: boolean;
+    iban: string | null;
+}
+
+interface BankAccountsResponse {
+    accounts: BankAccountResponse[];
+    balances: BankAccountBalancesResponse | null;
+}
+
+interface CryptocurrencyResponse {
+    id: string;
+}
+
+interface MobilityDeletedResponse {
+    deleted: boolean;
+    errorMessage: string | null;
+}
+
+interface AssetCoOwnerResponse {
+    id: string;
+    customName: string;
+    coOwnershipShare: number;
+    coOwnerFinancialShare: number;
+}
+
+interface AssetDateOfAcquisitionResponse {
+    month: number;
+    year: number;
+}
+
+interface MobilityResponse {
+    id: string;
+    userId: string;
+    customImage: string | null;
+    customTitle: string;
+    price: number;
+    licenceNumber: string | null;
+    dateOfAcquisition: AssetDateOfAcquisitionResponse | null;
+    mobilityType: MobilityTypeEnum;
+    mileage: number | null;
+    note: string | null;
+    gotLoan: boolean;
+    coOwner: AssetCoOwnerResponse | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+interface OtherAssetResponse {
+    id: string;
+}
+
+interface RealEstateDeletedResponse {
+    deleted: boolean;
+    errorMessage: string | null;
+}
+
+interface RealEstateResponse {
+    id: string;
+    userId: string;
+    gotLoan: boolean;
+    customTitle: string;
+    customImage: string | null;
+    price: number;
+    note: string | null;
+    isMainResidence: boolean;
+    coOwner: AssetCoOwnerResponse | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+interface StockExchangeResponse {
+    id: string;
+}
+
+interface AccessTokensResponse {
+    accessToken: string;
+    accessTokenDuration: number;
+    refreshToken: string;
+}
+
+interface AuthenticationAccessResponse extends AccessTokensResponse {
+    userId: string;
+    isLogged: boolean;
+}
+
+interface LogoutUserResponse {
+    userId: string;
+    isLoggedOut: boolean;
+}
+
+interface CoOwnerDeletedResponse {
+    deleted: boolean;
+    errorMessage: string | null;
+}
+
+interface CoOwnerResponse {
+    id: string;
+    customName: string;
+    email: string | null;
+    phone: string | null;
+    customImage: string | null;
+    updatedAt: Date;
+    createdAt: Date;
+}
+
+interface UserCoOwnerResponse extends CoOwnerResponse {
+    numberOfCoOwnAssets: number;
+}
+
+interface PowensWebviewConnectionResponse {
+    id: string;
+    connectionUrl: string;
+    createdAt: Date;
+}
+
+interface UserResponse {
+    id: string;
+    clerkId: string;
+    firstname: string;
+    lastname: string | null;
+    email: string | null;
+    status: UserStatusEnum;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+interface AssetsResponse {
+    realEstateAssets: RealEstateResponse[];
+    mobilityAssets: MobilityResponse[];
+    cryptocurrencyAssets: CryptocurrencyResponse[];
+    stockExchangeAssets: StockExchangeResponse[];
+    otherAssets: OtherAssetResponse[];
+}
+
+type ExactMatch<T, U extends T> = T & Record<keyof T, keyof U>;
+
+declare class FilterArgs {
+    skip: number;
+    take: number;
+}
+
+export { type AccessTokensResponse, type AssetCoOwnerResponse, type AssetDateOfAcquisitionResponse, AssetTypeEnum, type AssetsResponse, type AuthenticationAccessResponse, AuthenticationMethodEnum, type BankAccountBalancesResponse, type BankAccountOriginalTransactionResponse, type BankAccountResponse, BankAccountSchemeNameEnum, type BankAccountTransactionCounterpartyResponse, type BankAccountTransactionExtraDataResponse, type BankAccountTransactionResponse, BankAccountTransactionTypeEnum, type BankAccountTransactionWordingResponse, type BankAccountTransactionsResponse, BankAccountTypeEnum, type BankAccountsResponse, type CoOwnerDeletedResponse, type CoOwnerResponse, type CreateAssetCoOwnerInput, type CreateAssetDateOfAcquisitionInput, type CreateMobilityInput, type CreateRealEstateInput, type CreateUserCoOwnerInput, type CryptocurrencyResponse, type DeleteUserCoOwnerInput, type ExactMatch, type FetchUserBankAccountsInput, type FetchUserCoOwnerInput, FilterArgs, type LogoutUserInput, type LogoutUserResponse, type MobilityDeletedResponse, type MobilityResponse, MobilityTypeEnum, type OtherAssetResponse, PowensUserStatusEnum, type PowensWebviewConnectionResponse, type RealEstateDeletedResponse, type RealEstateResponse, type StockExchangeResponse, type UserCoOwnerResponse, type UserResponse, UserStatusEnum };

package/dist/index.d.ts

@@ -1,4 +1,354 @@
-export * from './enums/index';
-export * from './inputs/index';
-export * from './responses/index';
-export * from './exact-match';
+declare enum AssetTypeEnum {
+    REAL_ESTATE = "REAL_ESTATE",
+    MOBILITY = "MOBILITY",
+    STOCK_EXCHANGE = "STOCK_EXCHANGE",
+    CRYPTOCURRENCY = "CRYPTOCURRENCY",
+    OTHER = "OTHER"
+}
+
+declare enum AuthenticationMethodEnum {
+    PHONE = "PHONE",
+    EMAIL = "EMAIL"
+}
+
+declare enum BankAccountSchemeNameEnum {
+    IBAN = "IBAN",
+    BBAN = "BBAN",
+    SORT_CODE_ACCOUNT_NUMBER = "SORT_CODE_ACCOUNT_NUMBER",
+    CPAN = "CPAN",
+    TPAN = "TPAN"
+}
+
+declare enum BankAccountTransactionTypeEnum {
+    TRANSFER = "TRANSFER",// Transfer
+    ORDER = "ORDER",// Order
+    CHECK = "CHECK",// Check
+    DEPOSIT = "DEPOSIT",// Mandatory/voluntary deposits, contributions, money transfers
+    PAYBACK = "PAYBACK",// Payback
+    WITHDRAWAL = "WITHDRAWAL",// Withdrawal
+    LOAN_REPAYMENT = "LOAN_REPAYMENT",// Loan payment
+    BANK = "BANK",// Bank fees
+    CARD = "CARD",// Card operation
+    DEFERRED_CARD = "DEFERRED_CARD",// Deferred card operation
+    SUMMARY_CARD = "SUMMARY_CARD",// Monthly debit of a deferred card
+    UNKNOWN = "UNKNOWN",//Unknown transaction type
+    MARKET_ORDER = "MARKET_ORDER",// Market order
+    MARKET_FEE = "MARKET_FEE",// Fees regarding a market order
+    ARBITRAGE = "ARBITRAGE",// Arbitrage
+    PROFIT = "PROFIT"
+}
+
+declare enum BankAccountTypeEnum {
+    CHECKING = "CHECKING",
+    SAVINGS = "SAVINGS",
+    OTHER = "OTHER"
+}
+
+declare enum MobilityTypeEnum {
+    CAR = "CAR",
+    MOTORCYCLE = "MOTORCYCLE",
+    BICYCLE = "BICYCLE",
+    OTHER = "OTHER"
+}
+
+declare enum PowensUserStatusEnum {
+    REGISTERED = "REGISTERED",
+    ATTEMPTING_NEW_CONNECTION = "ATTEMPTING_NEW_CONNECTION",
+    ON_ERROR = "ON_ERROR",
+    DELETED = "DELETED"
+}
+
+declare enum UserStatusEnum {
+    ANONYMOUS = "ANONYMOUS",
+    REGISTERED = "REGISTERED",
+    DELETED = "DELETED",
+    BLACK_LISTED = "BLACK_LISTED"
+}
+
+interface CreateAssetCoOwnerInput {
+    id: string;
+    coOwnershipShare: number;
+    coOwnerFinancialShare: number;
+}
+
+interface CreateAssetDateOfAcquisitionInput {
+    month: number;
+    year: number;
+}
+
+interface FetchUserBankAccountsInput {
+    userId: string;
+    accountId: number;
+}
+
+interface CreateMobilityInput {
+    userId: string;
+    customTitle: string;
+    customImage: string | null;
+    price: number;
+    licenceNumber: string | null;
+    dateOfAcquisition: CreateAssetDateOfAcquisitionInput | null;
+    mobilityType: MobilityTypeEnum;
+    mileage: number | null;
+    note: string | null;
+    gotLoan: boolean;
+    coOwner: CreateAssetCoOwnerInput | null;
+}
+
+interface CreateRealEstateInput {
+    userId: string;
+    gotLoan: boolean;
+    customTitle: string;
+    customImage: string | null;
+    price: number;
+    note: string | null;
+    isMainResidence: boolean;
+    coOwner: CreateAssetCoOwnerInput | null;
+}
+
+interface LogoutUserInput {
+    userId: string;
+}
+
+interface CreateUserCoOwnerInput {
+    userId: string;
+    customName: string;
+    email: string | null;
+    phone: string | null;
+    customImage: string | null;
+}
+
+interface DeleteUserCoOwnerInput {
+    userId: string;
+    coOwnerId: string;
+}
+
+interface FetchUserCoOwnerInput {
+    userId: string;
+    coOwnerId: string;
+}
+
+interface BankAccountBalancesResponse {
+    /**
+     * total balance for checking type accounts
+     */
+    checking: number | null;
+    /**
+     * total incoming balance for checking type accounts
+     */
+    incomingChecking: number | null;
+    /**
+     * total balance for savings type accounts
+     */
+    savings: number | null;
+    /**
+     * total incoming balance for savings type accounts
+     */
+    incomingSavings: number | null;
+    /**
+     * e.g. '€'
+     */
+    currency: string;
+}
+
+interface BankAccountOriginalTransactionResponse {
+    value: number;
+    currency: string;
+    commission: number | null;
+    commissionCurrency: string | null;
+}
+
+interface BankAccountTransactionCounterpartyResponse {
+    label: string | null;
+    accountScheme: BankAccountSchemeNameEnum | null;
+    type: string | null;
+}
+
+interface BankAccountTransactionExtraDataResponse {
+    datetime: Date | null;
+    counterparty: BankAccountTransactionCounterpartyResponse | null;
+    country: string | null;
+}
+
+interface BankAccountTransactionWordingResponse {
+    original: string;
+    stemmed: string;
+    simplified: string;
+    /**
+     * The one that can be edited by the user and update in the transaction by Powens API
+     */
+    custom: string | null;
+}
+
+interface BankAccountTransactionResponse {
+    id: string;
+    accountId: string;
+    date: Date;
+    value: number | null;
+    currency: string | null;
+    wording: BankAccountTransactionWordingResponse;
+    coming: boolean;
+    active: boolean;
+    comment: string | null;
+    lastUpdate: Date | null;
+    deleted: Date | null;
+    cardNumber: string | null;
+    type: BankAccountTransactionTypeEnum;
+    new: boolean;
+    originalTransaction: BankAccountOriginalTransactionResponse | null;
+    extraData: BankAccountTransactionExtraDataResponse;
+}
+
+interface BankAccountTransactionsResponse {
+    transactions: BankAccountTransactionResponse[];
+}
+
+interface BankAccountResponse {
+    id: number;
+    balance: number | null;
+    name: string;
+    originalName: string;
+    currency: string;
+    type: BankAccountTypeEnum;
+    gotLoan: boolean;
+    iban: string | null;
+}
+
+interface BankAccountsResponse {
+    accounts: BankAccountResponse[];
+    balances: BankAccountBalancesResponse | null;
+}
+
+interface CryptocurrencyResponse {
+    id: string;
+}
+
+interface MobilityDeletedResponse {
+    deleted: boolean;
+    errorMessage: string | null;
+}
+
+interface AssetCoOwnerResponse {
+    id: string;
+    customName: string;
+    coOwnershipShare: number;
+    coOwnerFinancialShare: number;
+}
+
+interface AssetDateOfAcquisitionResponse {
+    month: number;
+    year: number;
+}
+
+interface MobilityResponse {
+    id: string;
+    userId: string;
+    customImage: string | null;
+    customTitle: string;
+    price: number;
+    licenceNumber: string | null;
+    dateOfAcquisition: AssetDateOfAcquisitionResponse | null;
+    mobilityType: MobilityTypeEnum;
+    mileage: number | null;
+    note: string | null;
+    gotLoan: boolean;
+    coOwner: AssetCoOwnerResponse | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+interface OtherAssetResponse {
+    id: string;
+}
+
+interface RealEstateDeletedResponse {
+    deleted: boolean;
+    errorMessage: string | null;
+}
+
+interface RealEstateResponse {
+    id: string;
+    userId: string;
+    gotLoan: boolean;
+    customTitle: string;
+    customImage: string | null;
+    price: number;
+    note: string | null;
+    isMainResidence: boolean;
+    coOwner: AssetCoOwnerResponse | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+interface StockExchangeResponse {
+    id: string;
+}
+
+interface AccessTokensResponse {
+    accessToken: string;
+    accessTokenDuration: number;
+    refreshToken: string;
+}
+
+interface AuthenticationAccessResponse extends AccessTokensResponse {
+    userId: string;
+    isLogged: boolean;
+}
+
+interface LogoutUserResponse {
+    userId: string;
+    isLoggedOut: boolean;
+}
+
+interface CoOwnerDeletedResponse {
+    deleted: boolean;
+    errorMessage: string | null;
+}
+
+interface CoOwnerResponse {
+    id: string;
+    customName: string;
+    email: string | null;
+    phone: string | null;
+    customImage: string | null;
+    updatedAt: Date;
+    createdAt: Date;
+}
+
+interface UserCoOwnerResponse extends CoOwnerResponse {
+    numberOfCoOwnAssets: number;
+}
+
+interface PowensWebviewConnectionResponse {
+    id: string;
+    connectionUrl: string;
+    createdAt: Date;
+}
+
+interface UserResponse {
+    id: string;
+    clerkId: string;
+    firstname: string;
+    lastname: string | null;
+    email: string | null;
+    status: UserStatusEnum;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+interface AssetsResponse {
+    realEstateAssets: RealEstateResponse[];
+    mobilityAssets: MobilityResponse[];
+    cryptocurrencyAssets: CryptocurrencyResponse[];
+    stockExchangeAssets: StockExchangeResponse[];
+    otherAssets: OtherAssetResponse[];
+}
+
+type ExactMatch<T, U extends T> = T & Record<keyof T, keyof U>;
+
+declare class FilterArgs {
+    skip: number;
+    take: number;
+}
+
+export { type AccessTokensResponse, type AssetCoOwnerResponse, type AssetDateOfAcquisitionResponse, AssetTypeEnum, type AssetsResponse, type AuthenticationAccessResponse, AuthenticationMethodEnum, type BankAccountBalancesResponse, type BankAccountOriginalTransactionResponse, type BankAccountResponse, BankAccountSchemeNameEnum, type BankAccountTransactionCounterpartyResponse, type BankAccountTransactionExtraDataResponse, type BankAccountTransactionResponse, BankAccountTransactionTypeEnum, type BankAccountTransactionWordingResponse, type BankAccountTransactionsResponse, BankAccountTypeEnum, type BankAccountsResponse, type CoOwnerDeletedResponse, type CoOwnerResponse, type CreateAssetCoOwnerInput, type CreateAssetDateOfAcquisitionInput, type CreateMobilityInput, type CreateRealEstateInput, type CreateUserCoOwnerInput, type CryptocurrencyResponse, type DeleteUserCoOwnerInput, type ExactMatch, type FetchUserBankAccountsInput, type FetchUserCoOwnerInput, FilterArgs, type LogoutUserInput, type LogoutUserResponse, type MobilityDeletedResponse, type MobilityResponse, MobilityTypeEnum, type OtherAssetResponse, PowensUserStatusEnum, type PowensWebviewConnectionResponse, type RealEstateDeletedResponse, type RealEstateResponse, type StockExchangeResponse, type UserCoOwnerResponse, type UserResponse, UserStatusEnum };