@incomy/platform-sdk 0.4.0-18 → 0.4.0-189

package/dist/services/hub/models/OperationPaginatedList.d.ts

@@ -0,0 +1,16 @@
+import type { Operation } from './Operation';
+export type OperationPaginatedList = {
+    /**
+     * Token item to start the next query from; Empty start from the beginning
+     */
+    next: string;
+    /**
+     * Estimated total count over all pages. -1 means the total count could not be determined.
+     */
+    totalCount?: number;
+    /**
+     * Results for the current query
+     */
+    items: Array<Operation>;
+    meta?: Record<string, string | null> | null;
+};

package/dist/services/hub/models/Project.d.ts

@@ -0,0 +1,8 @@
+import type { Icon } from './Icon';
+import type { ProjectSettings } from './ProjectSettings';
+export type Project = {
+    id: string;
+    name: string;
+    icon?: Icon;
+    settings?: ProjectSettings;
+};

package/dist/services/hub/models/ProjectBatchGet.d.ts

@@ -0,0 +1,3 @@
+export type ProjectBatchGet = {
+    ids: Array<string>;
+};

package/dist/services/hub/models/ProjectBatchGetResult.d.ts

@@ -0,0 +1,8 @@
+import type { Project } from './Project';
+import type { StringStringValueTuple } from './StringStringValueTuple';
+export type ProjectBatchGetResult = {
+    items: Array<Project>;
+    errors: Array<StringStringValueTuple>;
+    notFoundIds: Array<string>;
+    forbiddenIds: Array<string>;
+};

package/dist/services/hub/models/ProjectBatchGetResult.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/ProjectEdit.d.ts

@@ -0,0 +1,7 @@
+import type { Icon } from './Icon';
+import type { ProjectSettings } from './ProjectSettings';
+export type ProjectEdit = {
+    name?: string | null;
+    icon?: Icon;
+    settings?: ProjectSettings;
+};

package/dist/services/hub/models/ProjectEdit.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/ProjectInsert.d.ts

@@ -0,0 +1,7 @@
+import type { Icon } from './Icon';
+import type { ProjectSettings } from './ProjectSettings';
+export type ProjectInsert = {
+    name: string;
+    icon?: Icon;
+    settings?: ProjectSettings;
+};

package/dist/services/hub/models/ProjectInsert.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/ProjectPaginatedList.d.ts

@@ -0,0 +1,16 @@
+import type { Project } from './Project';
+export type ProjectPaginatedList = {
+    /**
+     * Token item to start the next query from; Empty start from the beginning
+     */
+    next: string;
+    /**
+     * Estimated total count over all pages. -1 means the total count could not be determined.
+     */
+    totalCount?: number;
+    /**
+     * Results for the current query
+     */
+    items: Array<Project>;
+    meta?: Record<string, string | null> | null;
+};

package/dist/services/hub/models/ProjectPaginatedList.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/ProjectSettings.d.ts

@@ -0,0 +1,18 @@
+export type ProjectSettings = {
+    bucketingEnabled?: boolean;
+    /**
+     * Whether the Companies feature is available for this project. Enabled by default; when
+     * disabled the frontend hides the Companies UI. Defaults to `true` so an omitted field
+     * deserializes to enabled rather than off.
+     */
+    companiesEnabled?: boolean;
+    /**
+     * Currencies enabled for this project — a subset of the platform Incomy.Platform.Hub.Models.CurrencyCatalog.
+     * Operations, accruals and wallet defaults are restricted to this set.
+     */
+    enabledCurrencies?: Array<'PLN' | 'EUR' | 'USD' | 'GBP' | 'CHF'> | null;
+    /**
+     * Default currency for the project. When set, must be one of Incomy.Platform.Hub.Models.ProjectSettings.EnabledCurrencies.
+     */
+    defaultCurrency?: 'PLN' | 'EUR' | 'USD' | 'GBP' | 'CHF' | null;
+};

package/dist/services/hub/models/ProjectSettings.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/ProjectWallet.d.ts

@@ -0,0 +1,17 @@
+import type { Money } from './Money';
+export type ProjectWallet = {
+    id: string;
+    name: string;
+    ownerId?: string | null;
+    defaultCurrency?: 'PLN' | 'EUR' | 'USD' | 'GBP' | 'CHF' | null;
+    defaultCompanyId?: string | null;
+    balance?: Array<Money> | null;
+    /**
+     * Whether the wallet can be deleted. Null when not requested (see includeDeletability query param).
+     */
+    canDelete?: boolean | null;
+    /**
+     * Reason code why the wallet cannot be deleted. Null when it can be deleted or when not requested.
+     */
+    deleteBlockedReason?: 'hasAssociatedEvents' | null;
+};

package/dist/services/hub/models/ProjectWallet.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/ProjectWalletEdit.d.ts

@@ -0,0 +1,15 @@
+export type ProjectWalletEdit = {
+    name?: string | null;
+    /**
+     * Pass null in order to clear the default currency. Must be one of the project's enabled currencies.
+     */
+    defaultCurrency?: 'PLN' | 'EUR' | 'USD' | 'GBP' | 'CHF' | null;
+    /**
+     * Pass empty string in order to clear the owner.
+     */
+    ownerId?: string | null;
+    /**
+     * Pass empty string in order to clear the default company.
+     */
+    defaultCompanyId?: string | null;
+};

package/dist/services/hub/models/ProjectWalletEdit.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/ProjectWalletInsert.d.ts

@@ -0,0 +1,6 @@
+export type ProjectWalletInsert = {
+    name: string;
+    defaultCurrency?: 'PLN' | 'EUR' | 'USD' | 'GBP' | 'CHF' | null;
+    ownerId?: string | null;
+    defaultCompanyId?: string | null;
+};

package/dist/services/hub/models/ProjectWalletInsert.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/ProjectWalletPaginatedList.d.ts

@@ -0,0 +1,16 @@
+import type { ProjectWallet } from './ProjectWallet';
+export type ProjectWalletPaginatedList = {
+    /**
+     * Token item to start the next query from; Empty start from the beginning
+     */
+    next: string;
+    /**
+     * Estimated total count over all pages. -1 means the total count could not be determined.
+     */
+    totalCount?: number;
+    /**
+     * Results for the current query
+     */
+    items: Array<ProjectWallet>;
+    meta?: Record<string, string | null> | null;
+};

package/dist/services/hub/models/ProjectWalletPaginatedList.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/StringStringValueTuple.d.ts

@@ -0,0 +1 @@
+export type StringStringValueTuple = Record<string, any>;

package/dist/services/hub/models/StringStringValueTuple.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/Template.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/TemplateAccrualDefinition.d.ts

@@ -0,0 +1,10 @@
+import type { MoneyExpression } from './MoneyExpression';
+import type { TemplateBucketBreakdownDefinition } from './TemplateBucketBreakdownDefinition';
+export type TemplateAccrualDefinition = {
+    fromMemberIdExpression?: string | null;
+    toMemberIdExpression?: string | null;
+    nameExpression: string;
+    money: MoneyExpression;
+    bucketBreakdownDefinitions?: Array<TemplateBucketBreakdownDefinition> | null;
+    typeExpression: string;
+};

package/dist/services/hub/models/TemplateAccrualDefinition.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/TemplateBucketBreakdownDefinition.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/TemplateData.js

@@ -0,0 +1 @@
+export {};

package/dist/services/{core → hub}/models/TemplateDefinition.d.ts

@@ -1,10 +1,10 @@
-import type { TemplateEntryDefinition } from './TemplateEntryDefinition';
+import type { TemplateAccrualDefinition } from './TemplateAccrualDefinition';
 import type { TemplateInputDefinition } from './TemplateInputDefinition';
+import type { TemplateMultiEventDefinition } from './TemplateMultiEventDefinition';
 import type { TemplateOperationDefinition } from './TemplateOperationDefinition';
-import type { TemplateSettlementDefinition } from './TemplateSettlementDefinition';
 export type TemplateDefinition = {
     inputDefinition: TemplateInputDefinition;
-    settlementDefinitions: Array<TemplateSettlementDefinition>;
+    accrualDefinitions: Array<TemplateAccrualDefinition>;
     operationDefinitions: Array<TemplateOperationDefinition>;
-    entryDefinition: TemplateEntryDefinition;
+    multiEventDefinition: TemplateMultiEventDefinition;
 };

package/dist/services/hub/models/TemplateDefinition.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/TemplateEdit.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/TemplateInfo.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/TemplateInput.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/TemplateInputDefinition.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/TemplateInsert.js

@@ -0,0 +1 @@
+export {};

package/dist/services/{core/models/TemplateEntryDefinition.d.ts → hub/models/TemplateMultiEventDefinition.d.ts}

@@ -1,4 +1,4 @@
-export type TemplateEntryDefinition = {
+export type TemplateMultiEventDefinition = {
     nameExpression: string;
     occurredAtExpression?: string | null;
 };

package/dist/services/hub/models/TemplateMultiEventDefinition.js

@@ -0,0 +1 @@
+export {};

package/dist/services/{core → hub}/models/TemplateOperationDefinition.d.ts

@@ -7,5 +7,5 @@ export type TemplateOperationDefinition = {
     targetWalletIdExpression?: string | null;
     typeExpression: string;
     money: MoneyExpression;
-    bucketBreakdownDefinitions: Array<TemplateBucketBreakdownDefinition>;
+    bucketBreakdownDefinitions?: Array<TemplateBucketBreakdownDefinition> | null;
 };

package/dist/services/hub/models/TemplateOperationDefinition.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/TemplatePaginatedList.d.ts

@@ -0,0 +1,16 @@
+import type { Template } from './Template';
+export type TemplatePaginatedList = {
+    /**
+     * Token item to start the next query from; Empty start from the beginning
+     */
+    next: string;
+    /**
+     * Estimated total count over all pages. -1 means the total count could not be determined.
+     */
+    totalCount?: number;
+    /**
+     * Results for the current query
+     */
+    items: Array<Template>;
+    meta?: Record<string, string | null> | null;
+};

package/dist/services/hub/models/TemplatePaginatedList.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/UpdateProfileRequest.d.ts

@@ -0,0 +1,8 @@
+export type UpdateProfileRequest = {
+    firstName?: string | null;
+    lastName?: string | null;
+    /**
+     * Preferred UI language as a lowercase ISO 639-1 code. Only the supported locales are accepted.
+     */
+    language?: string | null;
+};

package/dist/services/hub/models/UpdateProfileRequest.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/User.d.ts

@@ -0,0 +1,15 @@
+import type { UserIdentity } from './UserIdentity';
+export type User = {
+    id?: string;
+    email: string | null;
+    firstName?: string | null;
+    lastName?: string | null;
+    avatar?: string | null;
+    /**
+     * Preferred UI language as a lowercase ISO 639-1 code (e.g. "en", "pl").
+     * Null means the user has not chosen one; the client falls back to the browser language.
+     */
+    language?: string | null;
+    identities?: Array<UserIdentity> | null;
+    readonly name?: string | null;
+};

package/dist/services/hub/models/User.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/UserIdentity.d.ts

@@ -0,0 +1,10 @@
+export type UserIdentity = {
+    auth0Id: string | null;
+    isCurrent?: boolean;
+    readonly provider?: string | null;
+    readonly providerDisplayName?: string | null;
+    email?: string | null;
+    firstName?: string | null;
+    lastName?: string | null;
+    avatar?: string | null;
+};

package/dist/services/hub/models/UserIdentity.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/WalletBalance.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/WalletBalancePaginatedList.d.ts

@@ -0,0 +1,16 @@
+import type { WalletBalance } from './WalletBalance';
+export type WalletBalancePaginatedList = {
+    /**
+     * Token item to start the next query from; Empty start from the beginning
+     */
+    next: string;
+    /**
+     * Estimated total count over all pages. -1 means the total count could not be determined.
+     */
+    totalCount?: number;
+    /**
+     * Results for the current query
+     */
+    items: Array<WalletBalance>;
+    meta?: Record<string, string | null> | null;
+};

package/dist/services/hub/models/WalletBalancePaginatedList.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/services/AccrualsService.d.ts

@@ -0,0 +1,49 @@
+import type { Accrual } from '../models/Accrual';
+import type { AccrualEdit } from '../models/AccrualEdit';
+import type { AccrualInsert } from '../models/AccrualInsert';
+import type { AccrualPaginatedList } from '../models/AccrualPaginatedList';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class AccrualsService {
+    /**
+     * @param projectId
+     * @param memberId
+     * @param query
+     * @param standaloneOnly
+     * @param orderByName
+     * @param orderByTime
+     * @param limit
+     * @param next
+     * @returns AccrualPaginatedList OK
+     * @throws ApiError
+     */
+    static getProjectsAccruals(projectId: string, memberId?: string, query?: string, standaloneOnly?: boolean, orderByName?: 'Desc' | 'Asc', orderByTime?: 'Desc' | 'Asc', limit?: number, next?: string): CancelablePromise<AccrualPaginatedList>;
+    /**
+     * @param projectId
+     * @param requestBody
+     * @returns Accrual OK
+     * @throws ApiError
+     */
+    static postProjectsAccruals(projectId: string, requestBody?: AccrualInsert): CancelablePromise<Accrual>;
+    /**
+     * @param projectId
+     * @param accrualId
+     * @returns Accrual OK
+     * @throws ApiError
+     */
+    static getProjectsAccruals1(projectId: string, accrualId: string): CancelablePromise<Accrual>;
+    /**
+     * @param projectId
+     * @param accrualId
+     * @param requestBody
+     * @returns Accrual OK
+     * @throws ApiError
+     */
+    static patchProjectsAccruals(projectId: string, accrualId: string, requestBody?: AccrualEdit): CancelablePromise<Accrual>;
+    /**
+     * @param projectId
+     * @param accrualId
+     * @returns any OK
+     * @throws ApiError
+     */
+    static deleteProjectsAccruals(projectId: string, accrualId: string): CancelablePromise<any>;
+}

package/dist/services/hub/services/AccrualsService.js

@@ -0,0 +1,102 @@
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class AccrualsService {
+    /**
+     * @param projectId
+     * @param memberId
+     * @param query
+     * @param standaloneOnly
+     * @param orderByName
+     * @param orderByTime
+     * @param limit
+     * @param next
+     * @returns AccrualPaginatedList OK
+     * @throws ApiError
+     */
+    static getProjectsAccruals(projectId, memberId, query, standaloneOnly = false, orderByName, orderByTime, limit = 100, next) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/projects/{projectId}/accruals',
+            path: {
+                'projectId': projectId,
+            },
+            query: {
+                'memberId': memberId,
+                'query': query,
+                'standaloneOnly': standaloneOnly,
+                'orderByName': orderByName,
+                'orderByTime': orderByTime,
+                'limit': limit,
+                'next': next,
+            },
+        });
+    }
+    /**
+     * @param projectId
+     * @param requestBody
+     * @returns Accrual OK
+     * @throws ApiError
+     */
+    static postProjectsAccruals(projectId, requestBody) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/projects/{projectId}/accruals',
+            path: {
+                'projectId': projectId,
+            },
+            body: requestBody,
+            mediaType: 'application/json;odata.metadata=minimal;odata.streaming=true',
+        });
+    }
+    /**
+     * @param projectId
+     * @param accrualId
+     * @returns Accrual OK
+     * @throws ApiError
+     */
+    static getProjectsAccruals1(projectId, accrualId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/projects/{projectId}/accruals/{accrualId}',
+            path: {
+                'projectId': projectId,
+                'accrualId': accrualId,
+            },
+        });
+    }
+    /**
+     * @param projectId
+     * @param accrualId
+     * @param requestBody
+     * @returns Accrual OK
+     * @throws ApiError
+     */
+    static patchProjectsAccruals(projectId, accrualId, requestBody) {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/projects/{projectId}/accruals/{accrualId}',
+            path: {
+                'projectId': projectId,
+                'accrualId': accrualId,
+            },
+            body: requestBody,
+            mediaType: 'application/json;odata.metadata=minimal;odata.streaming=true',
+        });
+    }
+    /**
+     * @param projectId
+     * @param accrualId
+     * @returns any OK
+     * @throws ApiError
+     */
+    static deleteProjectsAccruals(projectId, accrualId) {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/projects/{projectId}/accruals/{accrualId}',
+            path: {
+                'projectId': projectId,
+                'accrualId': accrualId,
+            },
+        });
+    }
+}

package/dist/services/hub/services/AuthService.d.ts

@@ -0,0 +1,39 @@
+import type { UpdateProfileRequest } from '../models/UpdateProfileRequest';
+import type { User } from '../models/User';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class AuthService {
+    /**
+     * @param auth0IdToUnlink
+     * @returns any OK
+     * @throws ApiError
+     */
+    static postAuthIdentitiesUnlink(auth0IdToUnlink: string): CancelablePromise<any>;
+    /**
+     * @param returnUrl
+     * @returns any OK
+     * @throws ApiError
+     */
+    static getAuthLogin(returnUrl?: string): CancelablePromise<any>;
+    /**
+     * @param returnUrl
+     * @returns any OK
+     * @throws ApiError
+     */
+    static getAuthLogout(returnUrl?: string): CancelablePromise<any>;
+    /**
+     * @returns User OK
+     * @throws ApiError
+     */
+    static getAuthMe(): CancelablePromise<User>;
+    /**
+     * @param requestBody
+     * @returns User OK
+     * @throws ApiError
+     */
+    static postAuthMe(requestBody?: UpdateProfileRequest): CancelablePromise<User>;
+    /**
+     * @returns any OK
+     * @throws ApiError
+     */
+    static deleteAuthMe(): CancelablePromise<any>;
+}

package/dist/services/hub/services/AuthService.js

@@ -0,0 +1,79 @@
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class AuthService {
+    /**
+     * @param auth0IdToUnlink
+     * @returns any OK
+     * @throws ApiError
+     */
+    static postAuthIdentitiesUnlink(auth0IdToUnlink) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/auth/identities/{auth0IdToUnlink}/unlink',
+            path: {
+                'auth0IdToUnlink': auth0IdToUnlink,
+            },
+        });
+    }
+    /**
+     * @param returnUrl
+     * @returns any OK
+     * @throws ApiError
+     */
+    static getAuthLogin(returnUrl = '/') {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/auth/login',
+            query: {
+                'returnUrl': returnUrl,
+            },
+        });
+    }
+    /**
+     * @param returnUrl
+     * @returns any OK
+     * @throws ApiError
+     */
+    static getAuthLogout(returnUrl = '/') {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/auth/logout',
+            query: {
+                'returnUrl': returnUrl,
+            },
+        });
+    }
+    /**
+     * @returns User OK
+     * @throws ApiError
+     */
+    static getAuthMe() {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/auth/me',
+        });
+    }
+    /**
+     * @param requestBody
+     * @returns User OK
+     * @throws ApiError
+     */
+    static postAuthMe(requestBody) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/auth/me',
+            body: requestBody,
+            mediaType: 'application/json;odata.metadata=minimal;odata.streaming=true',
+        });
+    }
+    /**
+     * @returns any OK
+     * @throws ApiError
+     */
+    static deleteAuthMe() {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/auth/me',
+        });
+    }
+}