@mbanq/core-sdk-js 0.25.0 → 0.27.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9040,6 +9040,136 @@ type CardSettlement = z.infer<typeof CardSettlementSchema>;
9040
9040
  type GetCardSettlementsRequest = z.infer<typeof GetCardSettlementsRequestSchema>;
9041
9041
  type GetCardSettlementsResponse = z.infer<typeof GetCardSettlementsResponseSchema>;
9042
9042
  type GetCardSettlementByIdRequest = z.infer<typeof GetCardSettlementByIdRequestSchema>;
9043
+ declare const AcquiredCard: z.ZodObject<{
9044
+ id: z.ZodNumber;
9045
+ lastDigits: z.ZodString;
9046
+ expiryDate: z.ZodString;
9047
+ network: z.ZodString;
9048
+ pushEnabled: z.ZodBoolean;
9049
+ pullEnabled: z.ZodBoolean;
9050
+ isRegulated: z.ZodBoolean;
9051
+ avsVerified: z.ZodBoolean;
9052
+ pushFundAvailability: z.ZodString;
9053
+ countryCode: z.ZodString;
9054
+ currencyCode: z.ZodString;
9055
+ cardType: z.ZodString;
9056
+ fullName: z.ZodString;
9057
+ referenceId: z.ZodString;
9058
+ externalId: z.ZodString;
9059
+ deleted: z.ZodBoolean;
9060
+ status: z.ZodString;
9061
+ financialInstitution: z.ZodString;
9062
+ createdAt: z.ZodString;
9063
+ updatedAt: z.ZodString;
9064
+ }, "strip", z.ZodTypeAny, {
9065
+ status: string;
9066
+ id: number;
9067
+ externalId: string;
9068
+ createdAt: string;
9069
+ countryCode: string;
9070
+ financialInstitution: string;
9071
+ network: string;
9072
+ cardType: string;
9073
+ expiryDate: string;
9074
+ lastDigits: string;
9075
+ pushEnabled: boolean;
9076
+ pullEnabled: boolean;
9077
+ isRegulated: boolean;
9078
+ avsVerified: boolean;
9079
+ pushFundAvailability: string;
9080
+ currencyCode: string;
9081
+ fullName: string;
9082
+ referenceId: string;
9083
+ deleted: boolean;
9084
+ updatedAt: string;
9085
+ }, {
9086
+ status: string;
9087
+ id: number;
9088
+ externalId: string;
9089
+ createdAt: string;
9090
+ countryCode: string;
9091
+ financialInstitution: string;
9092
+ network: string;
9093
+ cardType: string;
9094
+ expiryDate: string;
9095
+ lastDigits: string;
9096
+ pushEnabled: boolean;
9097
+ pullEnabled: boolean;
9098
+ isRegulated: boolean;
9099
+ avsVerified: boolean;
9100
+ pushFundAvailability: string;
9101
+ currencyCode: string;
9102
+ fullName: string;
9103
+ referenceId: string;
9104
+ deleted: boolean;
9105
+ updatedAt: string;
9106
+ }>;
9107
+ declare const AcquiredCardsList: z.ZodArray<z.ZodObject<{
9108
+ id: z.ZodNumber;
9109
+ lastDigits: z.ZodString;
9110
+ expiryDate: z.ZodString;
9111
+ network: z.ZodString;
9112
+ pushEnabled: z.ZodBoolean;
9113
+ pullEnabled: z.ZodBoolean;
9114
+ isRegulated: z.ZodBoolean;
9115
+ avsVerified: z.ZodBoolean;
9116
+ pushFundAvailability: z.ZodString;
9117
+ countryCode: z.ZodString;
9118
+ currencyCode: z.ZodString;
9119
+ cardType: z.ZodString;
9120
+ fullName: z.ZodString;
9121
+ referenceId: z.ZodString;
9122
+ externalId: z.ZodString;
9123
+ deleted: z.ZodBoolean;
9124
+ status: z.ZodString;
9125
+ financialInstitution: z.ZodString;
9126
+ createdAt: z.ZodString;
9127
+ updatedAt: z.ZodString;
9128
+ }, "strip", z.ZodTypeAny, {
9129
+ status: string;
9130
+ id: number;
9131
+ externalId: string;
9132
+ createdAt: string;
9133
+ countryCode: string;
9134
+ financialInstitution: string;
9135
+ network: string;
9136
+ cardType: string;
9137
+ expiryDate: string;
9138
+ lastDigits: string;
9139
+ pushEnabled: boolean;
9140
+ pullEnabled: boolean;
9141
+ isRegulated: boolean;
9142
+ avsVerified: boolean;
9143
+ pushFundAvailability: string;
9144
+ currencyCode: string;
9145
+ fullName: string;
9146
+ referenceId: string;
9147
+ deleted: boolean;
9148
+ updatedAt: string;
9149
+ }, {
9150
+ status: string;
9151
+ id: number;
9152
+ externalId: string;
9153
+ createdAt: string;
9154
+ countryCode: string;
9155
+ financialInstitution: string;
9156
+ network: string;
9157
+ cardType: string;
9158
+ expiryDate: string;
9159
+ lastDigits: string;
9160
+ pushEnabled: boolean;
9161
+ pullEnabled: boolean;
9162
+ isRegulated: boolean;
9163
+ avsVerified: boolean;
9164
+ pushFundAvailability: string;
9165
+ currencyCode: string;
9166
+ fullName: string;
9167
+ referenceId: string;
9168
+ deleted: boolean;
9169
+ updatedAt: string;
9170
+ }>, "many">;
9171
+ type AcquiredCardResponse = z.infer<typeof AcquiredCard>;
9172
+ type AcquiredCardsResponse = z.infer<typeof AcquiredCardsList>;
9043
9173
 
9044
9174
  declare const CreatePrepaidCardRequestSchema: z.ZodObject<{
9045
9175
  cardProductId: z.ZodNumber;
@@ -11429,6 +11559,22 @@ declare const GetCardSettlements: (params: GetCardSettlementsRequest) => Command
11429
11559
  declare const GetCardSettlementById: (params: GetCardSettlementByIdRequest) => Command<{
11430
11560
  params: GetCardSettlementByIdRequest;
11431
11561
  }, CardSettlement>;
11562
+ /**
11563
+ * Terminate a card
11564
+ *
11565
+ * Permanently terminates a card, making it unusable for any transactions.
11566
+ * This action is irreversible and the card cannot be reactivated after termination.
11567
+ * Use this when a card should be completely removed from service.
11568
+ *
11569
+ * @param cardId - The unique identifier of the card to terminate
11570
+ * @returns Command object that executes the API request and returns termination details
11571
+ *
11572
+ * @example
11573
+ * ```typescript
11574
+ * const command = TerminateCard(67890);
11575
+ * const result = await client.request(command);
11576
+ * ```
11577
+ */
11432
11578
  declare const TerminateCard: (cardId: number) => Command<{
11433
11579
  cardId: number;
11434
11580
  command: string;
@@ -11438,6 +11584,22 @@ declare const TerminateCard: (cardId: number) => Command<{
11438
11584
  clientId: number;
11439
11585
  cardToken: string;
11440
11586
  }>;
11587
+ /**
11588
+ * Suspend a card
11589
+ *
11590
+ * Temporarily suspends a card, preventing it from being used for transactions.
11591
+ * The card can be reactivated later using ReactivateCard or ActivateCard.
11592
+ * Use this for temporary card holds or when investigating suspicious activity.
11593
+ *
11594
+ * @param cardId - The unique identifier of the card to suspend
11595
+ * @returns Command object that executes the API request and returns suspension details
11596
+ *
11597
+ * @example
11598
+ * ```typescript
11599
+ * const command = SuspendCard(67890);
11600
+ * const result = await client.request(command);
11601
+ * ```
11602
+ */
11441
11603
  declare const SuspendCard: (cardId: number) => Command<{
11442
11604
  cardId: number;
11443
11605
  command: string;
@@ -11447,6 +11609,22 @@ declare const SuspendCard: (cardId: number) => Command<{
11447
11609
  clientId: number;
11448
11610
  cardToken: string;
11449
11611
  }>;
11612
+ /**
11613
+ * Activate a card
11614
+ *
11615
+ * Activates a card that has been issued but not yet activated.
11616
+ * This is typically required for new cards or cards that were previously suspended.
11617
+ * Activation enables the card for transactions according to its configured features.
11618
+ *
11619
+ * @param cardId - The unique identifier of the card to activate
11620
+ * @returns Command object that executes the API request and returns activation details
11621
+ *
11622
+ * @example
11623
+ * ```typescript
11624
+ * const command = ActivateCard(67890);
11625
+ * const result = await client.request(command);
11626
+ * ```
11627
+ */
11450
11628
  declare const ActivateCard: (cardId: number) => Command<{
11451
11629
  cardId: number;
11452
11630
  command: string;
@@ -11456,6 +11634,23 @@ declare const ActivateCard: (cardId: number) => Command<{
11456
11634
  clientId: number;
11457
11635
  cardToken: string;
11458
11636
  }>;
11637
+ /**
11638
+ * Reactivate a suspended card
11639
+ *
11640
+ * Reactivates a card that was previously suspended. This restores the card's
11641
+ * ability to process transactions according to its configuration.
11642
+ * Use this to restore a suspended card back to active status.
11643
+ *
11644
+ * @param cardId - The unique identifier of the card to reactivate
11645
+ * @returns Command object that executes the API request and returns reactivation details
11646
+ *
11647
+ * @example
11648
+ * ```typescript
11649
+ * const command = ReactivateCard(67890);
11650
+ * const result = await client.request(command);
11651
+ * console.log(`Card ${result.id} has been reactivated`);
11652
+ * ```
11653
+ */
11459
11654
  declare const ReactivateCard: (cardId: number) => Command<{
11460
11655
  cardId: number;
11461
11656
  command: string;
@@ -11465,6 +11660,24 @@ declare const ReactivateCard: (cardId: number) => Command<{
11465
11660
  clientId: number;
11466
11661
  cardToken: string;
11467
11662
  }>;
11663
+ /**
11664
+ * Replace a card
11665
+ *
11666
+ * Requests a replacement for an existing card due to loss, theft, damage, or non-receipt.
11667
+ * This action terminates the current card and issues a new card with a new number and details.
11668
+ * The replacement card will inherit the same configuration and features as the original card.
11669
+ *
11670
+ * @param cardId - The unique identifier of the card to replace
11671
+ * @param reason - The reason for replacement (LOST, STOLEN, DAMAGED, or CARD_NOT_RECEIVED)
11672
+ * @returns Command object that executes the API request and returns replacement card details
11673
+ *
11674
+ * @example
11675
+ * ```typescript
11676
+ * // Replace a lost card
11677
+ * const command = ReplaceCard(67890, 'LOST');
11678
+ * const result = await client.request(command);
11679
+ * ```
11680
+ */
11468
11681
  declare const ReplaceCard: (cardId: number, reason: "LOST" | "STOLEN" | "DAMAGED" | "CARD_NOT_RECEIVED") => Command<{
11469
11682
  cardId: number;
11470
11683
  reason: string;
@@ -11473,6 +11686,25 @@ declare const ReplaceCard: (cardId: number, reason: "LOST" | "STOLEN" | "DAMAGED
11473
11686
  resourceId: number;
11474
11687
  clientId: number;
11475
11688
  }>;
11689
+ /**
11690
+ * Renew a card
11691
+ *
11692
+ * Renews an expiring card by issuing a new card with the same product type.
11693
+ * This is typically used when a card is approaching its expiration date and needs
11694
+ * to be renewed with a new expiration date. The new card will maintain the same
11695
+ * product configuration and features as the original card.
11696
+ *
11697
+ * @param cardId - The unique identifier of the card to renew
11698
+ * @param productId - The product ID for the renewed card (can be the same or different from original)
11699
+ * @returns Command object that executes the API request and returns renewed card details
11700
+ *
11701
+ * @example
11702
+ * ```typescript
11703
+ * // Renew a card with the same product
11704
+ * const command = RenewCard(67890, 12345);
11705
+ * const result = await client.request(command);
11706
+ * ```
11707
+ */
11476
11708
  declare const RenewCard: (cardId: number, productId: number) => Command<{
11477
11709
  cardId: number;
11478
11710
  productId: number;
@@ -11481,6 +11713,50 @@ declare const RenewCard: (cardId: number, productId: number) => Command<{
11481
11713
  resourceId: number;
11482
11714
  clientId: number;
11483
11715
  }>;
11716
+ /**
11717
+ * Get all acquired cards for a client
11718
+ *
11719
+ * Retrieves a list of all acquired/external cards associated with a specific client ID.
11720
+ * Acquired cards are cards that were obtained from external sources or integrated systems.
11721
+ * Returns comprehensive card details including status, type, network, and configuration.
11722
+ *
11723
+ * @param clientId - The unique identifier of the client
11724
+ * @returns Command object that executes the API request and returns list of acquired cards
11725
+ *
11726
+ * @example
11727
+ * ```typescript
11728
+ * const command = GetAcquiredCards(12345);
11729
+ * const acquiredCards = await client.request(command);
11730
+ * console.log(`Found ${acquiredCards.length} acquired cards`);
11731
+ * ```
11732
+ */
11733
+ declare const GetAcquiredCards: (clientId: number) => Command<{
11734
+ clientId: number;
11735
+ }, AcquiredCardsResponse>;
11736
+ /**
11737
+ * Get acquired card by ID
11738
+ *
11739
+ * Retrieves detailed information for a specific acquired/external card using its unique identifier.
11740
+ * This endpoint allows you to fetch specific information related to an acquired card based on the
11741
+ * card ID, including all card details such as network, type, status, and configuration settings.
11742
+ *
11743
+ * @param clientId - The unique identifier of the client who owns the acquired card
11744
+ * @param acquiredCardId - The unique identifier of the acquired card to retrieve
11745
+ * @returns Command object that executes the API request and returns acquired card details
11746
+ *
11747
+ * @example
11748
+ * ```typescript
11749
+ * const command = getAcquiredCardById(12345, 67890);
11750
+ * const acquiredCard = await client.request(command);
11751
+ * console.log(`Card: ${acquiredCard.fullName} - ${acquiredCard.network}`);
11752
+ * console.log(`Status: ${acquiredCard.status}`);
11753
+ * console.log(`Type: ${acquiredCard.cardType}`);
11754
+ * ```
11755
+ */
11756
+ declare const getAcquiredCardById: (clientId: number, acquiredCardId: number) => Command<{
11757
+ clientId: number;
11758
+ acquiredCardId: number;
11759
+ }, AcquiredCardResponse>;
11484
11760
 
11485
11761
  /**
11486
11762
  * Create Prepaid Card
@@ -16963,4 +17239,4 @@ declare const DeleteFixedDepositAccount: (accountId: number) => Command<{
16963
17239
  accountId: number;
16964
17240
  }, DeleteFixedDepositAccountResponse>;
16965
17241
 
16966
- export { ActivateCard, ActivatePhysicalCard, AddCardToMobileWallet, ApproveRejectClientDocument, BlockAccount, ChangeCardType, CloseAccount, CreateAccountProduct, CreateAndActivateAccount, CreateCard, CreateCardProduct, CreateClient, CreateClientAddress, CreateClientIdentifier, CreateFixedDepositAccount, CreatePayment, CreatePrepaidCard, CreateRecipient, CreateTransfer, CustomCreate, CustomGet, CustomUpdate, DeactivatePrepaidCard, DeleteAccount, DeleteClient, DeleteClientDocument, DeleteFixedDepositAccount, DeletePayment, DeleteRecipient, DeleteSelfServiceUser, DownloadAccountStatement, EnableDisableConfiguration, EnableSelfServiceAccess, GenerateAccountStatement, GetAccount, GetAccountDocumentsDetails, GetAccountProductById, GetAccountsOfClient, GetAllAccountProducts, GetBankDetailsFromRoutingCode, GetCardAuthorizationById, GetCardAuthorizations, GetCardById, GetCardImageUrl, GetCardProduct, GetCardSettlementById, GetCardSettlements, GetCards, GetClient, GetClientAddress, GetClientClassification, GetClients, GetCompletedTransactions, GetConfigurationByName, GetConfigurations, GetFixedDepositAccount, GetPayment, GetPayments, GetPendingTransactions, GetPermittedDocumentTypes, GetPrepaidCardById, GetPrepaidCardsByAccountId, GetRecentTransactions, GetRecipient, GetRecipients, GetStatusOfVerifyClient, GetTransactionById, GetTransfer, GetTransfers, GetUserDetail, GraphQL, HoldAmount, ListCardProduct, ListClientDocument, OrderPhysicalCard, ReactivateCard, RenewCard, ReplaceCard, ScheduleAccountClosure, SetClientAddressStatus, SetPIN, SuspendCard, SwitchClientClassification, TerminateCard, UpdateAccount, UpdateAccountProduct, UpdateCardFeature, UpdateCardLimit, UpdateCardProduct, UpdateClient, UpdateClientAddress, UpdateClientIdentifier, UpdateFixedDepositAccount, UpdatePayment, UpdateRecipientGQL as UpdateRecipient, UpdateSelfServiceUser, UploadClientIdentifierDocument, VerifyWithActivateClients };
17242
+ export { ActivateCard, ActivatePhysicalCard, AddCardToMobileWallet, ApproveRejectClientDocument, BlockAccount, ChangeCardType, CloseAccount, CreateAccountProduct, CreateAndActivateAccount, CreateCard, CreateCardProduct, CreateClient, CreateClientAddress, CreateClientIdentifier, CreateFixedDepositAccount, CreatePayment, CreatePrepaidCard, CreateRecipient, CreateTransfer, CustomCreate, CustomGet, CustomUpdate, DeactivatePrepaidCard, DeleteAccount, DeleteClient, DeleteClientDocument, DeleteFixedDepositAccount, DeletePayment, DeleteRecipient, DeleteSelfServiceUser, DownloadAccountStatement, EnableDisableConfiguration, EnableSelfServiceAccess, GenerateAccountStatement, GetAccount, GetAccountDocumentsDetails, GetAccountProductById, GetAccountsOfClient, GetAcquiredCards, GetAllAccountProducts, GetBankDetailsFromRoutingCode, GetCardAuthorizationById, GetCardAuthorizations, GetCardById, GetCardImageUrl, GetCardProduct, GetCardSettlementById, GetCardSettlements, GetCards, GetClient, GetClientAddress, GetClientClassification, GetClients, GetCompletedTransactions, GetConfigurationByName, GetConfigurations, GetFixedDepositAccount, GetPayment, GetPayments, GetPendingTransactions, GetPermittedDocumentTypes, GetPrepaidCardById, GetPrepaidCardsByAccountId, GetRecentTransactions, GetRecipient, GetRecipients, GetStatusOfVerifyClient, GetTransactionById, GetTransfer, GetTransfers, GetUserDetail, GraphQL, HoldAmount, ListCardProduct, ListClientDocument, OrderPhysicalCard, ReactivateCard, RenewCard, ReplaceCard, ScheduleAccountClosure, SetClientAddressStatus, SetPIN, SuspendCard, SwitchClientClassification, TerminateCard, UpdateAccount, UpdateAccountProduct, UpdateCardFeature, UpdateCardLimit, UpdateCardProduct, UpdateClient, UpdateClientAddress, UpdateClientIdentifier, UpdateFixedDepositAccount, UpdatePayment, UpdateRecipientGQL as UpdateRecipient, UpdateSelfServiceUser, UploadClientIdentifierDocument, VerifyWithActivateClients, getAcquiredCardById };
@@ -9040,6 +9040,136 @@ type CardSettlement = z.infer<typeof CardSettlementSchema>;
9040
9040
  type GetCardSettlementsRequest = z.infer<typeof GetCardSettlementsRequestSchema>;
9041
9041
  type GetCardSettlementsResponse = z.infer<typeof GetCardSettlementsResponseSchema>;
9042
9042
  type GetCardSettlementByIdRequest = z.infer<typeof GetCardSettlementByIdRequestSchema>;
9043
+ declare const AcquiredCard: z.ZodObject<{
9044
+ id: z.ZodNumber;
9045
+ lastDigits: z.ZodString;
9046
+ expiryDate: z.ZodString;
9047
+ network: z.ZodString;
9048
+ pushEnabled: z.ZodBoolean;
9049
+ pullEnabled: z.ZodBoolean;
9050
+ isRegulated: z.ZodBoolean;
9051
+ avsVerified: z.ZodBoolean;
9052
+ pushFundAvailability: z.ZodString;
9053
+ countryCode: z.ZodString;
9054
+ currencyCode: z.ZodString;
9055
+ cardType: z.ZodString;
9056
+ fullName: z.ZodString;
9057
+ referenceId: z.ZodString;
9058
+ externalId: z.ZodString;
9059
+ deleted: z.ZodBoolean;
9060
+ status: z.ZodString;
9061
+ financialInstitution: z.ZodString;
9062
+ createdAt: z.ZodString;
9063
+ updatedAt: z.ZodString;
9064
+ }, "strip", z.ZodTypeAny, {
9065
+ status: string;
9066
+ id: number;
9067
+ externalId: string;
9068
+ createdAt: string;
9069
+ countryCode: string;
9070
+ financialInstitution: string;
9071
+ network: string;
9072
+ cardType: string;
9073
+ expiryDate: string;
9074
+ lastDigits: string;
9075
+ pushEnabled: boolean;
9076
+ pullEnabled: boolean;
9077
+ isRegulated: boolean;
9078
+ avsVerified: boolean;
9079
+ pushFundAvailability: string;
9080
+ currencyCode: string;
9081
+ fullName: string;
9082
+ referenceId: string;
9083
+ deleted: boolean;
9084
+ updatedAt: string;
9085
+ }, {
9086
+ status: string;
9087
+ id: number;
9088
+ externalId: string;
9089
+ createdAt: string;
9090
+ countryCode: string;
9091
+ financialInstitution: string;
9092
+ network: string;
9093
+ cardType: string;
9094
+ expiryDate: string;
9095
+ lastDigits: string;
9096
+ pushEnabled: boolean;
9097
+ pullEnabled: boolean;
9098
+ isRegulated: boolean;
9099
+ avsVerified: boolean;
9100
+ pushFundAvailability: string;
9101
+ currencyCode: string;
9102
+ fullName: string;
9103
+ referenceId: string;
9104
+ deleted: boolean;
9105
+ updatedAt: string;
9106
+ }>;
9107
+ declare const AcquiredCardsList: z.ZodArray<z.ZodObject<{
9108
+ id: z.ZodNumber;
9109
+ lastDigits: z.ZodString;
9110
+ expiryDate: z.ZodString;
9111
+ network: z.ZodString;
9112
+ pushEnabled: z.ZodBoolean;
9113
+ pullEnabled: z.ZodBoolean;
9114
+ isRegulated: z.ZodBoolean;
9115
+ avsVerified: z.ZodBoolean;
9116
+ pushFundAvailability: z.ZodString;
9117
+ countryCode: z.ZodString;
9118
+ currencyCode: z.ZodString;
9119
+ cardType: z.ZodString;
9120
+ fullName: z.ZodString;
9121
+ referenceId: z.ZodString;
9122
+ externalId: z.ZodString;
9123
+ deleted: z.ZodBoolean;
9124
+ status: z.ZodString;
9125
+ financialInstitution: z.ZodString;
9126
+ createdAt: z.ZodString;
9127
+ updatedAt: z.ZodString;
9128
+ }, "strip", z.ZodTypeAny, {
9129
+ status: string;
9130
+ id: number;
9131
+ externalId: string;
9132
+ createdAt: string;
9133
+ countryCode: string;
9134
+ financialInstitution: string;
9135
+ network: string;
9136
+ cardType: string;
9137
+ expiryDate: string;
9138
+ lastDigits: string;
9139
+ pushEnabled: boolean;
9140
+ pullEnabled: boolean;
9141
+ isRegulated: boolean;
9142
+ avsVerified: boolean;
9143
+ pushFundAvailability: string;
9144
+ currencyCode: string;
9145
+ fullName: string;
9146
+ referenceId: string;
9147
+ deleted: boolean;
9148
+ updatedAt: string;
9149
+ }, {
9150
+ status: string;
9151
+ id: number;
9152
+ externalId: string;
9153
+ createdAt: string;
9154
+ countryCode: string;
9155
+ financialInstitution: string;
9156
+ network: string;
9157
+ cardType: string;
9158
+ expiryDate: string;
9159
+ lastDigits: string;
9160
+ pushEnabled: boolean;
9161
+ pullEnabled: boolean;
9162
+ isRegulated: boolean;
9163
+ avsVerified: boolean;
9164
+ pushFundAvailability: string;
9165
+ currencyCode: string;
9166
+ fullName: string;
9167
+ referenceId: string;
9168
+ deleted: boolean;
9169
+ updatedAt: string;
9170
+ }>, "many">;
9171
+ type AcquiredCardResponse = z.infer<typeof AcquiredCard>;
9172
+ type AcquiredCardsResponse = z.infer<typeof AcquiredCardsList>;
9043
9173
 
9044
9174
  declare const CreatePrepaidCardRequestSchema: z.ZodObject<{
9045
9175
  cardProductId: z.ZodNumber;
@@ -11429,6 +11559,22 @@ declare const GetCardSettlements: (params: GetCardSettlementsRequest) => Command
11429
11559
  declare const GetCardSettlementById: (params: GetCardSettlementByIdRequest) => Command<{
11430
11560
  params: GetCardSettlementByIdRequest;
11431
11561
  }, CardSettlement>;
11562
+ /**
11563
+ * Terminate a card
11564
+ *
11565
+ * Permanently terminates a card, making it unusable for any transactions.
11566
+ * This action is irreversible and the card cannot be reactivated after termination.
11567
+ * Use this when a card should be completely removed from service.
11568
+ *
11569
+ * @param cardId - The unique identifier of the card to terminate
11570
+ * @returns Command object that executes the API request and returns termination details
11571
+ *
11572
+ * @example
11573
+ * ```typescript
11574
+ * const command = TerminateCard(67890);
11575
+ * const result = await client.request(command);
11576
+ * ```
11577
+ */
11432
11578
  declare const TerminateCard: (cardId: number) => Command<{
11433
11579
  cardId: number;
11434
11580
  command: string;
@@ -11438,6 +11584,22 @@ declare const TerminateCard: (cardId: number) => Command<{
11438
11584
  clientId: number;
11439
11585
  cardToken: string;
11440
11586
  }>;
11587
+ /**
11588
+ * Suspend a card
11589
+ *
11590
+ * Temporarily suspends a card, preventing it from being used for transactions.
11591
+ * The card can be reactivated later using ReactivateCard or ActivateCard.
11592
+ * Use this for temporary card holds or when investigating suspicious activity.
11593
+ *
11594
+ * @param cardId - The unique identifier of the card to suspend
11595
+ * @returns Command object that executes the API request and returns suspension details
11596
+ *
11597
+ * @example
11598
+ * ```typescript
11599
+ * const command = SuspendCard(67890);
11600
+ * const result = await client.request(command);
11601
+ * ```
11602
+ */
11441
11603
  declare const SuspendCard: (cardId: number) => Command<{
11442
11604
  cardId: number;
11443
11605
  command: string;
@@ -11447,6 +11609,22 @@ declare const SuspendCard: (cardId: number) => Command<{
11447
11609
  clientId: number;
11448
11610
  cardToken: string;
11449
11611
  }>;
11612
+ /**
11613
+ * Activate a card
11614
+ *
11615
+ * Activates a card that has been issued but not yet activated.
11616
+ * This is typically required for new cards or cards that were previously suspended.
11617
+ * Activation enables the card for transactions according to its configured features.
11618
+ *
11619
+ * @param cardId - The unique identifier of the card to activate
11620
+ * @returns Command object that executes the API request and returns activation details
11621
+ *
11622
+ * @example
11623
+ * ```typescript
11624
+ * const command = ActivateCard(67890);
11625
+ * const result = await client.request(command);
11626
+ * ```
11627
+ */
11450
11628
  declare const ActivateCard: (cardId: number) => Command<{
11451
11629
  cardId: number;
11452
11630
  command: string;
@@ -11456,6 +11634,23 @@ declare const ActivateCard: (cardId: number) => Command<{
11456
11634
  clientId: number;
11457
11635
  cardToken: string;
11458
11636
  }>;
11637
+ /**
11638
+ * Reactivate a suspended card
11639
+ *
11640
+ * Reactivates a card that was previously suspended. This restores the card's
11641
+ * ability to process transactions according to its configuration.
11642
+ * Use this to restore a suspended card back to active status.
11643
+ *
11644
+ * @param cardId - The unique identifier of the card to reactivate
11645
+ * @returns Command object that executes the API request and returns reactivation details
11646
+ *
11647
+ * @example
11648
+ * ```typescript
11649
+ * const command = ReactivateCard(67890);
11650
+ * const result = await client.request(command);
11651
+ * console.log(`Card ${result.id} has been reactivated`);
11652
+ * ```
11653
+ */
11459
11654
  declare const ReactivateCard: (cardId: number) => Command<{
11460
11655
  cardId: number;
11461
11656
  command: string;
@@ -11465,6 +11660,24 @@ declare const ReactivateCard: (cardId: number) => Command<{
11465
11660
  clientId: number;
11466
11661
  cardToken: string;
11467
11662
  }>;
11663
+ /**
11664
+ * Replace a card
11665
+ *
11666
+ * Requests a replacement for an existing card due to loss, theft, damage, or non-receipt.
11667
+ * This action terminates the current card and issues a new card with a new number and details.
11668
+ * The replacement card will inherit the same configuration and features as the original card.
11669
+ *
11670
+ * @param cardId - The unique identifier of the card to replace
11671
+ * @param reason - The reason for replacement (LOST, STOLEN, DAMAGED, or CARD_NOT_RECEIVED)
11672
+ * @returns Command object that executes the API request and returns replacement card details
11673
+ *
11674
+ * @example
11675
+ * ```typescript
11676
+ * // Replace a lost card
11677
+ * const command = ReplaceCard(67890, 'LOST');
11678
+ * const result = await client.request(command);
11679
+ * ```
11680
+ */
11468
11681
  declare const ReplaceCard: (cardId: number, reason: "LOST" | "STOLEN" | "DAMAGED" | "CARD_NOT_RECEIVED") => Command<{
11469
11682
  cardId: number;
11470
11683
  reason: string;
@@ -11473,6 +11686,25 @@ declare const ReplaceCard: (cardId: number, reason: "LOST" | "STOLEN" | "DAMAGED
11473
11686
  resourceId: number;
11474
11687
  clientId: number;
11475
11688
  }>;
11689
+ /**
11690
+ * Renew a card
11691
+ *
11692
+ * Renews an expiring card by issuing a new card with the same product type.
11693
+ * This is typically used when a card is approaching its expiration date and needs
11694
+ * to be renewed with a new expiration date. The new card will maintain the same
11695
+ * product configuration and features as the original card.
11696
+ *
11697
+ * @param cardId - The unique identifier of the card to renew
11698
+ * @param productId - The product ID for the renewed card (can be the same or different from original)
11699
+ * @returns Command object that executes the API request and returns renewed card details
11700
+ *
11701
+ * @example
11702
+ * ```typescript
11703
+ * // Renew a card with the same product
11704
+ * const command = RenewCard(67890, 12345);
11705
+ * const result = await client.request(command);
11706
+ * ```
11707
+ */
11476
11708
  declare const RenewCard: (cardId: number, productId: number) => Command<{
11477
11709
  cardId: number;
11478
11710
  productId: number;
@@ -11481,6 +11713,50 @@ declare const RenewCard: (cardId: number, productId: number) => Command<{
11481
11713
  resourceId: number;
11482
11714
  clientId: number;
11483
11715
  }>;
11716
+ /**
11717
+ * Get all acquired cards for a client
11718
+ *
11719
+ * Retrieves a list of all acquired/external cards associated with a specific client ID.
11720
+ * Acquired cards are cards that were obtained from external sources or integrated systems.
11721
+ * Returns comprehensive card details including status, type, network, and configuration.
11722
+ *
11723
+ * @param clientId - The unique identifier of the client
11724
+ * @returns Command object that executes the API request and returns list of acquired cards
11725
+ *
11726
+ * @example
11727
+ * ```typescript
11728
+ * const command = GetAcquiredCards(12345);
11729
+ * const acquiredCards = await client.request(command);
11730
+ * console.log(`Found ${acquiredCards.length} acquired cards`);
11731
+ * ```
11732
+ */
11733
+ declare const GetAcquiredCards: (clientId: number) => Command<{
11734
+ clientId: number;
11735
+ }, AcquiredCardsResponse>;
11736
+ /**
11737
+ * Get acquired card by ID
11738
+ *
11739
+ * Retrieves detailed information for a specific acquired/external card using its unique identifier.
11740
+ * This endpoint allows you to fetch specific information related to an acquired card based on the
11741
+ * card ID, including all card details such as network, type, status, and configuration settings.
11742
+ *
11743
+ * @param clientId - The unique identifier of the client who owns the acquired card
11744
+ * @param acquiredCardId - The unique identifier of the acquired card to retrieve
11745
+ * @returns Command object that executes the API request and returns acquired card details
11746
+ *
11747
+ * @example
11748
+ * ```typescript
11749
+ * const command = getAcquiredCardById(12345, 67890);
11750
+ * const acquiredCard = await client.request(command);
11751
+ * console.log(`Card: ${acquiredCard.fullName} - ${acquiredCard.network}`);
11752
+ * console.log(`Status: ${acquiredCard.status}`);
11753
+ * console.log(`Type: ${acquiredCard.cardType}`);
11754
+ * ```
11755
+ */
11756
+ declare const getAcquiredCardById: (clientId: number, acquiredCardId: number) => Command<{
11757
+ clientId: number;
11758
+ acquiredCardId: number;
11759
+ }, AcquiredCardResponse>;
11484
11760
 
11485
11761
  /**
11486
11762
  * Create Prepaid Card
@@ -16963,4 +17239,4 @@ declare const DeleteFixedDepositAccount: (accountId: number) => Command<{
16963
17239
  accountId: number;
16964
17240
  }, DeleteFixedDepositAccountResponse>;
16965
17241
 
16966
- export { ActivateCard, ActivatePhysicalCard, AddCardToMobileWallet, ApproveRejectClientDocument, BlockAccount, ChangeCardType, CloseAccount, CreateAccountProduct, CreateAndActivateAccount, CreateCard, CreateCardProduct, CreateClient, CreateClientAddress, CreateClientIdentifier, CreateFixedDepositAccount, CreatePayment, CreatePrepaidCard, CreateRecipient, CreateTransfer, CustomCreate, CustomGet, CustomUpdate, DeactivatePrepaidCard, DeleteAccount, DeleteClient, DeleteClientDocument, DeleteFixedDepositAccount, DeletePayment, DeleteRecipient, DeleteSelfServiceUser, DownloadAccountStatement, EnableDisableConfiguration, EnableSelfServiceAccess, GenerateAccountStatement, GetAccount, GetAccountDocumentsDetails, GetAccountProductById, GetAccountsOfClient, GetAllAccountProducts, GetBankDetailsFromRoutingCode, GetCardAuthorizationById, GetCardAuthorizations, GetCardById, GetCardImageUrl, GetCardProduct, GetCardSettlementById, GetCardSettlements, GetCards, GetClient, GetClientAddress, GetClientClassification, GetClients, GetCompletedTransactions, GetConfigurationByName, GetConfigurations, GetFixedDepositAccount, GetPayment, GetPayments, GetPendingTransactions, GetPermittedDocumentTypes, GetPrepaidCardById, GetPrepaidCardsByAccountId, GetRecentTransactions, GetRecipient, GetRecipients, GetStatusOfVerifyClient, GetTransactionById, GetTransfer, GetTransfers, GetUserDetail, GraphQL, HoldAmount, ListCardProduct, ListClientDocument, OrderPhysicalCard, ReactivateCard, RenewCard, ReplaceCard, ScheduleAccountClosure, SetClientAddressStatus, SetPIN, SuspendCard, SwitchClientClassification, TerminateCard, UpdateAccount, UpdateAccountProduct, UpdateCardFeature, UpdateCardLimit, UpdateCardProduct, UpdateClient, UpdateClientAddress, UpdateClientIdentifier, UpdateFixedDepositAccount, UpdatePayment, UpdateRecipientGQL as UpdateRecipient, UpdateSelfServiceUser, UploadClientIdentifierDocument, VerifyWithActivateClients };
17242
+ export { ActivateCard, ActivatePhysicalCard, AddCardToMobileWallet, ApproveRejectClientDocument, BlockAccount, ChangeCardType, CloseAccount, CreateAccountProduct, CreateAndActivateAccount, CreateCard, CreateCardProduct, CreateClient, CreateClientAddress, CreateClientIdentifier, CreateFixedDepositAccount, CreatePayment, CreatePrepaidCard, CreateRecipient, CreateTransfer, CustomCreate, CustomGet, CustomUpdate, DeactivatePrepaidCard, DeleteAccount, DeleteClient, DeleteClientDocument, DeleteFixedDepositAccount, DeletePayment, DeleteRecipient, DeleteSelfServiceUser, DownloadAccountStatement, EnableDisableConfiguration, EnableSelfServiceAccess, GenerateAccountStatement, GetAccount, GetAccountDocumentsDetails, GetAccountProductById, GetAccountsOfClient, GetAcquiredCards, GetAllAccountProducts, GetBankDetailsFromRoutingCode, GetCardAuthorizationById, GetCardAuthorizations, GetCardById, GetCardImageUrl, GetCardProduct, GetCardSettlementById, GetCardSettlements, GetCards, GetClient, GetClientAddress, GetClientClassification, GetClients, GetCompletedTransactions, GetConfigurationByName, GetConfigurations, GetFixedDepositAccount, GetPayment, GetPayments, GetPendingTransactions, GetPermittedDocumentTypes, GetPrepaidCardById, GetPrepaidCardsByAccountId, GetRecentTransactions, GetRecipient, GetRecipients, GetStatusOfVerifyClient, GetTransactionById, GetTransfer, GetTransfers, GetUserDetail, GraphQL, HoldAmount, ListCardProduct, ListClientDocument, OrderPhysicalCard, ReactivateCard, RenewCard, ReplaceCard, ScheduleAccountClosure, SetClientAddressStatus, SetPIN, SuspendCard, SwitchClientClassification, TerminateCard, UpdateAccount, UpdateAccountProduct, UpdateCardFeature, UpdateCardLimit, UpdateCardProduct, UpdateClient, UpdateClientAddress, UpdateClientIdentifier, UpdateFixedDepositAccount, UpdatePayment, UpdateRecipientGQL as UpdateRecipient, UpdateSelfServiceUser, UploadClientIdentifierDocument, VerifyWithActivateClients, getAcquiredCardById };