@swapkit/api-sdk-typescript 1.0.3 → 1.1.0-nightly.20260701161042

package/src/index.ts

@@ -14,33 +14,33 @@ export * from "./sdk";
 // ---------------------------------------------------------------------------
 
 import {
+  createBrokerChannel,
+  executeSwap,
+  getCachedPrice,
+  getGasHistory,
+  getGasPrices,
   getProviders,
+  getQuote,
+  getSwapFromAssets,
+  getSwapToAssets,
   getTokens,
-  getSwapTo,
-  getSwapFrom,
-  postV3Quote,
-  postV3Swap,
-  postTrack,
-  postScreen,
-  getGas,
-  getGasHistory,
-  postPriceCachedPrice,
-  postChainflipBrokerChannel,
+  screenAddress,
+  trackTransaction,
 } from "./sdk";
 
 export class SwapKitService {
   static getProviders = getProviders;
   static getTokens = getTokens;
-  static getSwapTo = getSwapTo;
-  static getSwapFrom = getSwapFrom;
-  static getQuote = postV3Quote;
-  static getSwap = postV3Swap;
-  static trackTransaction = postTrack;
-  static screenAddress = postScreen;
-  static getGasPrices = getGas;
+  static getSwapTo = getSwapToAssets;
+  static getSwapFrom = getSwapFromAssets;
+  static getQuote = getQuote;
+  static getSwap = executeSwap;
+  static trackTransaction = trackTransaction;
+  static screenAddress = screenAddress;
+  static getGasPrices = getGasPrices;
   static getGasHistory = getGasHistory;
-  static getCachedPrice = postPriceCachedPrice;
-  static createBrokerChannel = postChainflipBrokerChannel;
+  static getCachedPrice = getCachedPrice;
+  static createBrokerChannel = createBrokerChannel;
 }
 
 // ---------------------------------------------------------------------------
@@ -51,42 +51,42 @@ export class SwapKitService {
 export const TokenlistService = {
   getProviders,
   getTokens,
-  getSwapTo,
-  getSwapFrom,
+  getSwapTo: getSwapToAssets,
+  getSwapFrom: getSwapFromAssets,
 } as const;
 
 /** @deprecated Use `SwapKitService` instead */
 export const QuoteService = {
-  getQuote: postV3Quote,
+  getQuote,
 } as const;
 
 /** @deprecated Use `SwapKitService` instead */
 export const SwapService = {
-  getSwap: postV3Swap,
+  getSwap: executeSwap,
 } as const;
 
 /** @deprecated Use `SwapKitService` instead */
 export const TrackService = {
-  trackTransaction: postTrack,
+  trackTransaction,
 } as const;
 
 /** @deprecated Use `SwapKitService` instead */
 export const ScreenService = {
-  screenAddress: postScreen,
+  screenAddress,
 } as const;
 
 /** @deprecated Use `SwapKitService` instead */
 export const GasService = {
-  getGasPrices: getGas,
+  getGasPrices,
   getGasHistory,
 } as const;
 
 /** @deprecated Use `SwapKitService` instead */
 export const PriceService = {
-  getCachedPrice: postPriceCachedPrice,
+  getCachedPrice,
 } as const;
 
 /** @deprecated Use `SwapKitService` instead */
 export const ChainflipService = {
-  createBrokerChannel: postChainflipBrokerChannel,
+  createBrokerChannel,
 } as const;

package/src/sdk.ts

@@ -1,10 +1,10 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-import type { Client, Options as Options2, TDataShape } from './http';
+import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './http';
 import { client } from './client';
-import type { GetGasData, GetGasHistoryData, GetGasHistoryResponses, GetGasResponses, GetProvidersData, GetProvidersErrors, GetProvidersResponses, GetSwapFromData, GetSwapFromErrors, GetSwapFromResponses, GetSwapToData, GetSwapToErrors, GetSwapToResponses, GetTokensData, GetTokensErrors, GetTokensResponses, PostChainflipBrokerChannelData, PostChainflipBrokerChannelResponses, PostPriceCachedPriceData, PostPriceCachedPriceResponses, PostScreenData, PostScreenErrors, PostScreenResponses, PostTrackData, PostTrackResponses, PostV3QuoteData, PostV3QuoteErrors, PostV3QuoteResponses, PostV3SwapData, PostV3SwapErrors, PostV3SwapResponses } from './types';
+import type { CreateBrokerChannelData, CreateBrokerChannelResponses, ExecuteSwapData, ExecuteSwapErrors, ExecuteSwapResponses, GetCachedPriceData, GetCachedPriceResponses, GetGasHistoryData, GetGasHistoryResponses, GetGasPricesData, GetGasPricesResponses, GetProvidersData, GetProvidersErrors, GetProvidersResponses, GetQuoteData, GetQuoteErrors, GetQuoteResponses, GetSwapFromAssetsData, GetSwapFromAssetsErrors, GetSwapFromAssetsResponses, GetSwapToAssetsData, GetSwapToAssetsErrors, GetSwapToAssetsResponses, GetTokensData, GetTokensErrors, GetTokensResponses, ScreenAddressData, ScreenAddressErrors, ScreenAddressResponses, TrackTransactionData, TrackTransactionErrors, TrackTransactionResponses } from './types';
 
-export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
      * individual options. This might be also useful if you want to implement a
@@ -15,34 +15,34 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
      * You can pass arbitrary values through the `meta` object. This can be
      * used to access values that aren't defined as part of the SDK function.
      */
-    meta?: Record<string, unknown>;
+    meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
 };
 
-export const getProviders = <ThrowOnError extends boolean = false>(options?: Options<GetProvidersData, ThrowOnError>) => (options?.client ?? client).get<GetProvidersResponses, GetProvidersErrors, ThrowOnError>({
+export const getProviders = <ThrowOnError extends boolean = false>(options?: Options<GetProvidersData, ThrowOnError>): RequestResult<GetProvidersResponses, GetProvidersErrors, ThrowOnError> => (options?.client ?? client).get<GetProvidersResponses, GetProvidersErrors, ThrowOnError>({
     security: [{ name: 'x-api-key', type: 'apiKey' }],
     url: '/providers',
     ...options
 });
 
-export const getTokens = <ThrowOnError extends boolean = false>(options?: Options<GetTokensData, ThrowOnError>) => (options?.client ?? client).get<GetTokensResponses, GetTokensErrors, ThrowOnError>({
+export const getTokens = <ThrowOnError extends boolean = false>(options?: Options<GetTokensData, ThrowOnError>): RequestResult<GetTokensResponses, GetTokensErrors, ThrowOnError> => (options?.client ?? client).get<GetTokensResponses, GetTokensErrors, ThrowOnError>({
     security: [{ name: 'x-api-key', type: 'apiKey' }],
     url: '/tokens',
     ...options
 });
 
-export const getSwapTo = <ThrowOnError extends boolean = false>(options: Options<GetSwapToData, ThrowOnError>) => (options.client ?? client).get<GetSwapToResponses, GetSwapToErrors, ThrowOnError>({
+export const getSwapToAssets = <ThrowOnError extends boolean = false>(options: Options<GetSwapToAssetsData, ThrowOnError>): RequestResult<GetSwapToAssetsResponses, GetSwapToAssetsErrors, ThrowOnError> => (options.client ?? client).get<GetSwapToAssetsResponses, GetSwapToAssetsErrors, ThrowOnError>({
     security: [{ name: 'x-api-key', type: 'apiKey' }],
     url: '/swapTo',
     ...options
 });
 
-export const getSwapFrom = <ThrowOnError extends boolean = false>(options: Options<GetSwapFromData, ThrowOnError>) => (options.client ?? client).get<GetSwapFromResponses, GetSwapFromErrors, ThrowOnError>({
+export const getSwapFromAssets = <ThrowOnError extends boolean = false>(options: Options<GetSwapFromAssetsData, ThrowOnError>): RequestResult<GetSwapFromAssetsResponses, GetSwapFromAssetsErrors, ThrowOnError> => (options.client ?? client).get<GetSwapFromAssetsResponses, GetSwapFromAssetsErrors, ThrowOnError>({
     security: [{ name: 'x-api-key', type: 'apiKey' }],
     url: '/swapFrom',
     ...options
 });
 
-export const postChainflipBrokerChannel = <ThrowOnError extends boolean = false>(options: Options<PostChainflipBrokerChannelData, ThrowOnError>) => (options.client ?? client).post<PostChainflipBrokerChannelResponses, unknown, ThrowOnError>({
+export const createBrokerChannel = <ThrowOnError extends boolean = false>(options: Options<CreateBrokerChannelData, ThrowOnError>): RequestResult<CreateBrokerChannelResponses, unknown, ThrowOnError> => (options.client ?? client).post<CreateBrokerChannelResponses, unknown, ThrowOnError>({
     security: [{ name: 'x-api-key', type: 'apiKey' }],
     url: '/chainflip/broker/channel',
     ...options,
@@ -52,7 +52,7 @@ export const postChainflipBrokerChannel = <ThrowOnError extends boolean = false>
     }
 });
 
-export const postTrack = <ThrowOnError extends boolean = false>(options?: Options<PostTrackData, ThrowOnError>) => (options?.client ?? client).post<PostTrackResponses, unknown, ThrowOnError>({
+export const trackTransaction = <ThrowOnError extends boolean = false>(options?: Options<TrackTransactionData, ThrowOnError>): RequestResult<TrackTransactionResponses, TrackTransactionErrors, ThrowOnError> => (options?.client ?? client).post<TrackTransactionResponses, TrackTransactionErrors, ThrowOnError>({
     security: [{ name: 'x-api-key', type: 'apiKey' }],
     url: '/track',
     ...options,
@@ -62,7 +62,7 @@ export const postTrack = <ThrowOnError extends boolean = false>(options?: Option
     }
 });
 
-export const postScreen = <ThrowOnError extends boolean = false>(options: Options<PostScreenData, ThrowOnError>) => (options.client ?? client).post<PostScreenResponses, PostScreenErrors, ThrowOnError>({
+export const screenAddress = <ThrowOnError extends boolean = false>(options: Options<ScreenAddressData, ThrowOnError>): RequestResult<ScreenAddressResponses, ScreenAddressErrors, ThrowOnError> => (options.client ?? client).post<ScreenAddressResponses, ScreenAddressErrors, ThrowOnError>({
     security: [{ name: 'x-api-key', type: 'apiKey' }],
     url: '/screen',
     ...options,
@@ -72,19 +72,19 @@ export const postScreen = <ThrowOnError extends boolean = false>(options: Option
     }
 });
 
-export const getGasHistory = <ThrowOnError extends boolean = false>(options?: Options<GetGasHistoryData, ThrowOnError>) => (options?.client ?? client).get<GetGasHistoryResponses, unknown, ThrowOnError>({
+export const getGasPrices = <ThrowOnError extends boolean = false>(options?: Options<GetGasPricesData, ThrowOnError>): RequestResult<GetGasPricesResponses, unknown, ThrowOnError> => (options?.client ?? client).get<GetGasPricesResponses, unknown, ThrowOnError>({
     security: [{ name: 'x-api-key', type: 'apiKey' }],
-    url: '/gas/history',
+    url: '/gas',
     ...options
 });
 
-export const getGas = <ThrowOnError extends boolean = false>(options?: Options<GetGasData, ThrowOnError>) => (options?.client ?? client).get<GetGasResponses, unknown, ThrowOnError>({
+export const getGasHistory = <ThrowOnError extends boolean = false>(options?: Options<GetGasHistoryData, ThrowOnError>): RequestResult<GetGasHistoryResponses, unknown, ThrowOnError> => (options?.client ?? client).get<GetGasHistoryResponses, unknown, ThrowOnError>({
     security: [{ name: 'x-api-key', type: 'apiKey' }],
-    url: '/gas',
+    url: '/gas/history',
     ...options
 });
 
-export const postPriceCachedPrice = <ThrowOnError extends boolean = false>(options: Options<PostPriceCachedPriceData, ThrowOnError>) => (options.client ?? client).post<PostPriceCachedPriceResponses, unknown, ThrowOnError>({
+export const getCachedPrice = <ThrowOnError extends boolean = false>(options: Options<GetCachedPriceData, ThrowOnError>): RequestResult<GetCachedPriceResponses, unknown, ThrowOnError> => (options.client ?? client).post<GetCachedPriceResponses, unknown, ThrowOnError>({
     security: [{ name: 'x-api-key', type: 'apiKey' }],
     url: '/price/cached-price',
     ...options,
@@ -94,7 +94,7 @@ export const postPriceCachedPrice = <ThrowOnError extends boolean = false>(optio
     }
 });
 
-export const postV3Quote = <ThrowOnError extends boolean = false>(options: Options<PostV3QuoteData, ThrowOnError>) => (options.client ?? client).post<PostV3QuoteResponses, PostV3QuoteErrors, ThrowOnError>({
+export const getQuote = <ThrowOnError extends boolean = false>(options: Options<GetQuoteData, ThrowOnError>): RequestResult<GetQuoteResponses, GetQuoteErrors, ThrowOnError> => (options.client ?? client).post<GetQuoteResponses, GetQuoteErrors, ThrowOnError>({
     security: [{ name: 'x-api-key', type: 'apiKey' }],
     url: '/v3/quote',
     ...options,
@@ -104,7 +104,7 @@ export const postV3Quote = <ThrowOnError extends boolean = false>(options: Optio
     }
 });
 
-export const postV3Swap = <ThrowOnError extends boolean = false>(options: Options<PostV3SwapData, ThrowOnError>) => (options.client ?? client).post<PostV3SwapResponses, PostV3SwapErrors, ThrowOnError>({
+export const executeSwap = <ThrowOnError extends boolean = false>(options: Options<ExecuteSwapData, ThrowOnError>): RequestResult<ExecuteSwapResponses, ExecuteSwapErrors, ThrowOnError> => (options.client ?? client).post<ExecuteSwapResponses, ExecuteSwapErrors, ThrowOnError>({
     security: [{ name: 'x-api-key', type: 'apiKey' }],
     url: '/v3/swap',
     ...options,