wapi-client 0.7.2 → 0.8.2

package/dist/txs/tx-consts.schema.json

@@ -0,0 +1,382 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "TxConsts",
+  "description": "Generics used by functions",
+  "definitions": {
+    "i_tx_general_options_without_tx": {
+      "description": "Generic flags for input",
+      "type": "object",
+      "default": {},
+      "properties": {
+        "tracking_id": {
+          "description": "User provided id added to logs for debugging",
+          "type": "string"
+        }
+      },
+      "$typescript": "{\"additionalProperties\":false}"
+    },
+    "i_tx_general_options": {
+      "description": "Generic flags for input",
+      "type": "object",
+      "default": {},
+      "properties": {
+        "transaction_id": {
+          "description": "Id of the transaction context to run the query in",
+          "type": "string"
+        },
+        "tracking_id": {
+          "description": "User provided id added to logs for debugging",
+          "type": "string"
+        }
+      },
+      "$typescript": "{\"additionalProperties\":false}"
+    },
+    "i_tx_metadata_options": {
+      "description": "Metadata flags for input",
+      "type": "object",
+      "default": {},
+      "properties": {
+        "return_metadata_total": {
+          "description": "Return the total rows count in metadata",
+          "type": "boolean"
+        }
+      },
+      "$typescript": "{\"additionalProperties\":false}"
+    },
+    "i_tx_limiting_options": {
+      "$typescript": "{\"additionalProperties\":false}",
+      "description": "Optional flags for input limiting",
+      "type": "object",
+      "properties": {
+        "limit": {
+          "description": "Number of records to return",
+          "type": "integer"
+        },
+        "offset": {
+          "description": "Number of records to omit from the beginning",
+          "type": "integer"
+        }
+      },
+      "default": {
+        "limit": 20,
+        "offset": 0
+      }
+    },
+    "i_tx_ordering_options": {
+      "$typescript": "{\"additionalProperties\":false}",
+      "description": "Optional flags for input ordering",
+      "type": "object",
+      "properties": {
+        "order": {
+          "description": "Ordering options",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/i_tx_ordering_input"
+          }
+        }
+      }
+    },
+    "i_tx_select_options": {
+      "$typescript": "{\"additionalProperties\":false}",
+      "description": "Optional flags to limit search result",
+      "type": "object",
+      "properties": {
+        "select": {
+          "description": "Select options",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "i_tx_deselect_options": {
+      "$typescript": "{\"additionalProperties\":false}",
+      "description": "Optional flag to remove field from select",
+      "type": "object",
+      "properties": {
+        "deselect": {
+          "description": "Deselect options",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "i_tx_aggregating_options": {
+      "$typescript": "{\"additionalProperties\":false}",
+      "description": "Optional flags to aggregate data",
+      "type": "object",
+      "properties": {
+        "aggregator": {
+          "$ref": "#/definitions/i_tx_aggregator"
+        },
+        "aggregators": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/i_tx_aggregator"
+          }
+        },
+        "groups": {
+          "$ref": "#/definitions/i_tx_groups"
+        }
+      }
+    },
+    "i_tx_find_metadata": {
+      "description": "Metadata about the search",
+      "type": "object",
+      "properties": {
+        "total": {
+          "description": "Total number of records matching the query",
+          "type": "integer"
+        },
+        "offset": {
+          "description": "Current query offset",
+          "type": "integer"
+        },
+        "limit": {
+          "description": "Current query limit",
+          "type": "integer"
+        },
+        "more_rows": {
+          "description": "Boolean showing if there would be more rows to return with a higher offset/limit",
+          "type": "boolean"
+        },
+        "order": {
+          "description": "Ordering options",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/i_tx_ordering_input"
+          }
+        }
+      },
+      "required": ["offset", "limit", "more_rows"],
+      "additionalProperties": false
+    },
+    "i_tx_aggregating_metadata": {
+      "description": "Metadata about the aggregation",
+      "type": "object",
+      "properties": {
+        "aggregators": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/i_tx_aggregator"
+          }
+        },
+        "groups": {
+          "$ref": "#/definitions/i_tx_groups"
+        }
+      },
+      "required": ["aggregators"],
+      "additionalProperties": false
+    },
+    "i_tx_ordering_input": {
+      "description": "Input for orderBy",
+      "type": "object",
+      "properties": {
+        "field": {
+          "description": "Field to order by",
+          "type": "string"
+        },
+        "direction": {
+          "description": "Direction to order",
+          "default": "asc",
+          "type": "string",
+          "enum": ["asc", "desc"]
+        },
+        "nulls": {
+          "description": "Should nulls be first or last",
+          "type": "string",
+          "enum": ["first", "last"]
+        }
+      },
+      "required": ["field"],
+      "additionalProperties": false
+    },
+    "i_tx_groups": {
+      "type": "array",
+      "maxItems": 5,
+      "items": {
+        "$ref": "#/definitions/i_tx_group"
+      }
+    },
+    "i_tx_group": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/i_tx_group_period"
+        },
+        {
+          "$ref": "#/definitions/i_tx_group_field"
+        },
+        {
+          "$ref": "#/definitions/i_tx_group_metadata_field"
+        }
+      ]
+    },
+    "i_tx_group_period": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": ["period"]
+        },
+        "field": {
+          "$ref": "#/definitions/i_tx_period"
+        },
+        "alias": {
+          "type": "string"
+        }
+      },
+      "required": ["type", "field"],
+      "additionalProperties": false
+    },
+    "i_tx_group_field": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": ["field"]
+        },
+        "field": {
+          "type": "string"
+        },
+        "alias": {
+          "type": "string"
+        }
+      },
+      "required": ["type", "field"],
+      "additionalProperties": false
+    },
+    "i_tx_group_metadata_field": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": ["metadata_field"]
+        },
+        "field": {
+          "type": "string"
+        },
+        "alias": {
+          "type": "string"
+        }
+      },
+      "required": ["type", "field"],
+      "additionalProperties": false
+    },
+    "i_tx_period": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/i_tx_period_simple"
+        },
+        {
+          "$ref": "#/definitions/i_tx_period_timezone"
+        }
+      ]
+    },
+    "i_tx_period_simple": {
+      "description": "Time period rows should be grouped by",
+      "type": "string",
+      "enum": ["year", "month", "week", "day", "hour", "minute"],
+      "default": "day"
+    },
+    "i_tx_period_timezone": {
+      "type": "object",
+      "properties": {
+        "period": {
+          "$ref": "#/definitions/i_tx_period_simple"
+        },
+        "timezone": {
+          "description": "",
+          "type": "string"
+        }
+      },
+      "required": ["period", "timezone"],
+      "additionalProperties": false
+    },
+    "i_tx_time_filter": {
+      "type": "object",
+      "properties": {
+        "start_time": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "end_time": {
+          "type": "string",
+          "format": "date-time"
+        }
+      },
+      "$typescript": "{\"additionalProperties\":false}"
+    },
+    "i_tx_aggregator": {
+      "description": "Aggregator description",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/i_tx_aggregator_simple"
+        },
+        {
+          "$ref": "#/definitions/i_tx_aggregator_complex"
+        }
+      ]
+    },
+    "i_tx_aggregator_simple": {
+      "description": "Function to use for grouping",
+      "type": "string",
+      "enum": ["count", "countDistinct", "sum", "average", "min", "max"],
+      "default": "count"
+    },
+    "i_tx_aggregator_complex": {
+      "description": "Function and field to group",
+      "type": "object",
+      "properties": {
+        "function": {
+          "$ref": "#/definitions/i_tx_aggregator_simple"
+        },
+        "field": {
+          "description": "Field to group by",
+          "type": "string"
+        },
+        "alias": {
+          "description": "Alias to group under",
+          "type": "string"
+        }
+      },
+      "$typescript": "{\"additionalProperties\":false}"
+    },
+    "i_tx_aggregate_results": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/i_tx_aggregate_result"
+      }
+    },
+    "i_tx_aggregate_result": {
+      "type": "object",
+      "additionalProperties": { "type": ["string", "number"] }
+    },
+    "i_tx_distributor_leftover_rule": {
+      "description": "Rule for distribution grouping",
+      "type": "string",
+      "enum": ["keep", "random", "largest", "target"]
+    },
+    "i_tx_metadata_action": {
+      "description": "Whether to replace or extend current metadata with new value",
+      "type": "string",
+      "enum": ["replace", "extend"],
+      "default": "replace"
+    },
+    "i_tx_metadata_action_for_reverse": {
+      "description": "Whether to replace or extend current metadata with new value",
+      "type": "string",
+      "enum": [
+        "replace",
+        "replace_create_only",
+        "replace_cancel_only",
+        "extend",
+        "extend_create_only",
+        "extend_cancel_only"
+      ],
+      "default": "replace"
+    }
+  }
+}

package/dist/txs/update-token/update-token.enums.browser.cjs

@@ -0,0 +1,17 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/txs/update-token/update-token.enums.ts
+var update_token_enums_exports = {};
+module.exports = __toCommonJS(update_token_enums_exports);

package/dist/txs/update-token/update-token.enums.cjs

@@ -0,0 +1,17 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/txs/update-token/update-token.enums.ts
+var update_token_enums_exports = {};
+module.exports = __toCommonJS(update_token_enums_exports);

package/dist/txs/update-token/update-token.enums.d.ts

@@ -1,6 +1,6 @@
 import { UniqueTokenFilter } from '../get-token/get-token.enums';
 import { ITxGeneralOptions } from '../tx-consts.enums';
-import { TokenTable } from '../../db';
+import { TokenTable } from '../../db/token/token.enums';
 /**
  * Optional flags for input
  */

package/dist/txs/update-token/update-token.schema.input.json

@@ -0,0 +1,61 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "UpdateTokenTxInput",
+  "title": "UpdateTokenTxInput",
+  "description": "Input for updateToken",
+  "type": "object",
+  "properties": {
+    "token": {
+      "$ref": "/txs/get-token/get-token.schema.input.json#/definitions/unique_token_filter"
+    },
+    "update": {
+      "$ref": "#/definitions/update_token_fields"
+    },
+    "options": {
+      "$ref": "#/definitions/update_token_tx_options"
+    }
+  },
+  "definitions": {
+    "update_token_tx_options": {
+      "allOf": [
+        {
+          "$ref": "/txs/tx-consts.schema.json#/definitions/i_tx_general_options"
+        },
+        {
+          "$ref": "#/definitions/update_token_additional_options"
+        }
+      ]
+    },
+    "update_token_additional_options": {
+      "description": "Optional flags for input",
+      "type": "object",
+      "default": {},
+      "$typescript": "{\"additionalProperties\":false}",
+      "properties": {
+        "return_when_not_updated": {
+          "$id": "return_when_not_updated",
+          "description": "Whether the request should return the token object even if it was not updated",
+          "type": "boolean",
+          "default": false
+        }
+      }
+    },
+    "update_token_fields": {
+      "type": "object",
+      "$typescript": "{\"additionalProperties\":false}",
+      "properties": {
+        "metadata": {
+          "$ref": "/db/token/token.schema.json#/properties/metadata"
+        },
+        "public": {
+          "$ref": "/db/token/token.schema.json#/properties/public"
+        },
+        "status": {
+          "$ref": "/db/token/token.schema.json#/properties/status"
+        }
+      }
+    }
+  },
+  "required": ["token"],
+  "additionalProperties": false
+}

package/dist/txs/update-token/update-token.schema.output.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "UpdateTokenTxOutput",
+  "title": "UpdateTokenTxOutput",
+  "description": "Output of updateToken",
+  "type": "object",
+  "properties": {
+    "token": {
+      "description": "Token object",
+      "$ref": "/db/token/token.schema.json"
+    },
+    "updated": {
+      "description": "Boolean showing if the token was updated",
+      "type": "boolean"
+    }
+  },
+  "additionalProperties": false
+}

package/dist/txs/update-transfer/update-transfer.enums.browser.cjs

@@ -0,0 +1,17 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/txs/update-transfer/update-transfer.enums.ts
+var update_transfer_enums_exports = {};
+module.exports = __toCommonJS(update_transfer_enums_exports);

package/dist/txs/update-transfer/update-transfer.enums.cjs

@@ -0,0 +1,17 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/txs/update-transfer/update-transfer.enums.ts
+var update_transfer_enums_exports = {};
+module.exports = __toCommonJS(update_transfer_enums_exports);

package/dist/txs/update-transfer/update-transfer.enums.d.ts

@@ -1,6 +1,6 @@
 import { UniqueTransferFilter, Transfer } from '../get-transfer/get-transfer.enums';
 import { ITxGeneralOptions, ITxMetadataAction } from '../tx-consts.enums';
-import { TransferStatus } from '../../db';
+import { TransferStatus } from '../../db/consts.enums';
 import { Balance } from '../get-balance/get-balance.enums';
 /**
  * Optional flags for input

package/dist/txs/update-transfer/update-transfer.schema.input.json

@@ -0,0 +1,86 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "UpdateTransferTxInput",
+  "title": "UpdateTransferTxInput",
+  "description": "Input for updateTransfer",
+  "type": "object",
+  "properties": {
+    "transfer": {
+      "$ref": "/txs/get-transfer/get-transfer.schema.input.json#/definitions/unique_transfer_filter"
+    },
+    "update": {
+      "$ref": "#/definitions/update_transfer_fields"
+    },
+    "options": {
+      "$ref": "#/definitions/update_transfer_tx_options"
+    }
+  },
+  "definitions": {
+    "update_transfer_tx_options": {
+      "allOf": [
+        {
+          "$ref": "/txs/tx-consts.schema.json#/definitions/i_tx_general_options"
+        },
+        {
+          "$ref": "#/definitions/update_transfer_additional_options"
+        }
+      ]
+    },
+    "update_transfer_additional_options": {
+      "description": "Optional flags for input",
+      "type": "object",
+      "default": {},
+      "properties": {
+        "return_from_balance": {
+          "$id": "return_from_balance",
+          "description": "Whether the request should also return from wallet balance",
+          "type": "boolean",
+          "default": false
+        },
+        "return_to_balance": {
+          "$id": "return_to_balance",
+          "description": "Whether the request should also return to wallet balance",
+          "type": "boolean",
+          "default": false
+        },
+        "return_when_not_updated": {
+          "$id": "return_when_not_updated",
+          "description": "Whether the request should return the transfer object even if it was not updated",
+          "type": "boolean",
+          "default": false
+        },
+        "metadata_action": {
+          "$id": "metadata_action",
+          "$ref": "/txs/tx-consts.schema.json#/definitions/i_tx_metadata_action"
+        }
+      },
+      "$typescript": "{\"additionalProperties\": false}"
+    },
+    "update_transfer_fields": {
+      "type": "object",
+      "description": "Changes to be made to the transfer",
+      "properties": {
+        "status": {
+          "description": "Status the transfer should be set as. Only pending transfers can be updated",
+          "default": "finished",
+          "$ref": "/db/consts.schema.json#/definitions/TransferStatus"
+        },
+        "metadata": {
+          "$ref": "/db/transfer/transfer.schema.json#/properties/metadata"
+        },
+        "extend_metadata": {
+          "$ref": "/db/transfer/transfer.schema.json#/properties/metadata"
+        },
+        "updated_at": {
+          "$ref": "/db/transfer/transfer.schema.json#/properties/updated_at"
+        }
+      },
+      "default": {
+        "status": "finished"
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": ["transfer"],
+  "additionalProperties": false
+}

package/dist/txs/update-transfer/update-transfer.schema.output.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "UpdateTransferTxOutput",
+  "title": "UpdateTransferTxOutput",
+  "description": "Output of updateTransfer",
+  "type": "object",
+  "properties": {
+    "transfer": {
+      "description": "Updated transfer object",
+      "$ref": "/txs/get-transfer/get-transfer.schema.output.json#/definitions/transfer"
+    },
+    "updated": {
+      "description": "Boolean showing if the transfer was updated",
+      "type": "boolean"
+    },
+    "from_balance": {
+      "description": "Debited wallet balance",
+      "$ref": "/txs/get-balance/get-balance.schema.output.json#/definitions/balance"
+    },
+    "to_balance": {
+      "description": "Credited wallet balance",
+      "$ref": "/txs/get-balance/get-balance.schema.output.json#/definitions/balance"
+    }
+  },
+  "additionalProperties": false
+}