@tammsyr/admin-api-client 1.3.5 → 1.3.7

package/dist/data-contracts.d.ts

@@ -709,6 +709,36 @@ export interface AdminAccountResponseDto {
      * @example "0017601010000001000011"
      */
     accountNumber?: string;
+    /**
+     * Bank branch code (BBB segment of the account number).
+     * @example "001"
+     */
+    branchCode?: string;
+    /**
+     * Canonical type_code (TTT catalogue) — the source of the owner/product classification.
+     * @example "101"
+     */
+    typeCode?: string;
+    /**
+     * 8-digit customer anchor (CIF). "00000001" for internal accounts.
+     * @example "00000123"
+     */
+    cif?: string;
+    /**
+     * Serial segment (SSSS) within the natural key.
+     * @example 1
+     */
+    serial?: number;
+    /**
+     * Product template code snapshotted at creation.
+     * @example "PERS-CURRENT"
+     */
+    productCode?: string;
+    /**
+     * Product template version snapshotted at creation.
+     * @example 1
+     */
+    productVersion?: number;
     /**
      * Owning entity UUID: person (personal/business), merchant (merchant), or agent (agent). Absent for treasury.
      * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
@@ -744,21 +774,40 @@ export interface AdminAccountResponseDto {
      * @example "active"
      */
     status: "pending" | "active" | "restricted" | "suspended" | "frozen" | "dormant" | "closed";
+    /**
+     * Whether this is the primary (default-receivable) account for its currency.
+     * @example true
+     */
+    isPrimary?: boolean;
+    /**
+     * Optimistic-lock version.
+     * @example 1
+     */
+    version?: number;
     /**
      * Account display name
      * @example "Primary Wallet"
      */
     name?: string;
-    /**
-     * Parent account ID for pots
-     * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
-     */
-    parentAccountId?: string;
+    /** When the account was opened (ISO 8601). */
+    openedAt?: string;
+    /** When the account was activated (ISO 8601). */
+    activatedAt?: string;
+    /** Timestamp of the last account activity (ISO 8601). */
+    lastActivityAt?: string;
+    /** When the balance was last updated (ISO 8601). */
+    balanceUpdatedAt?: string;
+    /** When the account was closed (ISO 8601). */
+    closedAt?: string;
+    /** Reason code recorded at closure. */
+    closureReason?: string;
     /**
      * Account creation timestamp (ISO 8601)
      * @example "2024-01-15T12:00:00Z"
      */
     createdAt: string;
+    /** Last update timestamp (ISO 8601). */
+    updatedAt?: string;
     /** QR payload for receiving (main accounts only) */
     qrPayload?: string;
 }
@@ -1083,10 +1132,10 @@ export interface PersonAddressDto {
      */
     province: object;
     /**
-     * City name (translatable)
-     * @example {"ar":"دمشق","en":"Damascus"}
+     * City / town (free text entered by the user)
+     * @example "Mazzeh"
      */
-    city?: object;
+    city: string;
     /** @example "123 Main Street" */
     detailedAddress: string;
 }
@@ -1172,6 +1221,26 @@ export interface MerchantResponseDto {
      * @example "50k-250k USD"
      */
     monthlyVolumeBand: string;
+    /**
+     * Business address — country ID (UUID)
+     * @example "c0000000-0000-4000-a000-000000000001"
+     */
+    countryId: string;
+    /**
+     * Business address — province ID (UUID)
+     * @example "b0000000-0000-4000-a000-000000000001"
+     */
+    provinceId: string;
+    /**
+     * Business address — city / town
+     * @example "Mazzeh"
+     */
+    city: string;
+    /**
+     * Business address — detailed address
+     * @example "Building 123, Street Name, District"
+     */
+    detailedAddress: string;
     /**
      * Merchant status
      * @example "pending_kyc"
@@ -1979,6 +2048,36 @@ export interface AdminAccountDetailResponseDto {
      * @example "0017601010000001000011"
      */
     accountNumber?: string;
+    /**
+     * Bank branch code (BBB segment of the account number).
+     * @example "001"
+     */
+    branchCode?: string;
+    /**
+     * Canonical type_code (TTT catalogue) — the source of the owner/product classification.
+     * @example "101"
+     */
+    typeCode?: string;
+    /**
+     * 8-digit customer anchor (CIF). "00000001" for internal accounts.
+     * @example "00000123"
+     */
+    cif?: string;
+    /**
+     * Serial segment (SSSS) within the natural key.
+     * @example 1
+     */
+    serial?: number;
+    /**
+     * Product template code snapshotted at creation.
+     * @example "PERS-CURRENT"
+     */
+    productCode?: string;
+    /**
+     * Product template version snapshotted at creation.
+     * @example 1
+     */
+    productVersion?: number;
     /**
      * Owning entity UUID: person (personal/business), merchant (merchant), or agent (agent). Absent for treasury.
      * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
@@ -2014,21 +2113,40 @@ export interface AdminAccountDetailResponseDto {
      * @example "active"
      */
     status: "pending" | "active" | "restricted" | "suspended" | "frozen" | "dormant" | "closed";
+    /**
+     * Whether this is the primary (default-receivable) account for its currency.
+     * @example true
+     */
+    isPrimary?: boolean;
+    /**
+     * Optimistic-lock version.
+     * @example 1
+     */
+    version?: number;
     /**
      * Account display name
      * @example "Primary Wallet"
      */
     name?: string;
-    /**
-     * Parent account ID for pots
-     * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
-     */
-    parentAccountId?: string;
+    /** When the account was opened (ISO 8601). */
+    openedAt?: string;
+    /** When the account was activated (ISO 8601). */
+    activatedAt?: string;
+    /** Timestamp of the last account activity (ISO 8601). */
+    lastActivityAt?: string;
+    /** When the balance was last updated (ISO 8601). */
+    balanceUpdatedAt?: string;
+    /** When the account was closed (ISO 8601). */
+    closedAt?: string;
+    /** Reason code recorded at closure. */
+    closureReason?: string;
     /**
      * Account creation timestamp (ISO 8601)
      * @example "2024-01-15T12:00:00Z"
      */
     createdAt: string;
+    /** Last update timestamp (ISO 8601). */
+    updatedAt?: string;
     /** QR payload for receiving (main accounts only) */
     qrPayload?: string;
     /** Person KYC/owner profile when the account type is personal or business. Null for merchant, agent, or treasury. */
@@ -2114,11 +2232,6 @@ export interface PolicyRuleResponseDto {
      * @example "Agent wallet opening requires approval"
      */
     name: string;
-    /**
-     * SELECTOR — customer party type. `""` = wildcard (any party type). Example values: INDIVIDUAL, BUSINESS.
-     * @example ""
-     */
-    partyType: string;
     /**
      * SELECTOR — wallet owner type. `""` = wildcard. One of: PERSONAL, MERCHANT, AGENT, INTERNAL. Here the rule only matches AGENT-owned wallets.
      * @example "AGENT"
@@ -2149,11 +2262,6 @@ export interface PolicyRuleResponseDto {
      * @example ""
      */
     customerCif: string;
-    /**
-     * SELECTOR — request channel, e.g. MOBILE / WEB. `""` = wildcard.
-     * @example ""
-     */
-    channel: string;
     /**
      * EFFECT applied when the rule matches. ALLOW = permit; DENY = block; LIMIT = enforce a quota/bound from `params`; REQUIRE_APPROVAL = send for manual approval.
      * @example "REQUIRE_APPROVAL"
@@ -2218,12 +2326,6 @@ export interface CreatePolicyRuleDto {
      * @example "Block opening for sanctioned branches"
      */
     name: string;
-    /**
-     * Party type selector (wildcard if omitted)
-     * @maxLength 12
-     * @example "INDIVIDUAL"
-     */
-    partyType?: string;
     /**
      * Owner type selector (wildcard if omitted)
      * @example "MERCHANT"
@@ -2255,12 +2357,6 @@ export interface CreatePolicyRuleDto {
      * @example "10000001"
      */
     customerCif?: string;
-    /**
-     * Channel selector (wildcard if omitted)
-     * @maxLength 16
-     * @example "MOBILE"
-     */
-    channel?: string;
     /**
      * Effect applied when the rule matches
      * @example "DENY"
@@ -2296,12 +2392,6 @@ export interface UpdatePolicyRuleDto {
      * @example "Block opening for sanctioned branches"
      */
     name?: string;
-    /**
-     * Party type selector (wildcard if omitted)
-     * @maxLength 12
-     * @example "INDIVIDUAL"
-     */
-    partyType?: string;
     /**
      * Owner type selector (wildcard if omitted)
      * @example "MERCHANT"
@@ -2333,12 +2423,6 @@ export interface UpdatePolicyRuleDto {
      * @example "10000001"
      */
     customerCif?: string;
-    /**
-     * Channel selector (wildcard if omitted)
-     * @maxLength 16
-     * @example "MOBILE"
-     */
-    channel?: string;
     /**
      * Effect applied when the rule matches
      * @example "DENY"
@@ -2414,11 +2498,6 @@ export interface AccountProductResponseDto {
      * @example {"qr_static":true,"qr_dynamic":true,"cash_in":true}
      */
     featureFlags: object;
-    /**
-     * Authoring view of default limits
-     * @example {}
-     */
-    limitDefaults: object;
     /**
      * Inactivity days before DORMANT (null = no dormancy)
      * @example 365
@@ -2468,11 +2547,6 @@ export interface CreateAccountProductDto {
      * @example {"qr_static":true,"qr_dynamic":true,"cash_in":true}
      */
     featureFlags?: object;
-    /**
-     * Authoring view of default limits (the runtime source of truth is the rules engine).
-     * @example {"DAILY_TRANSFER":"5000000"}
-     */
-    limitDefaults?: object;
     /**
      * Inactivity days before a wallet goes DORMANT. Omit for no dormancy.
      * @min 1
@@ -2503,11 +2577,6 @@ export interface UpdateAccountProductDto {
      * @example {"qr_static":true,"qr_dynamic":true,"cash_in":true}
      */
     featureFlags?: object;
-    /**
-     * Authoring view of default limits.
-     * @example {"DAILY_TRANSFER":"5000000"}
-     */
-    limitDefaults?: object;
     /**
      * Inactivity days before DORMANT. Omit for no dormancy.
      * @min 1
@@ -3544,6 +3613,71 @@ export interface UpdateCurrencyConfigDto {
     /** Toggle whether the generator may issue new account numbers in this currency */
     isActive?: boolean;
 }
+export interface CountryResponseDto {
+    /** @example "c0000000-0000-4000-a000-000000000001" */
+    id: string;
+    /** @example "SY" */
+    code: string;
+    name: LocalizedNameDto;
+    /** @example true */
+    isActive: boolean;
+}
+export interface CountryListResponseDto {
+    countries: CountryResponseDto[];
+}
+export interface CreateCountryDto {
+    /**
+     * ISO 3166-1 alpha-2 code
+     * @example "SY"
+     */
+    code: string;
+    name: LocalizedNameDto;
+    /**
+     * Whether the country is active (default true)
+     * @example true
+     */
+    isActive?: boolean;
+}
+export interface UpdateCountryDto {
+    /**
+     * ISO 3166-1 alpha-2 code
+     * @example "SY"
+     */
+    code?: string;
+    name?: LocalizedNameDto;
+    /** Toggle whether the country appears in the public list */
+    isActive?: boolean;
+}
+export interface ProvinceResponseDto {
+    /** @example "b0000000-0000-4000-a000-000000000001" */
+    id: string;
+    /** @example "c0000000-0000-4000-a000-000000000001" */
+    countryId: string;
+    name: LocalizedNameDto;
+    /** @example true */
+    isActive: boolean;
+}
+export interface ProvinceListResponseDto {
+    provinces: ProvinceResponseDto[];
+}
+export interface CreateProvinceDto {
+    /**
+     * Parent country ID (UUID)
+     * @example "c0000000-0000-4000-a000-000000000001"
+     */
+    countryId: string;
+    name: LocalizedNameDto;
+    /**
+     * Whether the province is active (default true)
+     * @example true
+     */
+    isActive?: boolean;
+}
+export interface UpdateProvinceDto {
+    name?: LocalizedNameDto;
+    /** Toggle whether the province is active */
+    isActive?: boolean;
+}
 export interface ApprovalDecisionResponseDto {
     id: string;
     adminId: string;
@@ -3555,7 +3689,7 @@ export interface ApprovalDecisionResponseDto {
 }
 export interface ApprovalRequestResponseDto {
     id: string;
-    actionType: "admin.create" | "admin.update" | "admin.delete" | "admin.status_update" | "system_config.upsert" | "system_config.delete" | "account.fund" | "role.assign_permissions" | "reconciliation.run";
+    actionType: "admin.create" | "admin.update" | "admin.delete" | "admin.status_update" | "system_config.upsert" | "system_config.delete" | "account.fund" | "role.assign_permissions" | "reconciliation.run" | "kyc.approve" | "kyc.reject";
     resource: string;
     resourceId?: object;
     title: string;
@@ -3595,7 +3729,7 @@ export interface CreateApprovalDecisionDto {
     comment?: string;
 }
 export interface ApprovalPolicyResponseDto {
-    actionType: "admin.create" | "admin.update" | "admin.delete" | "admin.status_update" | "system_config.upsert" | "system_config.delete" | "account.fund" | "role.assign_permissions" | "reconciliation.run";
+    actionType: "admin.create" | "admin.update" | "admin.delete" | "admin.status_update" | "system_config.upsert" | "system_config.delete" | "account.fund" | "role.assign_permissions" | "reconciliation.run" | "kyc.approve" | "kyc.reject";
     enabled: boolean;
     requiredApprovals: number;
     allowSelfApprove: boolean;
@@ -3918,10 +4052,6 @@ export interface GetParams {
     id: string;
 }
 export type GetData = SubmissionDetailResponseDto;
-export interface StartReviewParams {
-    id: string;
-}
-export type StartReviewData = any;
 export interface ApproveParams {
     id: string;
 }
@@ -3938,7 +4068,7 @@ export interface List2Params {
     only_active: string;
 }
 export type List2Data = DocumentTypeResponseDto[];
-export type CreateData1 = any;
+export type CreateOutput1 = any;
 export interface ListVersionsParams {
     code: string;
 }
@@ -4215,7 +4345,7 @@ export interface ListParams2 {
     productCode?: string;
 }
 export type ListResult = AccountProductResponseDto[];
-export type CreateResult1 = AccountProductResponseDto;
+export type CreateData1 = AccountProductResponseDto;
 export interface GetParams2 {
     /** @example "PERS-CURRENT" */
     code: string;
@@ -4315,12 +4445,12 @@ export interface ListParams4 {
     onlyActive?: boolean;
 }
 export type ListOutput = MerchantCategoriesListResponseDto;
-export type CreateResult2 = MerchantCategoryResponseDto;
+export type CreateData2 = MerchantCategoryResponseDto;
 export interface UpdateParams8 {
     /** 4-digit MCC code */
     code: string;
 }
-export type UpdateResult1 = MerchantCategoryResponseDto;
+export type UpdateOutput1 = MerchantCategoryResponseDto;
 export interface GetStatisticsParams3 {
     /** Start date filter (ISO date, e.g. 2025-01-01) */
     startDate?: string;
@@ -4329,7 +4459,7 @@ export interface GetStatisticsParams3 {
     /** Filter by currency */
     currency?: "SYP" | "USD" | "EUR";
 }
-export type GetStatisticsOutput1 = TransactionStatisticsResponseDto;
+export type GetStatisticsResult1 = TransactionStatisticsResponseDto;
 export interface ListTransactionsParams {
     /** Search by transaction ID or public transaction ID */
     search?: string;
@@ -4364,7 +4494,7 @@ export type GetTransactionDetailData = AdminTransactionDetailResponseDto;
 export type GetTransactionDetailError = ErrorResponseDto;
 export type SendGlobalNotificationData = SendGlobalNotificationResponseDto;
 export type SendGlobalNotificationError = ErrorResponseDto;
-export type CreateResult3 = ScheduledNotificationResponseDto;
+export type CreateData3 = ScheduledNotificationResponseDto;
 export type CreateBadResponse = ErrorResponseDto;
 export interface FindAllParams10 {
     /** Filter by status */
@@ -4392,7 +4522,7 @@ export interface UpdateParams10 {
     /** MongoDB ObjectId */
     id: string;
 }
-export type UpdateData2 = ScheduledNotificationResponseDto;
+export type UpdateResult1 = ScheduledNotificationResponseDto;
 export type UpdateBadResponse = ErrorResponseDto;
 export interface RemoveParams2 {
     /** MongoDB ObjectId */
@@ -4455,13 +4585,13 @@ export interface DeleteDocumentParams {
 }
 export type DeleteDocumentData = any;
 export type DeleteDocumentError = ErrorResponseDto;
-export type ListResult1 = AppVersionPolicyListResponseDto;
+export type ListOutput1 = AppVersionPolicyListResponseDto;
 export type UpsertData = AppVersionPolicyDto;
 export interface GetParams4 {
     platform: "ios" | "android";
 }
 export type GetOutput = AppVersionPolicyDto;
-export type GetStatisticsOutput2 = UserStatisticsResponseDto;
+export type GetStatisticsOutput1 = UserStatisticsResponseDto;
 export interface FindAllParams12 {
     /**
      * Page number (1-based)
@@ -4509,7 +4639,7 @@ export interface FindAllParams12 {
      */
     query?: string;
 }
-export type FindAllData1 = PersonListResponseDto;
+export type FindAllResult4 = PersonListResponseDto;
 export interface ExportUsersParams {
     /**
      * Field to sort by
@@ -4554,7 +4684,7 @@ export interface FindByIdParams6 {
     /** Person ID (UUID) */
     id: string;
 }
-export type FindByIdResult1 = PersonDetailDto;
+export type FindByIdData1 = PersonDetailDto;
 export interface UpdatePersonStatusParams {
     /** Person ID (UUID) */
     id: string;
@@ -4594,12 +4724,12 @@ export interface FindAllParams14 {
      */
     endDate?: string;
 }
-export type FindAllResult4 = DlqMessageListResponseDto;
+export type FindAllData1 = DlqMessageListResponseDto;
 export type PendingByTopicData = DlqPendingByTopicResponseDto[];
 export interface FindByIdParams8 {
     id: string;
 }
-export type FindByIdResult2 = DlqMessageResponseDto;
+export type FindByIdOutput1 = DlqMessageResponseDto;
 export interface ResolveParams {
     id: string;
 }
@@ -4608,8 +4738,8 @@ export interface ListParams7 {
     /** Return only active branches */
     onlyActive?: boolean;
 }
-export type ListResult2 = BankBranchesListResponseDto;
-export type CreateResult4 = BankBranchResponseDto;
+export type ListData1 = BankBranchesListResponseDto;
+export type CreateData4 = BankBranchResponseDto;
 export interface GetByCodeParams {
     /** 3-digit branch code */
     code: string;
@@ -4619,21 +4749,21 @@ export interface UpdateParams12 {
     /** 3-digit branch code */
     code: string;
 }
-export type UpdateResult2 = BankBranchResponseDto;
+export type UpdateOutput2 = BankBranchResponseDto;
 export interface ListParams9 {
     onlyActive?: boolean;
 }
-export type ListOutput1 = AccountTypesListResponseDto;
+export type ListOutput2 = AccountTypesListResponseDto;
 export interface UpdateParams14 {
     /** 2-digit account-type code */
     code: string;
 }
-export type UpdateOutput1 = AccountTypeResponseDto;
+export type UpdateResult2 = AccountTypeResponseDto;
 export interface ListParams11 {
     onlyActive?: boolean;
 }
-export type ListResult3 = CurrencyConfigListResponseDto;
-export type CreateOutput1 = CurrencyConfigResponseDto;
+export type ListData2 = CurrencyConfigListResponseDto;
+export type CreateResult1 = CurrencyConfigResponseDto;
 export interface GetByCodeParams2 {
     /** ISO 4217 alpha-3 code (e.g. USD) */
     code: string;
@@ -4643,17 +4773,35 @@ export interface DeleteParams6 {
     /** ISO 4217 alpha-3 code */
     code: string;
 }
-export type DeleteResult1 = any;
+export type DeleteOutput1 = any;
 export interface UpdateParams16 {
     /** ISO 4217 alpha-3 code */
     code: string;
 }
-export type UpdateData3 = CurrencyConfigResponseDto;
+export type UpdateResult3 = CurrencyConfigResponseDto;
+export type ListResult1 = CountryListResponseDto;
+export type CreateResult2 = CountryResponseDto;
+export interface UpdateParams18 {
+    /** Country UUID */
+    id: string;
+}
+export type UpdateOutput3 = CountryResponseDto;
+export interface List2Params2 {
+    /** Country UUID */
+    countryId?: string;
+}
+export type List2Result = ProvinceListResponseDto;
+export type Create2Result = ProvinceResponseDto;
+export interface Update2Params {
+    /** Province UUID */
+    id: string;
+}
+export type Update2Data = ProvinceResponseDto;
 export interface ListRequestsParams {
     /** Filter by status */
     status?: "PENDING" | "APPROVED" | "EXECUTED" | "FAILED" | "REJECTED" | "EXPIRED" | "CANCELLED";
     /** Filter by action type */
-    actionType?: "admin.create" | "admin.update" | "admin.delete" | "admin.status_update" | "system_config.upsert" | "system_config.delete" | "account.fund" | "role.assign_permissions" | "reconciliation.run";
+    actionType?: "admin.create" | "admin.update" | "admin.delete" | "admin.status_update" | "system_config.upsert" | "system_config.delete" | "account.fund" | "role.assign_permissions" | "reconciliation.run" | "kyc.approve" | "kyc.reject";
     /** Filter by maker (admin UUID) */
     requestedBy?: string;
     /**
@@ -4683,10 +4831,10 @@ export interface CancelParams {
     id: string;
 }
 export type CancelData = ApprovalRequestResponseDto;
-export type ListResult4 = ApprovalPolicyResponseDto[];
-export interface UpdateParams18 {
-    actionType: "admin.create" | "admin.update" | "admin.delete" | "admin.status_update" | "system_config.upsert" | "system_config.delete" | "account.fund" | "role.assign_permissions" | "reconciliation.run";
+export type ListResult2 = ApprovalPolicyResponseDto[];
+export interface UpdateParams20 {
+    actionType: "admin.create" | "admin.update" | "admin.delete" | "admin.status_update" | "system_config.upsert" | "system_config.delete" | "account.fund" | "role.assign_permissions" | "reconciliation.run" | "kyc.approve" | "kyc.reject";
 }
-export type UpdateOutput2 = ApprovalPolicyResponseDto;
+export type UpdateResult4 = ApprovalPolicyResponseDto;
 export type IndexData = any;
 //# sourceMappingURL=data-contracts.d.ts.map