@polymarket/client 0.1.0-beta.0 → 0.1.0-beta.10

package/dist/{sports-BDLhQVTP.d.ts → sports-BGrBawu_.d.ts}

@@ -1,5 +1,5 @@
 import { OrderResponse } from '@polymarket/bindings/clob';
-import { aI as RateLimitError, aK as RequestRejectedError, b2 as SigningError, b9 as TransportError, bc as UnexpectedResponseError, U as UserInputError, a6 as InsufficientLiquidityError, h as BaseSecureClient, d9 as PrepareLimitOrderRequest, c_ as OrderWorkflow, cZ as OrderPostingWorkflow, db as PrepareMarketOrderRequest, m as CancelledSigningError, aA as PostOrderError, b4 as TimeoutError, b5 as TransactionFailedError, dx as SignedOrder, B as BaseClient } from './types-D7tLX0ye.js';
+import { aR as RateLimitError, aT as RequestRejectedError, bz as SigningError, bG as TransportError, bJ as UnexpectedResponseError, U as UserInputError, a9 as InsufficientLiquidityError, h as BaseSecureClient, eD as PrepareLimitOrderRequest, eb as OrderWorkflow, ea as OrderPostingWorkflow, eF as PrepareMarketOrderRequest, m as CancelledSigningError, aI as PostOrderError, bB as TimeoutError, bC as TransactionFailedError, fi as SignedOrder, B as BaseClient } from './types-M1U0um0G.js';
 import { SportsMarketTypesResponse, SportsMetadata } from '@polymarket/bindings/gamma';
 
 type PrepareMarketOrderError = InsufficientLiquidityError | RateLimitError | RequestRejectedError | SigningError | TransportError | UnexpectedResponseError | UserInputError;
@@ -10,7 +10,7 @@ declare const PrepareMarketOrderError: {
  * Starts the market-order workflow.
  *
  * @remarks
- * This is a low-level action that most SDK consumers will not need.
+ * This is a low-level function. Most SDK consumers should prefer the client instance API.
  *
  * @throws {@link PrepareMarketOrderError}
  * Thrown on failure.
@@ -19,6 +19,7 @@ declare const PrepareMarketOrderError: {
  * ```ts
  * const workflow = await prepareMarketOrder(client, {
  *   amount: 10,
+ *   maxPrice: '0.55',
  *   side: OrderSide.BUY,
  *   tokenId: '123',
  * });
@@ -33,7 +34,7 @@ declare const PrepareLimitOrderError: {
  * Starts the limit-order workflow.
  *
  * @remarks
- * This is a low-level action that most SDK consumers will not need.
+ * This is a low-level function. Most SDK consumers should prefer the client instance API.
  *
  * @throws {@link PrepareLimitOrderError}
  * Thrown on failure.
@@ -58,7 +59,7 @@ declare const PrepareMarketOrderPostingError: {
  * Starts and posts a market-order workflow.
  *
  * @remarks
- * This is a low-level action that most SDK consumers will not need.
+ * This is a low-level function. Most SDK consumers should prefer the client instance API.
  *
  * @throws {@link PrepareMarketOrderPostingError}
  * Thrown on failure.
@@ -66,8 +67,9 @@ declare const PrepareMarketOrderPostingError: {
  * @example
  * ```ts
  * const workflow = await prepareMarketOrderPosting(client, {
- *   amount: 10,
- *   side: OrderSide.BUY,
+ *   minPrice: '0.54',
+ *   shares: 10,
+ *   side: OrderSide.SELL,
  *   tokenId: '123',
  * });
  * ```
@@ -81,7 +83,7 @@ declare const PrepareLimitOrderPostingError: {
  * Starts and posts a limit-order workflow.
  *
  * @remarks
- * This is a low-level action that most SDK consumers will not need.
+ * This is a low-level function. Most SDK consumers should prefer the client instance API.
  *
  * @throws {@link PrepareLimitOrderPostingError}
  * Thrown on failure.
@@ -106,8 +108,21 @@ declare const CreateMarketOrderError: {
 /**
  * Creates a signed market order for the authenticated account.
  *
+ * @remarks
+ * This is a low-level function. Most SDK consumers should prefer the client instance API.
+ *
  * @throws {@link CreateMarketOrderError}
  * Thrown on failure.
+ *
+ * @example
+ * ```ts
+ * const order = await createMarketOrder(client, {
+ *   amount: '100',
+ *   maxPrice: '0.55',
+ *   side: OrderSide.BUY,
+ *   tokenId: '123',
+ * });
+ * ```
  */
 declare function createMarketOrder(client: BaseSecureClient, request: PrepareMarketOrderRequest): Promise<SignedOrder>;
 type PlaceMarketOrderError = CreateMarketOrderError | PostOrderError | TimeoutError | TransactionFailedError;
@@ -117,8 +132,21 @@ declare const PlaceMarketOrderError: {
 /**
  * Creates and posts a market order for the authenticated account.
  *
+ * @remarks
+ * This is a low-level function. Most SDK consumers should prefer the client instance API.
+ *
  * @throws {@link PlaceMarketOrderError}
  * Thrown on failure.
+ *
+ * @example
+ * ```ts
+ * const response = await placeMarketOrder(client, {
+ *   minPrice: '0.54',
+ *   shares: '180',
+ *   side: OrderSide.SELL,
+ *   tokenId: '123',
+ * });
+ * ```
  */
 declare function placeMarketOrder(client: BaseSecureClient, request: PrepareMarketOrderRequest): Promise<OrderResponse>;
 type CreateLimitOrderError = PrepareLimitOrderError | CancelledSigningError;
@@ -128,6 +156,13 @@ declare const CreateLimitOrderError: {
 /**
  * Creates a signed limit order for the authenticated account.
  *
+ * @remarks
+ * This is a low-level function. Most SDK consumers should prefer the client instance API.
+ *
+ * GTD expirations must be at least 60 seconds in the future. Add your own
+ * buffer for network latency and clock skew when deriving an expiration from
+ * the current time.
+ *
  * @throws {@link CreateLimitOrderError}
  * Thrown on failure.
  */
@@ -139,6 +174,13 @@ declare const PlaceLimitOrderError: {
 /**
  * Creates and posts a limit order for the authenticated account.
  *
+ * @remarks
+ * This is a low-level function. Most SDK consumers should prefer the client instance API.
+ *
+ * GTD expirations must be at least 60 seconds in the future. Add your own
+ * buffer for network latency and clock skew when deriving an expiration from
+ * the current time.
+ *
  * @throws {@link PlaceLimitOrderError}
  * Thrown on failure.
  */
@@ -151,6 +193,9 @@ declare const ListSportsError: {
 /**
  * Lists available sports metadata.
  *
+ * @remarks
+ * This is a low-level function. Most SDK consumers should prefer the client instance API.
+ *
  * @throws {@link ListSportsError}
  * Thrown on failure.
  *
@@ -169,6 +214,9 @@ declare const FetchSportsMarketTypesError: {
 /**
  * Fetches the available market types grouped by sport.
  *
+ * @remarks
+ * This is a low-level function. Most SDK consumers should prefer the client instance API.
+ *
  * @throws {@link FetchSportsMarketTypesError}
  * Thrown on failure.
  *