From 6233bf468a06f5055eacea9ca39d5bfa8ee09f54 Mon Sep 17 00:00:00 2001 From: Felipe Rodrigues Date: Mon, 8 Jun 2026 21:09:08 -0300 Subject: [PATCH] [ING-238] feat(wallets): document grants_target_top_up on recurring transaction rules --- openapi.yaml | 19 +++++++++++++++++++ src/schemas/WalletCreateInput.yaml | 6 ++++++ .../WalletRecurringTransactionRule.yaml | 7 +++++++ src/schemas/WalletUpdateInput.yaml | 6 ++++++ 4 files changed, 38 insertions(+) diff --git a/openapi.yaml b/openapi.yaml index a30641e8..7c50130d 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -15415,6 +15415,7 @@ components: - created_at - expiration_at - granted_credits + - grants_target_top_up - ignore_paid_top_up_limits - interval - invoice_requires_successful_payment @@ -15480,6 +15481,12 @@ components: pattern: ^[0-9]+.?[0-9]*$ description: The number of free granted credits. Required only if there is no paid credits. example: '10.0' + grants_target_top_up: + type: + - boolean + - 'null' + description: Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted. + example: false started_at: type: - string @@ -15921,6 +15928,12 @@ components: pattern: ^[0-9]+.?[0-9]*$ description: The number of free granted credits used for recurring top-up. example: '10.0' + grants_target_top_up: + type: + - boolean + - 'null' + description: Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted. + example: false method: type: string enum: @@ -16113,6 +16126,12 @@ components: pattern: ^[0-9]+.?[0-9]*$ description: The number of free granted credits. Required only if there is no paid credits. example: '10.0' + grants_target_top_up: + type: + - boolean + - 'null' + description: Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted. + example: false started_at: type: - string diff --git a/src/schemas/WalletCreateInput.yaml b/src/schemas/WalletCreateInput.yaml index 66e5a020..04a772a3 100644 --- a/src/schemas/WalletCreateInput.yaml +++ b/src/schemas/WalletCreateInput.yaml @@ -159,6 +159,12 @@ properties: pattern: "^[0-9]+.?[0-9]*$" description: The number of free granted credits used for recurring top-up. example: "10.0" + grants_target_top_up: + type: + - boolean + - "null" + description: "Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted." + example: false method: type: string enum: diff --git a/src/schemas/WalletRecurringTransactionRule.yaml b/src/schemas/WalletRecurringTransactionRule.yaml index aeb10192..33ec0132 100644 --- a/src/schemas/WalletRecurringTransactionRule.yaml +++ b/src/schemas/WalletRecurringTransactionRule.yaml @@ -4,6 +4,7 @@ required: - created_at - expiration_at - granted_credits + - grants_target_top_up - ignore_paid_top_up_limits - interval - invoice_requires_successful_payment @@ -69,6 +70,12 @@ properties: pattern: "^[0-9]+.?[0-9]*$" description: The number of free granted credits. Required only if there is no paid credits. example: "10.0" + grants_target_top_up: + type: + - boolean + - "null" + description: "Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted." + example: false started_at: type: - string diff --git a/src/schemas/WalletUpdateInput.yaml b/src/schemas/WalletUpdateInput.yaml index aceab8db..ae20bd01 100644 --- a/src/schemas/WalletUpdateInput.yaml +++ b/src/schemas/WalletUpdateInput.yaml @@ -93,6 +93,12 @@ properties: pattern: "^[0-9]+.?[0-9]*$" description: The number of free granted credits. Required only if there is no paid credits. example: "10.0" + grants_target_top_up: + type: + - boolean + - "null" + description: "Applies only to `target` rules. When `true`, the recurring top-up grants free credits to reach the target ongoing balance instead of creating a paid top-up (and bypasses the paid top-up minimum). When `false`, the gap is filled with a paid top-up. `null` for `fixed` rules. Defaults to `false` for target rules when omitted." + example: false started_at: type: - string