@naturali/sdk 0.171.1 → 0.173.0

package/dist/index.cjs

@@ -5430,7 +5430,7 @@ var Users = class {
 	/**
 	* Top up credit
 	*
-	* Buys model credit for the caller's account. Once the card is charged the full amount is added to `credit_balance_usd` as purchased credit, which never expires. The card fee is not deducted. Charged in US dollars.
+	* Buys model credit for the caller's account. Once the card is charged the full amount is added to `credit_balance_usd` as purchased credit, which never expires. The card fee is not deducted. `amount_usd` is what is credited; a card issued in Brazil is charged its equivalent in Brazilian reais at the Banco Central's latest closing PTAX selling rate, and a checkout shows reais to a payer in Brazil.
 	*
 	* With `saved_card: true` the saved card is charged at once and the answer is `status: paid`. When the card needs authentication or is declined, nothing is charged and the answer falls back to a checkout.
 	*
@@ -5461,7 +5461,7 @@ var Users = class {
 	/**
 	* Get the saved card
 	*
-	* The card auto-recharge and monthly statements are charged to, as the payment provider reports it. Only the brand, last four digits and expiry are kept here.
+	* The card auto-recharge and monthly statements are charged to, as the payment provider reports it. Only the brand, last four digits, expiry and issuing country are kept here. A card issued in Brazil is charged in Brazilian reais, every other card in US dollars.
 	*
 	*/
 	static getCurrentUserPaymentMethod(options) {
@@ -5527,7 +5527,7 @@ var Users = class {
 	*
 	* Choose `free`, `pro` or `business`. A paid plan needs a saved card.
 	*
-	* An upgrade is charged at once on the saved card for the price difference over the rest of the month, then takes effect; the month's statement nets that payment out. A declined card leaves the plan unchanged. A downgrade takes effect when the month ends, and `next_plan` names it until then. A contract plan is changed by asking us.
+	* An upgrade is charged at once on the saved card, in its currency, for the price difference over the rest of the month, then takes effect; the month's statement nets that payment out. A declined card leaves the plan unchanged. A downgrade takes effect when the month ends, and `next_plan` names it until then. A contract plan is changed by asking us.
 	*
 	*/
 	static setCurrentUserPlan(options) {

package/dist/index.d.cts

@@ -8426,7 +8426,7 @@ type TopUp = {
    */
   id: string;
   /**
-   * What is charged, and what is credited once paid.
+   * What is credited once paid: charged in US dollars, or its equivalent in reais.
    */
   amount_usd: number;
   /**
@@ -8447,6 +8447,14 @@ type PaymentMethod = {
   last4: string;
   exp_month: number;
   exp_year: number;
+  /**
+   * What the card is charged in, from its issuing country.
+   */
+  currency: 'usd' | 'brl';
+  /**
+   * Units of `currency` per US dollar for a charge made now: 1 for `usd`, the Banco Central's latest closing PTAX selling rate for `brl`. `null` while that rate cannot be read.
+   */
+  exchange_rate: number | null;
 };
 type PaymentMethodSetup = {
   /**
@@ -24168,7 +24176,7 @@ type CreateCurrentUserTopUpErrors = {
    */
   502: ErrorResponse;
   /**
-   * Card payments are not available on this deployment (`payments_not_configured`).
+   * Card payments are not available on this deployment (`payments_not_configured`), or the exchange rate for a card charged in reais could not be read (`exchange_rate_unavailable`). Nothing was charged.
    */
   503: ErrorResponse;
 };
@@ -24355,6 +24363,10 @@ type SetCurrentUserPlanErrors = {
    * The payment provider could not be reached (`payment_provider_error`).
    */
   502: ErrorResponse;
+  /**
+   * The exchange rate for a card charged in reais could not be read (`exchange_rate_unavailable`); the plan is unchanged.
+   */
+  503: ErrorResponse;
 };
 type SetCurrentUserPlanError = SetCurrentUserPlanErrors[keyof SetCurrentUserPlanErrors];
 type SetCurrentUserPlanResponses = {
@@ -27593,7 +27605,7 @@ export declare class Users {
   /**
    * Top up credit
    *
-   * Buys model credit for the caller's account. Once the card is charged the full amount is added to `credit_balance_usd` as purchased credit, which never expires. The card fee is not deducted. Charged in US dollars.
+   * Buys model credit for the caller's account. Once the card is charged the full amount is added to `credit_balance_usd` as purchased credit, which never expires. The card fee is not deducted. `amount_usd` is what is credited; a card issued in Brazil is charged its equivalent in Brazilian reais at the Banco Central's latest closing PTAX selling rate, and a checkout shows reais to a payer in Brazil.
    *
    * With `saved_card: true` the saved card is charged at once and the answer is `status: paid`. When the card needs authentication or is declined, nothing is charged and the answer falls back to a checkout.
    *
@@ -27610,7 +27622,7 @@ export declare class Users {
   /**
    * Get the saved card
    *
-   * The card auto-recharge and monthly statements are charged to, as the payment provider reports it. Only the brand, last four digits and expiry are kept here.
+   * The card auto-recharge and monthly statements are charged to, as the payment provider reports it. Only the brand, last four digits, expiry and issuing country are kept here. A card issued in Brazil is charged in Brazilian reais, every other card in US dollars.
    *
    */
   static getCurrentUserPaymentMethod<ThrowOnError extends boolean = false>(options?: Options<GetCurrentUserPaymentMethodData, ThrowOnError>): RequestResult<GetCurrentUserPaymentMethodResponses, GetCurrentUserPaymentMethodErrors, ThrowOnError>;
@@ -27647,7 +27659,7 @@ export declare class Users {
    *
    * Choose `free`, `pro` or `business`. A paid plan needs a saved card.
    *
-   * An upgrade is charged at once on the saved card for the price difference over the rest of the month, then takes effect; the month's statement nets that payment out. A declined card leaves the plan unchanged. A downgrade takes effect when the month ends, and `next_plan` names it until then. A contract plan is changed by asking us.
+   * An upgrade is charged at once on the saved card, in its currency, for the price difference over the rest of the month, then takes effect; the month's statement nets that payment out. A declined card leaves the plan unchanged. A downgrade takes effect when the month ends, and `next_plan` names it until then. A contract plan is changed by asking us.
    *
    */
   static setCurrentUserPlan<ThrowOnError extends boolean = false>(options: Options<SetCurrentUserPlanData, ThrowOnError>): RequestResult<SetCurrentUserPlanResponses, SetCurrentUserPlanErrors, ThrowOnError>;

package/dist/index.d.mts

@@ -8426,7 +8426,7 @@ type TopUp = {
    */
   id: string;
   /**
-   * What is charged, and what is credited once paid.
+   * What is credited once paid: charged in US dollars, or its equivalent in reais.
    */
   amount_usd: number;
   /**
@@ -8447,6 +8447,14 @@ type PaymentMethod = {
   last4: string;
   exp_month: number;
   exp_year: number;
+  /**
+   * What the card is charged in, from its issuing country.
+   */
+  currency: 'usd' | 'brl';
+  /**
+   * Units of `currency` per US dollar for a charge made now: 1 for `usd`, the Banco Central's latest closing PTAX selling rate for `brl`. `null` while that rate cannot be read.
+   */
+  exchange_rate: number | null;
 };
 type PaymentMethodSetup = {
   /**
@@ -24168,7 +24176,7 @@ type CreateCurrentUserTopUpErrors = {
    */
   502: ErrorResponse;
   /**
-   * Card payments are not available on this deployment (`payments_not_configured`).
+   * Card payments are not available on this deployment (`payments_not_configured`), or the exchange rate for a card charged in reais could not be read (`exchange_rate_unavailable`). Nothing was charged.
    */
   503: ErrorResponse;
 };
@@ -24355,6 +24363,10 @@ type SetCurrentUserPlanErrors = {
    * The payment provider could not be reached (`payment_provider_error`).
    */
   502: ErrorResponse;
+  /**
+   * The exchange rate for a card charged in reais could not be read (`exchange_rate_unavailable`); the plan is unchanged.
+   */
+  503: ErrorResponse;
 };
 type SetCurrentUserPlanError = SetCurrentUserPlanErrors[keyof SetCurrentUserPlanErrors];
 type SetCurrentUserPlanResponses = {
@@ -27593,7 +27605,7 @@ export declare class Users {
   /**
    * Top up credit
    *
-   * Buys model credit for the caller's account. Once the card is charged the full amount is added to `credit_balance_usd` as purchased credit, which never expires. The card fee is not deducted. Charged in US dollars.
+   * Buys model credit for the caller's account. Once the card is charged the full amount is added to `credit_balance_usd` as purchased credit, which never expires. The card fee is not deducted. `amount_usd` is what is credited; a card issued in Brazil is charged its equivalent in Brazilian reais at the Banco Central's latest closing PTAX selling rate, and a checkout shows reais to a payer in Brazil.
    *
    * With `saved_card: true` the saved card is charged at once and the answer is `status: paid`. When the card needs authentication or is declined, nothing is charged and the answer falls back to a checkout.
    *
@@ -27610,7 +27622,7 @@ export declare class Users {
   /**
    * Get the saved card
    *
-   * The card auto-recharge and monthly statements are charged to, as the payment provider reports it. Only the brand, last four digits and expiry are kept here.
+   * The card auto-recharge and monthly statements are charged to, as the payment provider reports it. Only the brand, last four digits, expiry and issuing country are kept here. A card issued in Brazil is charged in Brazilian reais, every other card in US dollars.
    *
    */
   static getCurrentUserPaymentMethod<ThrowOnError extends boolean = false>(options?: Options<GetCurrentUserPaymentMethodData, ThrowOnError>): RequestResult<GetCurrentUserPaymentMethodResponses, GetCurrentUserPaymentMethodErrors, ThrowOnError>;
@@ -27647,7 +27659,7 @@ export declare class Users {
    *
    * Choose `free`, `pro` or `business`. A paid plan needs a saved card.
    *
-   * An upgrade is charged at once on the saved card for the price difference over the rest of the month, then takes effect; the month's statement nets that payment out. A declined card leaves the plan unchanged. A downgrade takes effect when the month ends, and `next_plan` names it until then. A contract plan is changed by asking us.
+   * An upgrade is charged at once on the saved card, in its currency, for the price difference over the rest of the month, then takes effect; the month's statement nets that payment out. A declined card leaves the plan unchanged. A downgrade takes effect when the month ends, and `next_plan` names it until then. A contract plan is changed by asking us.
    *
    */
   static setCurrentUserPlan<ThrowOnError extends boolean = false>(options: Options<SetCurrentUserPlanData, ThrowOnError>): RequestResult<SetCurrentUserPlanResponses, SetCurrentUserPlanErrors, ThrowOnError>;

package/dist/index.mjs

@@ -5429,7 +5429,7 @@ var Users = class {
 	/**
 	* Top up credit
 	*
-	* Buys model credit for the caller's account. Once the card is charged the full amount is added to `credit_balance_usd` as purchased credit, which never expires. The card fee is not deducted. Charged in US dollars.
+	* Buys model credit for the caller's account. Once the card is charged the full amount is added to `credit_balance_usd` as purchased credit, which never expires. The card fee is not deducted. `amount_usd` is what is credited; a card issued in Brazil is charged its equivalent in Brazilian reais at the Banco Central's latest closing PTAX selling rate, and a checkout shows reais to a payer in Brazil.
 	*
 	* With `saved_card: true` the saved card is charged at once and the answer is `status: paid`. When the card needs authentication or is declined, nothing is charged and the answer falls back to a checkout.
 	*
@@ -5460,7 +5460,7 @@ var Users = class {
 	/**
 	* Get the saved card
 	*
-	* The card auto-recharge and monthly statements are charged to, as the payment provider reports it. Only the brand, last four digits and expiry are kept here.
+	* The card auto-recharge and monthly statements are charged to, as the payment provider reports it. Only the brand, last four digits, expiry and issuing country are kept here. A card issued in Brazil is charged in Brazilian reais, every other card in US dollars.
 	*
 	*/
 	static getCurrentUserPaymentMethod(options) {
@@ -5526,7 +5526,7 @@ var Users = class {
 	*
 	* Choose `free`, `pro` or `business`. A paid plan needs a saved card.
 	*
-	* An upgrade is charged at once on the saved card for the price difference over the rest of the month, then takes effect; the month's statement nets that payment out. A declined card leaves the plan unchanged. A downgrade takes effect when the month ends, and `next_plan` names it until then. A contract plan is changed by asking us.
+	* An upgrade is charged at once on the saved card, in its currency, for the price difference over the rest of the month, then takes effect; the month's statement nets that payment out. A declined card leaves the plan unchanged. A downgrade takes effect when the month ends, and `next_plan` names it until then. A contract plan is changed by asking us.
 	*
 	*/
 	static setCurrentUserPlan(options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturali/sdk",
-  "version": "0.171.1",
+  "version": "0.173.0",
   "description": "TypeScript SDK for the naturali.ai API, generated from its OpenAPI specs",
   "type": "module",
   "sideEffects": false,
@@ -31,7 +31,7 @@
   },
   "devDependencies": {
     "@hey-api/openapi-ts": "^0.99.0",
-    "@naturali/api": "0.171.1",
+    "@naturali/api": "0.173.0",
     "@ttoss/openapi-codegen": "^0.5.0",
     "@types/node": "^26.5.1",
     "tsdown": "^0.23.0",