npm - @sigrex/client - Versions diffs - 2.1.3 → 2.1.5 - Mend

@sigrex/client 2.1.3 → 2.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/README.md CHANGED Viewed

@@ -17,7 +17,17 @@ A fully-typed, isomorphic, zero-dependency TypeScript API client for the **Sigre
 ## Installation
 ```bash
+# npm
 npm install @sigrex/client
+# Deno
+deno add @sigrex/client
+```
+When using Deno, import directly from the JSR scope:
+```typescript
+import { SigrexClient } from "jsr:@sigrex/client";
 ```
 ---

package/dist/index.d.mts CHANGED Viewed

@@ -8009,10 +8009,15 @@ interface components {
              */
             api_id: number;
             /**
-             * @description The market url
+             * @description Set to true to specify a market slug dynamically within the signal payload.
+             * @example true
+             */
+            slug_from_signal: boolean;
+            /**
+             * @description The market url (required if slug_from_signal is false)
              * @example https://polymarket.com/event/elon-musk-of-tweets-april-21-april-28/elon-musk-of-tweets-april-21-april-28-180-199#xpkQ2pz
              */
-            url: string;
+            url?: string;
             /**
              * @description Set if amount is coming from signal
              * @example false
@@ -8051,10 +8056,15 @@ interface components {
              */
             api_id: number;
             /**
-             * @description The market url
+             * @description Set to true to specify a market slug dynamically within the signal payload.
+             * @example true
+             */
+            slug_from_signal: boolean;
+            /**
+             * @description The market url (required if slug_from_signal is false)
              * @example https://polymarket.com/event/elon-musk-of-tweets-april-21-april-28/elon-musk-of-tweets-april-21-april-28-180-199#xpkQ2pz
              */
-            url: string;
+            url?: string;
             /**
              * @description Set if amount is coming from signal
              * @example false
@@ -8185,15 +8195,20 @@ interface components {
              */
             folder_id?: number;
             /**
-             * @description The id of the bot hook where signal will be sent
+             * @description Set true to enable signal generation
+             * @example true
+             */
+            send_signal?: boolean;
+            /**
+             * @description The id of the bot hook where signal will be sent (required if send_signal is true)
              * @example 12
              */
-            webhook_id: number;
+            webhook_id?: number;
             /**
-             * @description The signal symbol or symbols of the strategy separated by comma
+             * @description The signal symbol or symbols of the strategy separated by comma (required if send_signal is true)
              * @example BTCUSDT,ETHUSDT
              */
-            symbol: string;
+            symbol?: string;
             /**
              * @description The JavaScript code of the strategy
              * @example (()=>{ $.Strategy.action($.Action.LONG); })();
@@ -8227,15 +8242,20 @@ interface components {
              */
             folder_id?: number;
             /**
-             * @description The id of the bot hook where signal will be sent
+             * @description Set true to enable signal generation
+             * @example true
+             */
+            send_signal?: boolean;
+            /**
+             * @description The id of the bot hook where signal will be sent (required if send_signal is true)
              * @example 12
              */
-            webhook_id: number;
+            webhook_id?: number;
             /**
-             * @description The signal symbol or symbols of the strategy separated by comma
+             * @description The signal symbol or symbols of the strategy separated by comma (required if send_signal is true)
              * @example BTCUSDT,ETHUSDT
              */
-            symbol: string;
+            symbol?: string;
             /**
              * @description The JavaScript code of the strategy
              * @example (()=>{ $.Strategy.action($.Action.LONG); })();
@@ -8463,21 +8483,26 @@ interface components {
              * @example 12
              */
             folder_id?: number;
-            /**
-             * @description The id of the bot hook where signal will be sent
-             * @example 12
-             */
-            webhook_id: number;
             /**
              * @description The id of the data hook witch will be used to get data
              * @example 13
              */
             data_webhook_id: number;
             /**
-             * @description The signal symbol or symbols of the strategy separated by comma
+             * @description Set true to enable signal generation
+             * @example true
+             */
+            send_signal?: boolean;
+            /**
+             * @description The id of the bot hook where signal will be sent (required if send_signal is true)
+             * @example 12
+             */
+            webhook_id?: number;
+            /**
+             * @description The signal symbol or symbols of the strategy separated by comma (required if send_signal is true)
              * @example BTCUSDT,ETHUSDT
              */
-            symbol: string;
+            symbol?: string;
             /**
              * @description Set how often the reaction will check for new signals. eg. 10 means 10 in 1 second
              * @example 10
@@ -8515,21 +8540,26 @@ interface components {
              * @example 12
              */
             folder_id?: number;
-            /**
-             * @description The id of the bot hook where signal will be sent
-             * @example 12
-             */
-            webhook_id: number;
             /**
              * @description The id of the data hook witch will be used to get data
              * @example 13
              */
             data_webhook_id: number;
             /**
-             * @description The signal symbol or symbols of the strategy separated by comma
+             * @description Set true to enable signal generation
+             * @example true
+             */
+            send_signal?: boolean;
+            /**
+             * @description The id of the bot hook where signal will be sent (required if send_signal is true)
+             * @example 12
+             */
+            webhook_id?: number;
+            /**
+             * @description The signal symbol or symbols of the strategy separated by comma (required if send_signal is true)
              * @example BTCUSDT,ETHUSDT
              */
-            symbol: string;
+            symbol?: string;
             /**
              * @description Set how often the reaction will check for new signals. eg. 10 means 10 in 1 second
              * @example 10

package/dist/index.d.ts CHANGED Viewed

@@ -8009,10 +8009,15 @@ interface components {
              */
             api_id: number;
             /**
-             * @description The market url
+             * @description Set to true to specify a market slug dynamically within the signal payload.
+             * @example true
+             */
+            slug_from_signal: boolean;
+            /**
+             * @description The market url (required if slug_from_signal is false)
              * @example https://polymarket.com/event/elon-musk-of-tweets-april-21-april-28/elon-musk-of-tweets-april-21-april-28-180-199#xpkQ2pz
              */
-            url: string;
+            url?: string;
             /**
              * @description Set if amount is coming from signal
              * @example false
@@ -8051,10 +8056,15 @@ interface components {
              */
             api_id: number;
             /**
-             * @description The market url
+             * @description Set to true to specify a market slug dynamically within the signal payload.
+             * @example true
+             */
+            slug_from_signal: boolean;
+            /**
+             * @description The market url (required if slug_from_signal is false)
              * @example https://polymarket.com/event/elon-musk-of-tweets-april-21-april-28/elon-musk-of-tweets-april-21-april-28-180-199#xpkQ2pz
              */
-            url: string;
+            url?: string;
             /**
              * @description Set if amount is coming from signal
              * @example false
@@ -8185,15 +8195,20 @@ interface components {
              */
             folder_id?: number;
             /**
-             * @description The id of the bot hook where signal will be sent
+             * @description Set true to enable signal generation
+             * @example true
+             */
+            send_signal?: boolean;
+            /**
+             * @description The id of the bot hook where signal will be sent (required if send_signal is true)
              * @example 12
              */
-            webhook_id: number;
+            webhook_id?: number;
             /**
-             * @description The signal symbol or symbols of the strategy separated by comma
+             * @description The signal symbol or symbols of the strategy separated by comma (required if send_signal is true)
              * @example BTCUSDT,ETHUSDT
              */
-            symbol: string;
+            symbol?: string;
             /**
              * @description The JavaScript code of the strategy
              * @example (()=>{ $.Strategy.action($.Action.LONG); })();
@@ -8227,15 +8242,20 @@ interface components {
              */
             folder_id?: number;
             /**
-             * @description The id of the bot hook where signal will be sent
+             * @description Set true to enable signal generation
+             * @example true
+             */
+            send_signal?: boolean;
+            /**
+             * @description The id of the bot hook where signal will be sent (required if send_signal is true)
              * @example 12
              */
-            webhook_id: number;
+            webhook_id?: number;
             /**
-             * @description The signal symbol or symbols of the strategy separated by comma
+             * @description The signal symbol or symbols of the strategy separated by comma (required if send_signal is true)
              * @example BTCUSDT,ETHUSDT
              */
-            symbol: string;
+            symbol?: string;
             /**
              * @description The JavaScript code of the strategy
              * @example (()=>{ $.Strategy.action($.Action.LONG); })();
@@ -8463,21 +8483,26 @@ interface components {
              * @example 12
              */
             folder_id?: number;
-            /**
-             * @description The id of the bot hook where signal will be sent
-             * @example 12
-             */
-            webhook_id: number;
             /**
              * @description The id of the data hook witch will be used to get data
              * @example 13
              */
             data_webhook_id: number;
             /**
-             * @description The signal symbol or symbols of the strategy separated by comma
+             * @description Set true to enable signal generation
+             * @example true
+             */
+            send_signal?: boolean;
+            /**
+             * @description The id of the bot hook where signal will be sent (required if send_signal is true)
+             * @example 12
+             */
+            webhook_id?: number;
+            /**
+             * @description The signal symbol or symbols of the strategy separated by comma (required if send_signal is true)
              * @example BTCUSDT,ETHUSDT
              */
-            symbol: string;
+            symbol?: string;
             /**
              * @description Set how often the reaction will check for new signals. eg. 10 means 10 in 1 second
              * @example 10
@@ -8515,21 +8540,26 @@ interface components {
              * @example 12
              */
             folder_id?: number;
-            /**
-             * @description The id of the bot hook where signal will be sent
-             * @example 12
-             */
-            webhook_id: number;
             /**
              * @description The id of the data hook witch will be used to get data
              * @example 13
              */
             data_webhook_id: number;
             /**
-             * @description The signal symbol or symbols of the strategy separated by comma
+             * @description Set true to enable signal generation
+             * @example true
+             */
+            send_signal?: boolean;
+            /**
+             * @description The id of the bot hook where signal will be sent (required if send_signal is true)
+             * @example 12
+             */
+            webhook_id?: number;
+            /**
+             * @description The signal symbol or symbols of the strategy separated by comma (required if send_signal is true)
              * @example BTCUSDT,ETHUSDT
              */
-            symbol: string;
+            symbol?: string;
             /**
              * @description Set how often the reaction will check for new signals. eg. 10 means 10 in 1 second
              * @example 10

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@sigrex/client",
-  "version": "2.1.3",
+  "version": "2.1.5",
   "description": "TypeScript API Client for Sigrex with automatic HMAC-SHA256 request signing and support for ML-DSA44",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",