@incomy/platform-sdk 0.4.0-97 → 0.4.0-beta.2001

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

@@ -1,6 +1,14 @@
 import type { Money } from './Money';
 export type Member = {
+    balance?: Array<Money> | null;
+    /**
+     * Whether the member can be deleted. Null when not requested (see includeDeletability query param).
+     */
+    canDelete?: boolean | null;
+    /**
+     * Reason code why the member cannot be deleted. Null when it can be deleted or when not requested.
+     */
+    deleteBlockedReason?: 'hasAccruals' | null;
     id: string;
     name: string;
-    balance?: Array<Money> | null;
 };

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

@@ -1,5 +1,5 @@
 import type { Money } from './Money';
 export type MemberBalance = {
-    total: Array<Money>;
     memberId: string;
+    total: Array<Money>;
 };

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

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

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

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

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

@@ -1,4 +1,4 @@
 export type Money = {
     amount: number;
-    currencyCode: 'PLN' | 'EUR' | 'USD';
+    currencyCode: 'PLN' | 'EUR' | 'USD' | 'GBP' | 'CHF';
 };

package/dist/services/hub/models/{Entry.d.ts → MultiEvent.d.ts}

@@ -1,13 +1,13 @@
+import type { Accrual } from './Accrual';
 import type { BalanceReport } from './BalanceReport';
 import type { Operation } from './Operation';
-import type { Settlement } from './Settlement';
 import type { TemplateInfo } from './TemplateInfo';
-export type Entry = {
+export type MultiEvent = {
+    accruals: Array<Accrual>;
+    balance?: BalanceReport;
     id: string;
     name: string;
     occurredAt: string;
     operations: Array<Operation>;
-    settlements: Array<Settlement>;
     template?: TemplateInfo;
-    balance?: BalanceReport;
 };

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

@@ -0,0 +1,6 @@
+import type { AccrualEdit } from './AccrualEdit';
+import type { AccrualInsert } from './AccrualInsert';
+export type MultiEventAccruals = {
+    create?: Array<AccrualInsert> | null;
+    update?: Record<string, AccrualEdit> | null;
+};

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

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

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

@@ -0,0 +1,10 @@
+import type { MultiEventAccruals } from './MultiEventAccruals';
+import type { MultiEventOperations } from './MultiEventOperations';
+import type { TemplateInfo } from './TemplateInfo';
+export type MultiEventEdit = {
+    accruals?: MultiEventAccruals;
+    name?: string | null;
+    occurredAt?: string | null;
+    operations?: MultiEventOperations;
+    template?: TemplateInfo;
+};

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

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

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

@@ -0,0 +1,13 @@
+import type { MultiEventAccruals } from './MultiEventAccruals';
+import type { MultiEventOperations } from './MultiEventOperations';
+import type { TemplateInfo } from './TemplateInfo';
+export type MultiEventInsert = {
+    accruals?: MultiEventAccruals;
+    name?: string | null;
+    /**
+     * Server time will be used if left empty
+     */
+    occurredAt?: string | null;
+    operations?: MultiEventOperations;
+    template?: TemplateInfo;
+};

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

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

package/dist/services/hub/models/{EntryOperations.d.ts → MultiEventOperations.d.ts}

@@ -1,6 +1,6 @@
 import type { OperationEdit } from './OperationEdit';
 import type { OperationInsert } from './OperationInsert';
-export type EntryOperations = {
+export type MultiEventOperations = {
     create?: Array<OperationInsert> | null;
     update?: Record<string, OperationEdit> | null;
 };

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

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

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

@@ -0,0 +1,16 @@
+import type { MultiEvent } from './MultiEvent';
+export type MultiEventPaginatedList = {
+    /**
+     * Results for the current query
+     */
+    items: Array<MultiEvent>;
+    meta?: Record<string, string | null> | null;
+    /**
+     * 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;
+};

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

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

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

@@ -1,18 +1,18 @@
 import type { BucketBreakdown } from './BucketBreakdown';
 import type { Money } from './Money';
 export type Operation = {
+    bucketBreakdown?: Array<BucketBreakdown> | null;
+    /**
+     * If set, operation will be deleted when unlined from a multievent or when linked multievent is deleted.
+     */
+    deleteWithMultiEventRemoval?: boolean;
     id: string;
+    labelIds: Array<string>;
+    money: Money;
+    multiEventId?: string | null;
     name: string;
-    time: string;
     originWalletId?: string | null;
     targetWalletId?: string | null;
+    time: string;
     type: 'in' | 'out' | 'transfer';
-    money: Money;
-    bucketBreakdown?: Array<BucketBreakdown> | null;
-    entryId?: string | null;
-    /**
-     * If set, operation will be deleted when unlined from an entry or when linked entry is deleted.
-     */
-    deleteWithEntryRemoval?: boolean;
-    labelIds: Array<string>;
 };

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

@@ -1,8 +1,18 @@
 import type { BucketBreakdown } from './BucketBreakdown';
 import type { Money } from './Money';
 export type OperationEdit = {
+    bucketBreakdown?: Array<BucketBreakdown> | null;
+    /**
+     * If set, operation will be deleted when unlined from a multievent or when linked multievent is deleted.
+     */
+    deleteWithMultiEventRemoval?: boolean | null;
+    labelIds?: Array<string> | null;
+    money?: Money;
+    /**
+     * Use empty string in order to unlink operation from multievent
+     */
+    multiEventId?: string | null;
     name?: string | null;
-    time?: string | null;
     /**
      * Set to "" in order to clear.
      */
@@ -11,16 +21,6 @@ export type OperationEdit = {
      * Set to "" in order to clear.
      */
     targetWalletId?: string | null;
+    time?: string | null;
     type?: 'in' | 'out' | 'transfer' | null;
-    money?: Money;
-    bucketBreakdown?: Array<BucketBreakdown> | null;
-    /**
-     * Use empty string in order to unlink operation from entry
-     */
-    entryId?: string | null;
-    /**
-     * If set, operation will be deleted when unlined from an entry or when linked entry is deleted.
-     */
-    deleteWithEntryRemoval?: boolean | null;
-    labelIds?: Array<string> | null;
 };

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

@@ -1,20 +1,20 @@
 import type { BucketBreakdown } from './BucketBreakdown';
 import type { Money } from './Money';
 export type OperationInsert = {
-    name: string;
+    bucketBreakdown?: Array<BucketBreakdown> | null;
     /**
-     * Entry time will be used if left empty
+     * If set, operation will be deleted when unlined from a multievent or when linked multievent is deleted.
      */
-    time?: string | null;
+    deleteWithMultiEventRemoval?: boolean;
+    labelIds?: Array<string> | null;
+    money: Money;
+    multiEventId?: string | null;
+    name: string;
     originWalletId?: string | null;
     targetWalletId?: string | null;
-    type: 'in' | 'out' | 'transfer';
-    money: Money;
-    bucketBreakdown: Array<BucketBreakdown>;
-    entryId?: string | null;
     /**
-     * If set, operation will be deleted when unlined from an entry or when linked entry is deleted.
+     * MultiEvent time will be used if left empty
      */
-    deleteWithEntryRemoval?: boolean;
-    labelIds?: Array<string> | null;
+    time?: string | null;
+    type: 'in' | 'out' | 'transfer';
 };

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

@@ -1,5 +1,10 @@
 import type { Operation } from './Operation';
 export type OperationPaginatedList = {
+    /**
+     * Results for the current query
+     */
+    items: Array<Operation>;
+    meta?: Record<string, string | null> | null;
     /**
      * Token item to start the next query from; Empty start from the beginning
      */
@@ -8,9 +13,4 @@ export type OperationPaginatedList = {
      * 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

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

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

@@ -1,8 +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>;
+    items: Array<Project>;
+    notFoundIds: Array<string>;
 };

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

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

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

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

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

@@ -1,5 +1,10 @@
 import type { Project } from './Project';
 export type ProjectPaginatedList = {
+    /**
+     * Results for the current query
+     */
+    items: Array<Project>;
+    meta?: Record<string, string | null> | null;
     /**
      * Token item to start the next query from; Empty start from the beginning
      */
@@ -8,9 +13,4 @@ export type ProjectPaginatedList = {
      * 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/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;
+    /**
+     * Default currency for the project. When set, must be one of Incomy.Platform.Hub.Models.ProjectSettings.EnabledCurrencies.
+     */
+    defaultCurrency?: 'PLN' | 'EUR' | 'USD' | 'GBP' | 'CHF' | null;
+    /**
+     * 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;
+};

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

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

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

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

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

@@ -1,4 +1,12 @@
 export type ProjectWalletEdit = {
+    /**
+     * Pass empty string in order to clear the default company.
+     */
+    defaultCompanyId?: 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;
     name?: string | null;
     /**
      * Pass empty string in order to clear the owner.

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

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

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

@@ -0,0 +1,16 @@
+import type { ProjectWallet } from './ProjectWallet';
+export type ProjectWalletPaginatedList = {
+    /**
+     * Results for the current query
+     */
+    items: Array<ProjectWallet>;
+    meta?: Record<string, string | null> | null;
+    /**
+     * 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;
+};

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

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

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

@@ -1,7 +1,7 @@
 import type { TemplateDefinition } from './TemplateDefinition';
 export type Template = {
+    definition: TemplateDefinition;
+    description: string;
     id: string;
     name: string;
-    description: string;
-    definition: TemplateDefinition;
 };

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 = {
+    bucketBreakdownDefinitions?: Array<TemplateBucketBreakdownDefinition> | null;
+    fromMemberIdExpression?: string | null;
+    money: MoneyExpression;
+    nameExpression: string;
+    toMemberIdExpression?: string | null;
+    typeExpression: string;
+};

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

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

package/dist/services/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 = {
+    accrualDefinitions: Array<TemplateAccrualDefinition>;
     inputDefinition: TemplateInputDefinition;
-    settlementDefinitions: Array<TemplateSettlementDefinition>;
+    multiEventDefinition: TemplateMultiEventDefinition;
     operationDefinitions: Array<TemplateOperationDefinition>;
-    entryDefinition: TemplateEntryDefinition;
 };

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

@@ -1,6 +1,6 @@
 import type { TemplateDefinition } from './TemplateDefinition';
 export type TemplateEdit = {
-    name?: string | null;
-    description?: string | null;
     definition?: TemplateDefinition;
+    description?: string | null;
+    name?: string | null;
 };

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

@@ -1,5 +1,5 @@
 import type { TemplateData } from './TemplateData';
 export type TemplateInfo = {
-    templateId: string;
     data: TemplateData;
+    templateId: string;
 };

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

@@ -1,6 +1,6 @@
 import type { TemplateDefinition } from './TemplateDefinition';
 export type TemplateInsert = {
-    name: string;
-    description?: string | null;
     definition: TemplateDefinition;
+    description?: string | null;
+    name: string;
 };

package/dist/services/hub/models/{TemplateEntryDefinition.d.ts → 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/hub/models/TemplateOperationDefinition.d.ts

@@ -1,11 +1,11 @@
 import type { MoneyExpression } from './MoneyExpression';
 import type { TemplateBucketBreakdownDefinition } from './TemplateBucketBreakdownDefinition';
 export type TemplateOperationDefinition = {
+    bucketBreakdownDefinitions?: Array<TemplateBucketBreakdownDefinition> | null;
+    money: MoneyExpression;
     nameExpression: string;
-    timeExpression?: string | null;
     originWalletIdExpression?: string | null;
     targetWalletIdExpression?: string | null;
+    timeExpression?: string | null;
     typeExpression: string;
-    money: MoneyExpression;
-    bucketBreakdownDefinitions: Array<TemplateBucketBreakdownDefinition>;
 };

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

@@ -0,0 +1,16 @@
+import type { Template } from './Template';
+export type TemplatePaginatedList = {
+    /**
+     * Results for the current query
+     */
+    items: Array<Template>;
+    meta?: Record<string, string | null> | null;
+    /**
+     * 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;
+};

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

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

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

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

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

@@ -1,10 +1,15 @@
 import type { UserIdentity } from './UserIdentity';
 export type User = {
-    id?: string;
+    avatar?: string | null;
     email: string | null;
     firstName?: string | null;
-    lastName?: string | null;
-    avatar?: string | null;
+    id?: string;
     identities?: Array<UserIdentity> | 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;
+    lastName?: string | null;
     readonly name?: string | null;
 };

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

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

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

@@ -1,5 +1,10 @@
 import type { WalletBalance } from './WalletBalance';
 export type WalletBalancePaginatedList = {
+    /**
+     * Results for the current query
+     */
+    items: Array<WalletBalance>;
+    meta?: Record<string, string | null> | null;
     /**
      * Token item to start the next query from; Empty start from the beginning
      */
@@ -8,9 +13,4 @@ export type WalletBalancePaginatedList = {
      * 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;
 };