diff --git a/fern/openapi.json b/fern/openapi.json index 49c4847b..33210125 100644 --- a/fern/openapi.json +++ b/fern/openapi.json @@ -107,7 +107,7 @@ "type": "string", "pattern": "^\\s*0x[a-fA-F0-9]{40}(\\s*,\\s*0x[a-fA-F0-9]{40})*\\s*$" }, - "description": "The wallet address to receive the specified trading fees (supports single or multiple comma-separated values). You must also specify the `swapFeeBps` in the request to use this feature. When multiple values are provided, must match length of `swapFeeBps`." + "description": "The wallet address to receive the specified trading fees (supports single or multiple comma-separated values). You must also specify `swapFeeBps` or `swapFeePpm` in the request to use this feature. When multiple values are provided, must match the length of `swapFeeBps` or `swapFeePpm`." }, { "name": "swapFeeBps", @@ -119,6 +119,16 @@ }, "description": "The amount in Bps of the `swapFeeToken` to charge and deliver to the `swapFeeRecipient` (supports single or multiple comma-separated values). You must also specify the `swapFeeRecipient` in the request to use this feature. For security, this field has a default limit of 1000 Bps. If your application requires a higher value, please reach out to us." }, + { + "name": "swapFeePpm", + "in": "query", + "required": false, + "schema": { + "type": "string", + "pattern": "^\\s*\\d+(\\s*,\\s*\\d+)*\\s*$" + }, + "description": "The amount in parts-per-million (PPM) of the `swapFeeToken` to charge and deliver to the `swapFeeRecipient` (supports single or multiple comma-separated values). Mutually exclusive with `swapFeeBps`. You must also specify the `swapFeeRecipient` in the request to use this feature. Each value must be an integer from 0 to 1000000. For security, this field has a default limit of 100000 PPM. If your application requires a higher value, please reach out to us. e.g. 5000 PPM = 50 BPS = 0.5%." + }, { "name": "swapFeeToken", "in": "query", @@ -127,7 +137,7 @@ "type": "string", "pattern": "^\\s*0x(?!0{40})[a-fA-F0-9]{40}(\\s*,\\s*0x(?!0{40})[a-fA-F0-9]{40})*\\s*$" }, - "description": "The contract address of the token to receive trading fees in (supports single or multiple comma-separated values). Each token must be set to the value of either the `buyToken` or the `sellToken`. If omitted, the fee token will be determined by 0x with preference to stablecoins and highly liquid assets. You must also specify the `swapFeeRecipient` and `swapFeeBps` to charge integrator fees. When multiple values are provided, must match length of `swapFeeBps`." + "description": "The contract address of the token to receive trading fees in (supports single or multiple comma-separated values). Each token must be set to the value of either the `buyToken` or the `sellToken`. If omitted, the fee token will be determined by 0x with preference to stablecoins and highly liquid assets. You must also specify the `swapFeeRecipient` and either `swapFeeBps` or `swapFeePpm` to charge integrator fees. When multiple values are provided, must match the length of `swapFeeBps` or `swapFeePpm`." }, { "name": "tradeSurplusRecipient", @@ -141,7 +151,14 @@ "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10000 }, - "description": "The maximum trade surplus (positive slippage) that can be collected in Bps of the buy amount. If not provided, defaults to 10000 (100%). Must be used together with `tradeSurplusRecipient`." + "description": "The maximum trade surplus (positive slippage) that can be collected in Bps of the buy amount. If not provided, defaults to 10000 (100%). Must be used together with `tradeSurplusRecipient`. Mutually exclusive with `tradeSurplusMaxPpm`." + }, + { + "name": "tradeSurplusMaxPpm", + "in": "query", + "required": false, + "schema": { "type": "integer", "minimum": 1, "maximum": 1000000 }, + "description": "The maximum trade surplus (positive slippage) that can be collected in parts-per-million (PPM) of the buy amount. Mutually exclusive with `tradeSurplusMaxBps`. If not provided, defaults to 1000000 (100%). Must be used together with `tradeSurplusRecipient`. e.g. 5000 PPM = 50 BPS = 0.5%." }, { "name": "gasPrice", @@ -1495,7 +1512,7 @@ "type": "string", "pattern": "^\\s*0x[a-fA-F0-9]{40}(\\s*,\\s*0x[a-fA-F0-9]{40})*\\s*$" }, - "description": "The wallet address to receive the specified trading fees (supports single or multiple comma-separated values). You must also specify the `swapFeeBps` in the request to use this feature. When multiple values are provided, must match length of `swapFeeBps`." + "description": "The wallet address to receive the specified trading fees (supports single or multiple comma-separated values). You must also specify `swapFeeBps` or `swapFeePpm` in the request to use this feature. When multiple values are provided, must match the length of `swapFeeBps` or `swapFeePpm`." }, { "name": "swapFeeBps", @@ -1507,6 +1524,16 @@ }, "description": "The amount in Bps of the `swapFeeToken` to charge and deliver to the `swapFeeRecipient` (supports single or multiple comma-separated values). You must also specify the `swapFeeRecipient` in the request to use this feature. For security, this field has a default limit of 1000 Bps. If your application requires a higher value, please reach out to us." }, + { + "name": "swapFeePpm", + "in": "query", + "required": false, + "schema": { + "type": "string", + "pattern": "^\\s*\\d+(\\s*,\\s*\\d+)*\\s*$" + }, + "description": "The amount in parts-per-million (PPM) of the `swapFeeToken` to charge and deliver to the `swapFeeRecipient` (supports single or multiple comma-separated values). Mutually exclusive with `swapFeeBps`. You must also specify the `swapFeeRecipient` in the request to use this feature. Each value must be an integer from 0 to 1000000. For security, this field has a default limit of 100000 PPM. If your application requires a higher value, please reach out to us. e.g. 5000 PPM = 50 BPS = 0.5%." + }, { "name": "swapFeeToken", "in": "query", @@ -1515,7 +1542,7 @@ "type": "string", "pattern": "^\\s*0x(?!0{40})[a-fA-F0-9]{40}(\\s*,\\s*0x(?!0{40})[a-fA-F0-9]{40})*\\s*$" }, - "description": "The contract address of the token to receive trading fees in (supports single or multiple comma-separated values). Each token must be set to the value of either the `buyToken` or the `sellToken`. If omitted, the fee token will be determined by 0x with preference to stablecoins and highly liquid assets. You must also specify the `swapFeeRecipient` and `swapFeeBps` to charge integrator fees. When multiple values are provided, must match length of `swapFeeBps`." + "description": "The contract address of the token to receive trading fees in (supports single or multiple comma-separated values). Each token must be set to the value of either the `buyToken` or the `sellToken`. If omitted, the fee token will be determined by 0x with preference to stablecoins and highly liquid assets. You must also specify the `swapFeeRecipient` and either `swapFeeBps` or `swapFeePpm` to charge integrator fees. When multiple values are provided, must match the length of `swapFeeBps` or `swapFeePpm`." }, { "name": "tradeSurplusRecipient", @@ -1529,7 +1556,14 @@ "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10000 }, - "description": "The maximum trade surplus (positive slippage) that can be collected in Bps of the buy amount. If not provided, defaults to 10000 (100%). Must be used together with `tradeSurplusRecipient`." + "description": "The maximum trade surplus (positive slippage) that can be collected in Bps of the buy amount. If not provided, defaults to 10000 (100%). Must be used together with `tradeSurplusRecipient`. Mutually exclusive with `tradeSurplusMaxPpm`." + }, + { + "name": "tradeSurplusMaxPpm", + "in": "query", + "required": false, + "schema": { "type": "integer", "minimum": 1, "maximum": 1000000 }, + "description": "The maximum trade surplus (positive slippage) that can be collected in parts-per-million (PPM) of the buy amount. Mutually exclusive with `tradeSurplusMaxBps`. If not provided, defaults to 1000000 (100%). Must be used together with `tradeSurplusRecipient`. e.g. 5000 PPM = 50 BPS = 0.5%." }, { "name": "gasPrice", @@ -2952,7 +2986,7 @@ "type": "string", "pattern": "^\\s*0x[a-fA-F0-9]{40}(\\s*,\\s*0x[a-fA-F0-9]{40})*\\s*$" }, - "description": "The wallet address to receive the specified trading fees (supports single or multiple comma-separated values). You must also specify the `swapFeeBps` in the request to use this feature. When multiple values are provided, must match length of `swapFeeBps`." + "description": "The wallet address to receive the specified trading fees (supports single or multiple comma-separated values). You must also specify `swapFeeBps` or `swapFeePpm` in the request to use this feature. When multiple values are provided, must match the length of `swapFeeBps` or `swapFeePpm`." }, { "name": "swapFeeBps", @@ -2964,6 +2998,16 @@ }, "description": "The amount in Bps of the `swapFeeToken` to charge and deliver to the `swapFeeRecipient` (supports single or multiple comma-separated values). You must also specify the `swapFeeRecipient` in the request to use this feature. For security, this field has a default limit of 1000 Bps. If your application requires a higher value, please reach out to us." }, + { + "name": "swapFeePpm", + "in": "query", + "required": false, + "schema": { + "type": "string", + "pattern": "^\\s*\\d+(\\s*,\\s*\\d+)*\\s*$" + }, + "description": "The amount in parts-per-million (PPM) of the `swapFeeToken` to charge and deliver to the `swapFeeRecipient` (supports single or multiple comma-separated values). Mutually exclusive with `swapFeeBps`. You must also specify the `swapFeeRecipient` in the request to use this feature. Each value must be an integer from 0 to 1000000. For security, this field has a default limit of 100000 PPM. If your application requires a higher value, please reach out to us. e.g. 5000 PPM = 50 BPS = 0.5%." + }, { "name": "swapFeeToken", "in": "query", @@ -2972,7 +3016,7 @@ "type": "string", "pattern": "^\\s*0x(?!0{40})[a-fA-F0-9]{40}(\\s*,\\s*0x(?!0{40})[a-fA-F0-9]{40})*\\s*$" }, - "description": "The contract address of the token to receive trading fees in (supports single or multiple comma-separated values). Each token must be set to the value of either the `buyToken` or the `sellToken`. If omitted, the fee token will be determined by 0x with preference to stablecoins and highly liquid assets. You must also specify the `swapFeeRecipient` and `swapFeeBps` to charge integrator fees. When multiple values are provided, must match length of `swapFeeBps`." + "description": "The contract address of the token to receive trading fees in (supports single or multiple comma-separated values). Each token must be set to the value of either the `buyToken` or the `sellToken`. If omitted, the fee token will be determined by 0x with preference to stablecoins and highly liquid assets. You must also specify the `swapFeeRecipient` and either `swapFeeBps` or `swapFeePpm` to charge integrator fees. When multiple values are provided, must match the length of `swapFeeBps` or `swapFeePpm`." }, { "name": "tradeSurplusRecipient", @@ -2986,7 +3030,14 @@ "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10000 }, - "description": "The maximum trade surplus (positive slippage) that can be collected in Bps of the buy amount. If not provided, defaults to 10000 (100%). Must be used together with `tradeSurplusRecipient`." + "description": "The maximum trade surplus (positive slippage) that can be collected in Bps of the buy amount. If not provided, defaults to 10000 (100%). Must be used together with `tradeSurplusRecipient`. Mutually exclusive with `tradeSurplusMaxPpm`." + }, + { + "name": "tradeSurplusMaxPpm", + "in": "query", + "required": false, + "schema": { "type": "integer", "minimum": 1, "maximum": 1000000 }, + "description": "The maximum trade surplus (positive slippage) that can be collected in parts-per-million (PPM) of the buy amount. Mutually exclusive with `tradeSurplusMaxBps`. If not provided, defaults to 1000000 (100%). Must be used together with `tradeSurplusRecipient`. e.g. 5000 PPM = 50 BPS = 0.5%." }, { "name": "gasPrice", @@ -4340,7 +4391,7 @@ "type": "string", "pattern": "^\\s*0x[a-fA-F0-9]{40}(\\s*,\\s*0x[a-fA-F0-9]{40})*\\s*$" }, - "description": "The wallet address to receive the specified trading fees (supports single or multiple comma-separated values). You must also specify the `swapFeeBps` in the request to use this feature. When multiple values are provided, must match length of `swapFeeBps`." + "description": "The wallet address to receive the specified trading fees (supports single or multiple comma-separated values). You must also specify `swapFeeBps` or `swapFeePpm` in the request to use this feature. When multiple values are provided, must match the length of `swapFeeBps` or `swapFeePpm`." }, { "name": "swapFeeBps", @@ -4352,6 +4403,16 @@ }, "description": "The amount in Bps of the `swapFeeToken` to charge and deliver to the `swapFeeRecipient` (supports single or multiple comma-separated values). You must also specify the `swapFeeRecipient` in the request to use this feature. For security, this field has a default limit of 1000 Bps. If your application requires a higher value, please reach out to us." }, + { + "name": "swapFeePpm", + "in": "query", + "required": false, + "schema": { + "type": "string", + "pattern": "^\\s*\\d+(\\s*,\\s*\\d+)*\\s*$" + }, + "description": "The amount in parts-per-million (PPM) of the `swapFeeToken` to charge and deliver to the `swapFeeRecipient` (supports single or multiple comma-separated values). Mutually exclusive with `swapFeeBps`. You must also specify the `swapFeeRecipient` in the request to use this feature. Each value must be an integer from 0 to 1000000. For security, this field has a default limit of 100000 PPM. If your application requires a higher value, please reach out to us. e.g. 5000 PPM = 50 BPS = 0.5%." + }, { "name": "swapFeeToken", "in": "query", @@ -4360,7 +4421,7 @@ "type": "string", "pattern": "^\\s*0x(?!0{40})[a-fA-F0-9]{40}(\\s*,\\s*0x(?!0{40})[a-fA-F0-9]{40})*\\s*$" }, - "description": "The contract address of the token to receive trading fees in (supports single or multiple comma-separated values). Each token must be set to the value of either the `buyToken` or the `sellToken`. If omitted, the fee token will be determined by 0x with preference to stablecoins and highly liquid assets. You must also specify the `swapFeeRecipient` and `swapFeeBps` to charge integrator fees. When multiple values are provided, must match length of `swapFeeBps`." + "description": "The contract address of the token to receive trading fees in (supports single or multiple comma-separated values). Each token must be set to the value of either the `buyToken` or the `sellToken`. If omitted, the fee token will be determined by 0x with preference to stablecoins and highly liquid assets. You must also specify the `swapFeeRecipient` and either `swapFeeBps` or `swapFeePpm` to charge integrator fees. When multiple values are provided, must match the length of `swapFeeBps` or `swapFeePpm`." }, { "name": "tradeSurplusRecipient", @@ -4374,7 +4435,14 @@ "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10000 }, - "description": "The maximum trade surplus (positive slippage) that can be collected in Bps of the buy amount. If not provided, defaults to 10000 (100%). Must be used together with `tradeSurplusRecipient`." + "description": "The maximum trade surplus (positive slippage) that can be collected in Bps of the buy amount. If not provided, defaults to 10000 (100%). Must be used together with `tradeSurplusRecipient`. Mutually exclusive with `tradeSurplusMaxPpm`." + }, + { + "name": "tradeSurplusMaxPpm", + "in": "query", + "required": false, + "schema": { "type": "integer", "minimum": 1, "maximum": 1000000 }, + "description": "The maximum trade surplus (positive slippage) that can be collected in parts-per-million (PPM) of the buy amount. Mutually exclusive with `tradeSurplusMaxBps`. If not provided, defaults to 1000000 (100%). Must be used together with `tradeSurplusRecipient`. e.g. 5000 PPM = 50 BPS = 0.5%." }, { "name": "gasPrice", @@ -6072,7 +6140,7 @@ "type": "string", "pattern": "^\\s*0x[a-fA-F0-9]{40}(\\s*,\\s*0x[a-fA-F0-9]{40})*\\s*$" }, - "description": "The wallet address to receive the specified trading fees (supports single or multiple comma-separated values). You must also specify the `swapFeeBps` in the request to use this feature. When multiple values are provided, must match length of `swapFeeBps`." + "description": "The wallet address to receive the specified trading fees (supports single or multiple comma-separated values). You must also specify `swapFeeBps` or `swapFeePpm` in the request to use this feature. When multiple values are provided, must match the length of `swapFeeBps` or `swapFeePpm`." }, { "name": "swapFeeBps", @@ -6084,6 +6152,16 @@ }, "description": "The amount in Bps of the `swapFeeToken` to charge and deliver to the `swapFeeRecipient` (supports single or multiple comma-separated values). You must also specify the `swapFeeRecipient` in the request to use this feature. For security, this field has a default limit of 1000 Bps. If your application requires a higher value, please reach out to us." }, + { + "name": "swapFeePpm", + "in": "query", + "required": false, + "schema": { + "type": "string", + "pattern": "^\\s*\\d+(\\s*,\\s*\\d+)*\\s*$" + }, + "description": "The amount in parts-per-million (PPM) of the `swapFeeToken` to charge and deliver to the `swapFeeRecipient` (supports single or multiple comma-separated values). Mutually exclusive with `swapFeeBps`. You must also specify the `swapFeeRecipient` in the request to use this feature. Each value must be an integer from 0 to 1000000. For security, this field has a default limit of 100000 PPM. If your application requires a higher value, please reach out to us. e.g. 5000 PPM = 50 BPS = 0.5%." + }, { "name": "swapFeeToken", "in": "query", @@ -6092,7 +6170,7 @@ "type": "string", "pattern": "^\\s*0x(?!0{40})[a-fA-F0-9]{40}(\\s*,\\s*0x(?!0{40})[a-fA-F0-9]{40})*\\s*$" }, - "description": "The contract address of the token to receive trading fees in (supports single or multiple comma-separated values). Each token must be set to the value of either the `buyToken` or the `sellToken`. If omitted, the fee token will be determined by 0x with preference to stablecoins and highly liquid assets. You must also specify the `swapFeeRecipient` and `swapFeeBps` to charge integrator fees. When multiple values are provided, must match length of `swapFeeBps`." + "description": "The contract address of the token to receive trading fees in (supports single or multiple comma-separated values). Each token must be set to the value of either the `buyToken` or the `sellToken`. If omitted, the fee token will be determined by 0x with preference to stablecoins and highly liquid assets. You must also specify the `swapFeeRecipient` and either `swapFeeBps` or `swapFeePpm` to charge integrator fees. When multiple values are provided, must match the length of `swapFeeBps` or `swapFeePpm`." }, { "name": "tradeSurplusRecipient", @@ -6106,7 +6184,14 @@ "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10000 }, - "description": "The maximum trade surplus (positive slippage) that can be collected in Bps of the buy amount. If not provided, defaults to 10000 (100%). Must be used together with `tradeSurplusRecipient`." + "description": "The maximum trade surplus (positive slippage) that can be collected in Bps of the buy amount. If not provided, defaults to 10000 (100%). Must be used together with `tradeSurplusRecipient`. Mutually exclusive with `tradeSurplusMaxPpm`." + }, + { + "name": "tradeSurplusMaxPpm", + "in": "query", + "required": false, + "schema": { "type": "integer", "minimum": 1, "maximum": 1000000 }, + "description": "The maximum trade surplus (positive slippage) that can be collected in parts-per-million (PPM) of the buy amount. Mutually exclusive with `tradeSurplusMaxBps`. If not provided, defaults to 1000000 (100%). Must be used together with `tradeSurplusRecipient`. e.g. 5000 PPM = 50 BPS = 0.5%." }, { "name": "slippageBps", @@ -6839,7 +6924,7 @@ "type": "string", "pattern": "^\\s*0x[a-fA-F0-9]{40}(\\s*,\\s*0x[a-fA-F0-9]{40})*\\s*$" }, - "description": "The wallet address to receive the specified trading fees (supports single or multiple comma-separated values). You must also specify the `swapFeeBps` in the request to use this feature. When multiple values are provided, must match length of `swapFeeBps`." + "description": "The wallet address to receive the specified trading fees (supports single or multiple comma-separated values). You must also specify `swapFeeBps` or `swapFeePpm` in the request to use this feature. When multiple values are provided, must match the length of `swapFeeBps` or `swapFeePpm`." }, { "name": "swapFeeBps", @@ -6851,6 +6936,16 @@ }, "description": "The amount in Bps of the `swapFeeToken` to charge and deliver to the `swapFeeRecipient` (supports single or multiple comma-separated values). You must also specify the `swapFeeRecipient` in the request to use this feature. For security, this field has a default limit of 1000 Bps. If your application requires a higher value, please reach out to us." }, + { + "name": "swapFeePpm", + "in": "query", + "required": false, + "schema": { + "type": "string", + "pattern": "^\\s*\\d+(\\s*,\\s*\\d+)*\\s*$" + }, + "description": "The amount in parts-per-million (PPM) of the `swapFeeToken` to charge and deliver to the `swapFeeRecipient` (supports single or multiple comma-separated values). Mutually exclusive with `swapFeeBps`. You must also specify the `swapFeeRecipient` in the request to use this feature. Each value must be an integer from 0 to 1000000. For security, this field has a default limit of 100000 PPM. If your application requires a higher value, please reach out to us. e.g. 5000 PPM = 50 BPS = 0.5%." + }, { "name": "swapFeeToken", "in": "query", @@ -6859,7 +6954,7 @@ "type": "string", "pattern": "^\\s*0x(?!0{40})[a-fA-F0-9]{40}(\\s*,\\s*0x(?!0{40})[a-fA-F0-9]{40})*\\s*$" }, - "description": "The contract address of the token to receive trading fees in (supports single or multiple comma-separated values). Each token must be set to the value of either the `buyToken` or the `sellToken`. If omitted, the fee token will be determined by 0x with preference to stablecoins and highly liquid assets. You must also specify the `swapFeeRecipient` and `swapFeeBps` to charge integrator fees. When multiple values are provided, must match length of `swapFeeBps`." + "description": "The contract address of the token to receive trading fees in (supports single or multiple comma-separated values). Each token must be set to the value of either the `buyToken` or the `sellToken`. If omitted, the fee token will be determined by 0x with preference to stablecoins and highly liquid assets. You must also specify the `swapFeeRecipient` and either `swapFeeBps` or `swapFeePpm` to charge integrator fees. When multiple values are provided, must match the length of `swapFeeBps` or `swapFeePpm`." }, { "name": "tradeSurplusRecipient", @@ -6873,7 +6968,14 @@ "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10000 }, - "description": "The maximum trade surplus (positive slippage) that can be collected in Bps of the buy amount. If not provided, defaults to 10000 (100%). Must be used together with `tradeSurplusRecipient`." + "description": "The maximum trade surplus (positive slippage) that can be collected in Bps of the buy amount. If not provided, defaults to 10000 (100%). Must be used together with `tradeSurplusRecipient`. Mutually exclusive with `tradeSurplusMaxPpm`." + }, + { + "name": "tradeSurplusMaxPpm", + "in": "query", + "required": false, + "schema": { "type": "integer", "minimum": 1, "maximum": 1000000 }, + "description": "The maximum trade surplus (positive slippage) that can be collected in parts-per-million (PPM) of the buy amount. Mutually exclusive with `tradeSurplusMaxBps`. If not provided, defaults to 1000000 (100%). Must be used together with `tradeSurplusRecipient`. e.g. 5000 PPM = 50 BPS = 0.5%." }, { "name": "slippageBps",