@datafuel/sdk 0.2.0 → 0.3.0

package/dist/index.d.cts

@@ -310,6 +310,8 @@ interface TransactionsOptions {
 interface Transaction {
     id: number;
     amount: number;
+    /** The part of `amount` that moved plan credits, same sign; the rest moved pay-as-you-go credits. */
+    plan_amount?: number;
     operation: TransactionOperation;
     /** What `reference_id` points to, e.g. `task_id` or `job_id`. */
     reference_type: string;
@@ -400,13 +402,29 @@ interface Analytics {
     })[];
     by_status_code: StatusCodeBreakdown[];
 }
+/**
+ * Credits by pool. Plan credits are spent first, roll over when the plan renews and
+ * expire if it is not renewed. Pay-as-you-go credits come from credit packs, are spent
+ * after plan credits and never expire.
+ */
+interface BalanceSplit {
+    /** Total spendable credits: `plan_balance` plus `payg_balance`. */
+    balance: number;
+    plan_balance: number;
+    payg_balance: number;
+}
 /** The account behind the API key. */
 interface Profile {
     email: string;
     username: string;
     current_concurrency: number;
     concurrency_limit: number;
+    /** Total spendable credits: `plan_credit_balance` plus `payg_credit_balance`. */
     credit_balance: number;
+    /** Spent first; expire if the plan is not renewed. */
+    plan_credit_balance?: number;
+    /** Spent after plan credits; never expire. */
+    payg_credit_balance?: number;
     monthly_credit_limit: number;
 }
 /** One argument of a browser action. */
@@ -470,7 +488,7 @@ declare class Capabilities {
 
 declare const DEFAULT_BASE_URL = "https://scraping-api.datafuel.ai/api/v1";
 /** Kept in step with package.json by a test; see test/hardening.test.ts. */
-declare const VERSION = "0.2.0";
+declare const VERSION = "0.3.0";
 /** Options for the llm_scraping module, which reads its proxy country here. */
 interface AskOptions {
     engine: Engine | string;
@@ -729,10 +747,12 @@ declare class DataFuel {
     proxyAsns(country: string, options?: CallOptions & {
         proxyType?: string;
     }): Promise<ProxyLocation[]>;
-    /** Remaining credits. */
+    /** Remaining credits: plan and pay-as-you-go together. */
     balance(options?: CallOptions): Promise<number>;
+    /** Remaining credits by pool: plan credits (spent first) and pay-as-you-go credits. */
+    balanceSplit(options?: CallOptions): Promise<BalanceSplit>;
     /**
-     * Credit movements, newest first: purchases, usage, refunds, expiry.
+     * Credit movements, newest first: plan assignments, credit pack purchases, usage, refunds, expiry.
      * `sums` totals each operation over the whole range, not just this page.
      */
     transactions(options?: TransactionsOptions & CallOptions): Promise<TransactionsPage>;
@@ -844,4 +864,4 @@ declare class WaitTimeout extends DataFuelError {
     constructor(message: string, id?: string, status?: unknown);
 }
 
-export { type AI, APIError, type Analytics, type AnalyticsCounts, type AnalyticsOptions, type AskOptions, Blocked, type CallOptions, type CancelResult, Capabilities, type Capability, type ClientOptions, type CrawlOptions, CrawlPage, type CrawlResult, type CrawlResultsPage, type CrawlStatus, DEFAULT_BASE_URL, DataFuel, DataFuelError, type Engine, EngineUnavailable, type ErrorCode, Forbidden, type Format, IdempotencyKeyReused, InsufficientCredits, InvalidAttributes, JobNotCancellable, type JobResults, type JobStatus, type JobSummary, type JobsPage, type JsInstruction, type JsInstructionArg, type Link, type ListOptions, type ListTasksOptions, type MapOptions, ModuleUnavailable, NoApiKey, NotFound, type Payload, type PreviousPeriod, type Profile, type Proxy, type ProxyCountry, type ProxyLocation, type ProxyType, RateLimited, Result, type ScrapeOptions, type SearchOptions, type SiteMap, type Status, type StatusCodeBreakdown, TaskFailed, type TaskSummary, type TaskType, type TasksPage, type Transaction, type TransactionOperation, type TransactionSum, type TransactionsOptions, type TransactionsPage, TransportError, Unauthorized, Unavailable, VERSION, WaitTimeout, isDone };
+export { type AI, APIError, type Analytics, type AnalyticsCounts, type AnalyticsOptions, type AskOptions, type BalanceSplit, Blocked, type CallOptions, type CancelResult, Capabilities, type Capability, type ClientOptions, type CrawlOptions, CrawlPage, type CrawlResult, type CrawlResultsPage, type CrawlStatus, DEFAULT_BASE_URL, DataFuel, DataFuelError, type Engine, EngineUnavailable, type ErrorCode, Forbidden, type Format, IdempotencyKeyReused, InsufficientCredits, InvalidAttributes, JobNotCancellable, type JobResults, type JobStatus, type JobSummary, type JobsPage, type JsInstruction, type JsInstructionArg, type Link, type ListOptions, type ListTasksOptions, type MapOptions, ModuleUnavailable, NoApiKey, NotFound, type Payload, type PreviousPeriod, type Profile, type Proxy, type ProxyCountry, type ProxyLocation, type ProxyType, RateLimited, Result, type ScrapeOptions, type SearchOptions, type SiteMap, type Status, type StatusCodeBreakdown, TaskFailed, type TaskSummary, type TaskType, type TasksPage, type Transaction, type TransactionOperation, type TransactionSum, type TransactionsOptions, type TransactionsPage, TransportError, Unauthorized, Unavailable, VERSION, WaitTimeout, isDone };

package/dist/index.d.ts

@@ -310,6 +310,8 @@ interface TransactionsOptions {
 interface Transaction {
     id: number;
     amount: number;
+    /** The part of `amount` that moved plan credits, same sign; the rest moved pay-as-you-go credits. */
+    plan_amount?: number;
     operation: TransactionOperation;
     /** What `reference_id` points to, e.g. `task_id` or `job_id`. */
     reference_type: string;
@@ -400,13 +402,29 @@ interface Analytics {
     })[];
     by_status_code: StatusCodeBreakdown[];
 }
+/**
+ * Credits by pool. Plan credits are spent first, roll over when the plan renews and
+ * expire if it is not renewed. Pay-as-you-go credits come from credit packs, are spent
+ * after plan credits and never expire.
+ */
+interface BalanceSplit {
+    /** Total spendable credits: `plan_balance` plus `payg_balance`. */
+    balance: number;
+    plan_balance: number;
+    payg_balance: number;
+}
 /** The account behind the API key. */
 interface Profile {
     email: string;
     username: string;
     current_concurrency: number;
     concurrency_limit: number;
+    /** Total spendable credits: `plan_credit_balance` plus `payg_credit_balance`. */
     credit_balance: number;
+    /** Spent first; expire if the plan is not renewed. */
+    plan_credit_balance?: number;
+    /** Spent after plan credits; never expire. */
+    payg_credit_balance?: number;
     monthly_credit_limit: number;
 }
 /** One argument of a browser action. */
@@ -470,7 +488,7 @@ declare class Capabilities {
 
 declare const DEFAULT_BASE_URL = "https://scraping-api.datafuel.ai/api/v1";
 /** Kept in step with package.json by a test; see test/hardening.test.ts. */
-declare const VERSION = "0.2.0";
+declare const VERSION = "0.3.0";
 /** Options for the llm_scraping module, which reads its proxy country here. */
 interface AskOptions {
     engine: Engine | string;
@@ -729,10 +747,12 @@ declare class DataFuel {
     proxyAsns(country: string, options?: CallOptions & {
         proxyType?: string;
     }): Promise<ProxyLocation[]>;
-    /** Remaining credits. */
+    /** Remaining credits: plan and pay-as-you-go together. */
     balance(options?: CallOptions): Promise<number>;
+    /** Remaining credits by pool: plan credits (spent first) and pay-as-you-go credits. */
+    balanceSplit(options?: CallOptions): Promise<BalanceSplit>;
     /**
-     * Credit movements, newest first: purchases, usage, refunds, expiry.
+     * Credit movements, newest first: plan assignments, credit pack purchases, usage, refunds, expiry.
      * `sums` totals each operation over the whole range, not just this page.
      */
     transactions(options?: TransactionsOptions & CallOptions): Promise<TransactionsPage>;
@@ -844,4 +864,4 @@ declare class WaitTimeout extends DataFuelError {
     constructor(message: string, id?: string, status?: unknown);
 }
 
-export { type AI, APIError, type Analytics, type AnalyticsCounts, type AnalyticsOptions, type AskOptions, Blocked, type CallOptions, type CancelResult, Capabilities, type Capability, type ClientOptions, type CrawlOptions, CrawlPage, type CrawlResult, type CrawlResultsPage, type CrawlStatus, DEFAULT_BASE_URL, DataFuel, DataFuelError, type Engine, EngineUnavailable, type ErrorCode, Forbidden, type Format, IdempotencyKeyReused, InsufficientCredits, InvalidAttributes, JobNotCancellable, type JobResults, type JobStatus, type JobSummary, type JobsPage, type JsInstruction, type JsInstructionArg, type Link, type ListOptions, type ListTasksOptions, type MapOptions, ModuleUnavailable, NoApiKey, NotFound, type Payload, type PreviousPeriod, type Profile, type Proxy, type ProxyCountry, type ProxyLocation, type ProxyType, RateLimited, Result, type ScrapeOptions, type SearchOptions, type SiteMap, type Status, type StatusCodeBreakdown, TaskFailed, type TaskSummary, type TaskType, type TasksPage, type Transaction, type TransactionOperation, type TransactionSum, type TransactionsOptions, type TransactionsPage, TransportError, Unauthorized, Unavailable, VERSION, WaitTimeout, isDone };
+export { type AI, APIError, type Analytics, type AnalyticsCounts, type AnalyticsOptions, type AskOptions, type BalanceSplit, Blocked, type CallOptions, type CancelResult, Capabilities, type Capability, type ClientOptions, type CrawlOptions, CrawlPage, type CrawlResult, type CrawlResultsPage, type CrawlStatus, DEFAULT_BASE_URL, DataFuel, DataFuelError, type Engine, EngineUnavailable, type ErrorCode, Forbidden, type Format, IdempotencyKeyReused, InsufficientCredits, InvalidAttributes, JobNotCancellable, type JobResults, type JobStatus, type JobSummary, type JobsPage, type JsInstruction, type JsInstructionArg, type Link, type ListOptions, type ListTasksOptions, type MapOptions, ModuleUnavailable, NoApiKey, NotFound, type Payload, type PreviousPeriod, type Profile, type Proxy, type ProxyCountry, type ProxyLocation, type ProxyType, RateLimited, Result, type ScrapeOptions, type SearchOptions, type SiteMap, type Status, type StatusCodeBreakdown, TaskFailed, type TaskSummary, type TaskType, type TasksPage, type Transaction, type TransactionOperation, type TransactionSum, type TransactionsOptions, type TransactionsPage, TransportError, Unauthorized, Unavailable, VERSION, WaitTimeout, isDone };

package/dist/index.js

@@ -102,7 +102,7 @@ function apiError(status, body, retryAfter = 0) {
 
 // src/core.ts
 var DEFAULT_BASE_URL = "https://scraping-api.datafuel.ai/api/v1";
-var VERSION = "0.2.0";
+var VERSION = "0.3.0";
 var DEFAULT_TIMEOUT_MS = 18e4;
 var STILL_PROCESSING_DELAY_MS = 2e3;
 var STILL_PROCESSING = "TASK_STILL_PROCESSING";
@@ -978,13 +978,22 @@ var DataFuel = class {
       await this.send(new Request("GET", "/config/proxy/asn", params), options)
     );
   }
-  /** Remaining credits. */
+  /** Remaining credits: plan and pay-as-you-go together. */
   async balance(options = {}) {
     const body = await this.send(new Request("GET", "/users/@me/balance"), options);
     return intField(body, "balance");
   }
+  /** Remaining credits by pool: plan credits (spent first) and pay-as-you-go credits. */
+  async balanceSplit(options = {}) {
+    const body = await this.send(new Request("GET", "/users/@me/balance"), options);
+    return {
+      balance: intField(body, "balance"),
+      plan_balance: intField(body, "plan_balance"),
+      payg_balance: intField(body, "payg_balance")
+    };
+  }
   /**
-   * Credit movements, newest first: purchases, usage, refunds, expiry.
+   * Credit movements, newest first: plan assignments, credit pack purchases, usage, refunds, expiry.
    * `sums` totals each operation over the whole range, not just this page.
    */
   async transactions(options = {}) {