Package com.qtsurfer.api.client.model

Class Account

java.lang.Object
com.qtsurfer.api.client.model.Account
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.24.0") public class Account extends Object
Your identity and tier limits. No database call behind this one — safe to fetch on every page load. Live usage against these limits is a separate resource, `GET /account/usage`, deliberately: usage changes on every upload/execution and costs a query to compute, this one doesn't.

  • Field Details

  • Constructor Details

    • Account

      public Account()

  • Method Details

    • userId

      public Account userId(@Nonnull String userId)

    • getUserId

      @Nonnull public String getUserId()
      Your account id — the JWT `sub` claim.
      Returns:
      userId

    • setUserId

      public void setUserId(@Nonnull String userId)

    • tier

      public Account tier(@Nonnull String tier)

    • getTier

      @Nonnull public String getTier()
      Your current subscription tier.
      Returns:
      tier

    • setTier

      public void setTier(@Nonnull String tier)

    • scopes

      public Account scopes(@Nonnull Map<String,List<String>> scopes)

    • putScopesItem

      public Account putScopesItem(String key, List<String> scopesItem)

    • getScopes

      @Nonnull public Map<String,List<String>> getScopes()
      What your API key may do, as a map from a resource to the actions allowed on it. Names are lower case: `{ \"backtests\": [\"read\", \"write\", \"execute\"], \"exchanges\": [\"read\"] }`. A scope is a resource and an action: a resource is listed only with at least one action, and a key with no scope is `{}`. `GET /account` and `POST /auth/token` return the same map for the same key. An operation that needs a scope the key does not carry is answered `403` with the code `insufficient_scope`, and says which scope it needed.
      Returns:
      scopes

    • setScopes

      public void setScopes(@Nonnull Map<String,List<String>> scopes)

    • maxExecute

      public Account maxExecute(@Nonnull Integer maxExecute)

    • getMaxExecute

      @Nonnull public Integer getMaxExecute()
      Maximum number of strategy executions (and sweeps) you can have running at the same time through the API. Starting one past this number is answered with `429`, whose message carries the same number. The value already includes any API allowance your plan has.
      Returns:
      maxExecute

    • setMaxExecute

      public void setMaxExecute(@Nonnull Integer maxExecute)

    • maxRangeDays

      public Account maxRangeDays(@Nonnull Integer maxRangeDays)

    • getMaxRangeDays

      @Nonnull public Integer getMaxRangeDays()
      Maximum length, in days, of the time range of a backtest on one of your own datasets.
      Returns:
      maxRangeDays

    • setMaxRangeDays

      public void setMaxRangeDays(@Nonnull Integer maxRangeDays)

    • maxSweepCartesian

      public Account maxSweepCartesian(@Nonnull Integer maxSweepCartesian)

    • getMaxSweepCartesian

      @Nonnull public Integer getMaxSweepCartesian()
      Largest full grid, in parameter combinations, a sweep may run with the `grid` sampler. A grid with more combinations is refused with `400`; the `random` and `lhs` samplers run only their `samples` and are not held to it.
      Returns:
      maxSweepCartesian

    • setMaxSweepCartesian

      public void setMaxSweepCartesian(@Nonnull Integer maxSweepCartesian)

    • maxImportRangeHours

      public Account maxImportRangeHours(@Nonnull Integer maxImportRangeHours)

    • getMaxImportRangeHours

      @Nonnull public Integer getMaxImportRangeHours()
      Maximum length, in hours, of the time range of one dataset import from an exchange.
      Returns:
      maxImportRangeHours

    • setMaxImportRangeHours

      public void setMaxImportRangeHours(@Nonnull Integer maxImportRangeHours)

    • maxDatasets

      public Account maxDatasets(@Nonnull Integer maxDatasets)

    • getMaxDatasets

      @Nonnull public Integer getMaxDatasets()
      Maximum number of active datasets your tier allows.
      Returns:
      maxDatasets

    • setMaxDatasets

      public void setMaxDatasets(@Nonnull Integer maxDatasets)

    • maxDatasetBytes

      public Account maxDatasetBytes(@Nonnull Long maxDatasetBytes)

    • getMaxDatasetBytes

      @Nonnull public Long getMaxDatasetBytes()
      Maximum size, in bytes, of a single dataset version as stored, that is the `bytes` of its ready version. For a CSV upload that is the converted file, not the file you upload, so estimate from the number of rows. The Datasets guide has the details.
      Returns:
      maxDatasetBytes

    • setMaxDatasetBytes

      public void setMaxDatasetBytes(@Nonnull Long maxDatasetBytes)

    • maxTotalStorageBytes

      public Account maxTotalStorageBytes(@Nonnull Long maxTotalStorageBytes)

    • getMaxTotalStorageBytes

      @Nonnull public Long getMaxTotalStorageBytes()
      Maximum combined storage, in bytes, across every dataset, strategy-execution signal, and registered strategy on your account — one shared pool, not a separate cap per resource type, since they all compete for the same underlying storage. See `GET /account/usage`'s `storageBytesUsed` for your current usage against this number.
      Returns:
      maxTotalStorageBytes

    • setMaxTotalStorageBytes

      public void setMaxTotalStorageBytes(@Nonnull Long maxTotalStorageBytes)

    • links

      public Account links(@Nonnull AccountLinks links)

    • getLinks

      @Nonnull public AccountLinks getLinks()
      Get links
      Returns:
      links

    • setLinks

      public void setLinks(@Nonnull AccountLinks links)

    • equals

      public boolean equals(Object o)
      Return true if this Account object is equal to o.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string