oilpriceapi 0.6.0 → 0.8.2

package/dist/resources/ei/opec-production.js

@@ -0,0 +1,93 @@
+/**
+ * Energy Intelligence - OPEC Production Resource
+ *
+ * Access OPEC crude oil production data by country with historical trends.
+ */
+import { ValidationError } from "../../errors.js";
+/**
+ * EI OPEC Production Resource
+ *
+ * Access OPEC crude oil production data and analytics.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get total OPEC production
+ * const total = await client.ei.opecProduction.total();
+ * console.log(`Total OPEC: ${total.total_production_bpd} bpd`);
+ *
+ * // Get top producers
+ * const top = await client.ei.opecProduction.topProducers();
+ * top.forEach(p => console.log(`${p.rank}. ${p.country}: ${p.production_bpd} bpd`));
+ * ```
+ */
+export class EIOPECProductionResource {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List all OPEC production records
+     *
+     * @returns Array of production records
+     */
+    async list() {
+        const response = await this.client["request"]("/v1/ei/opec_productions", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get a specific production record
+     *
+     * @param id - Record ID
+     * @returns Production record
+     */
+    async get(id) {
+        if (!id || typeof id !== "string") {
+            throw new ValidationError("Record ID must be a non-empty string");
+        }
+        return this.client["request"](`/v1/ei/opec_productions/${id}`, {});
+    }
+    /**
+     * Get latest OPEC production data
+     *
+     * @returns Latest production record
+     */
+    async latest() {
+        return this.client["request"]("/v1/ei/opec_productions/latest", {});
+    }
+    /**
+     * Get total OPEC production
+     *
+     * @returns Total OPEC production summary
+     */
+    async total() {
+        return this.client["request"]("/v1/ei/opec_productions/total", {});
+    }
+    /**
+     * Get production by country
+     *
+     * @returns Array of production by country
+     */
+    async byCountry() {
+        const response = await this.client["request"]("/v1/ei/opec_productions/by_country", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get historical production data
+     *
+     * @returns Array of historical production levels
+     */
+    async historical() {
+        const response = await this.client["request"]("/v1/ei/opec_productions/historical", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get top OPEC producers
+     *
+     * @returns Array of top producing countries
+     */
+    async topProducers() {
+        const response = await this.client["request"]("/v1/ei/opec_productions/top_producers", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+}

package/dist/resources/ei/rig-counts.d.ts

@@ -0,0 +1,131 @@
+/**
+ * Energy Intelligence - Rig Counts Resource
+ *
+ * Access Baker Hughes rig count data with basin, state, and historical breakdowns.
+ */
+import type { OilPriceAPI } from "../../client.js";
+/**
+ * Rig count record
+ */
+export interface RigCountRecord {
+    /** Record ID */
+    id: string;
+    /** Total rig count */
+    total_rigs: number;
+    /** Oil rigs */
+    oil_rigs?: number;
+    /** Gas rigs */
+    gas_rigs?: number;
+    /** Miscellaneous rigs */
+    misc_rigs?: number;
+    /** Report date */
+    date: string;
+    /** Week number */
+    week?: number;
+    /** ISO timestamp */
+    timestamp: string;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Rig count by basin
+ */
+export interface RigCountByBasin {
+    /** Basin name */
+    basin: string;
+    /** Rig count */
+    rig_count: number;
+    /** Change from previous week */
+    change?: number;
+    /** Date */
+    date: string;
+}
+/**
+ * Rig count by state
+ */
+export interface RigCountByState {
+    /** State name */
+    state: string;
+    /** Rig count */
+    rig_count: number;
+    /** Change from previous week */
+    change?: number;
+    /** Date */
+    date: string;
+}
+/**
+ * Historical rig count data point
+ */
+export interface HistoricalRigCount {
+    /** Date */
+    date: string;
+    /** Total rigs */
+    total_rigs: number;
+    /** Oil rigs */
+    oil_rigs?: number;
+    /** Gas rigs */
+    gas_rigs?: number;
+}
+/**
+ * EI Rig Counts Resource
+ *
+ * Access Baker Hughes rig count data with comprehensive breakdowns.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest rig count
+ * const latest = await client.ei.rigCounts.latest();
+ * console.log(`Total rigs: ${latest.total_rigs}`);
+ *
+ * // Get by basin
+ * const basins = await client.ei.rigCounts.byBasin();
+ * basins.forEach(b => console.log(`${b.basin}: ${b.rig_count} rigs`));
+ * ```
+ */
+export declare class EIRigCountsResource {
+    private client;
+    constructor(client: OilPriceAPI);
+    /**
+     * List all rig count records
+     *
+     * @returns Array of rig count records
+     *
+     * @throws {OilPriceAPIError} If API request fails
+     */
+    list(): Promise<RigCountRecord[]>;
+    /**
+     * Get a specific rig count record
+     *
+     * @param id - Record ID
+     * @returns Rig count record
+     *
+     * @throws {NotFoundError} If record not found
+     */
+    get(id: string): Promise<RigCountRecord>;
+    /**
+     * Get latest rig count
+     *
+     * @returns Latest rig count data
+     */
+    latest(): Promise<RigCountRecord>;
+    /**
+     * Get rig counts by basin
+     *
+     * @returns Array of rig counts by basin
+     */
+    byBasin(): Promise<RigCountByBasin[]>;
+    /**
+     * Get rig counts by state
+     *
+     * @returns Array of rig counts by state
+     */
+    byState(): Promise<RigCountByState[]>;
+    /**
+     * Get historical rig count data
+     *
+     * @returns Array of historical rig counts
+     */
+    historical(): Promise<HistoricalRigCount[]>;
+}

package/dist/resources/ei/rig-counts.js

@@ -0,0 +1,89 @@
+/**
+ * Energy Intelligence - Rig Counts Resource
+ *
+ * Access Baker Hughes rig count data with basin, state, and historical breakdowns.
+ */
+import { ValidationError } from "../../errors.js";
+/**
+ * EI Rig Counts Resource
+ *
+ * Access Baker Hughes rig count data with comprehensive breakdowns.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest rig count
+ * const latest = await client.ei.rigCounts.latest();
+ * console.log(`Total rigs: ${latest.total_rigs}`);
+ *
+ * // Get by basin
+ * const basins = await client.ei.rigCounts.byBasin();
+ * basins.forEach(b => console.log(`${b.basin}: ${b.rig_count} rigs`));
+ * ```
+ */
+export class EIRigCountsResource {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List all rig count records
+     *
+     * @returns Array of rig count records
+     *
+     * @throws {OilPriceAPIError} If API request fails
+     */
+    async list() {
+        const response = await this.client["request"]("/v1/ei/rig_counts", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get a specific rig count record
+     *
+     * @param id - Record ID
+     * @returns Rig count record
+     *
+     * @throws {NotFoundError} If record not found
+     */
+    async get(id) {
+        if (!id || typeof id !== "string") {
+            throw new ValidationError("Record ID must be a non-empty string");
+        }
+        return this.client["request"](`/v1/ei/rig_counts/${id}`, {});
+    }
+    /**
+     * Get latest rig count
+     *
+     * @returns Latest rig count data
+     */
+    async latest() {
+        return this.client["request"]("/v1/ei/rig_counts/latest", {});
+    }
+    /**
+     * Get rig counts by basin
+     *
+     * @returns Array of rig counts by basin
+     */
+    async byBasin() {
+        const response = await this.client["request"]("/v1/ei/rig_counts/by_basin", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get rig counts by state
+     *
+     * @returns Array of rig counts by state
+     */
+    async byState() {
+        const response = await this.client["request"]("/v1/ei/rig_counts/by_state", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get historical rig count data
+     *
+     * @returns Array of historical rig counts
+     */
+    async historical() {
+        const response = await this.client["request"]("/v1/ei/rig_counts/historical", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+}

package/dist/resources/ei/well-permits.d.ts

@@ -0,0 +1,178 @@
+/**
+ * Energy Intelligence - Well Permits Resource
+ *
+ * Access oil and gas well permit data by state, operator, and formation.
+ */
+import type { OilPriceAPI } from "../../client.js";
+/**
+ * Well permit record
+ */
+export interface WellPermitRecord {
+    /** Record ID */
+    id: string;
+    /** Permit number */
+    permit_number?: string;
+    /** State */
+    state: string;
+    /** County */
+    county?: string;
+    /** Operator name */
+    operator?: string;
+    /** Well name */
+    well_name?: string;
+    /** Formation/target */
+    formation?: string;
+    /** Well type (e.g., "oil", "gas", "injection") */
+    well_type?: string;
+    /** Permit issue date */
+    issue_date: string;
+    /** ISO timestamp */
+    timestamp: string;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Well permit summary
+ */
+export interface WellPermitSummary {
+    /** Total permits */
+    total_permits: number;
+    /** Permits by state */
+    by_state?: Record<string, number>;
+    /** Permits by operator */
+    by_operator?: Record<string, number>;
+    /** As of date */
+    as_of_date: string;
+}
+/**
+ * Permits by state
+ */
+export interface PermitsByState {
+    /** State name */
+    state: string;
+    /** Permit count */
+    permit_count: number;
+    /** Change from previous period */
+    change?: number;
+    /** Date */
+    date: string;
+}
+/**
+ * Permits by operator
+ */
+export interface PermitsByOperator {
+    /** Operator name */
+    operator: string;
+    /** Permit count */
+    permit_count: number;
+    /** Percentage of total */
+    percentage?: number;
+    /** Date */
+    date: string;
+}
+/**
+ * Permits by formation
+ */
+export interface PermitsByFormation {
+    /** Formation name */
+    formation: string;
+    /** Permit count */
+    permit_count: number;
+    /** Percentage of total */
+    percentage?: number;
+    /** Date */
+    date: string;
+}
+/**
+ * Well permit search query
+ */
+export interface WellPermitSearchQuery {
+    /** State filter */
+    state?: string;
+    /** Operator filter */
+    operator?: string;
+    /** Formation filter */
+    formation?: string;
+    /** Start date */
+    start_date?: string;
+    /** End date */
+    end_date?: string;
+}
+/**
+ * EI Well Permits Resource
+ *
+ * Access oil and gas well permit data with detailed breakdowns.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest permits
+ * const latest = await client.ei.wellPermits.latest();
+ * console.log(`Permit: ${latest.permit_number} - ${latest.operator}`);
+ *
+ * // Get permits by state
+ * const states = await client.ei.wellPermits.byState();
+ * states.forEach(s => console.log(`${s.state}: ${s.permit_count} permits`));
+ *
+ * // Search permits
+ * const results = await client.ei.wellPermits.search({
+ *   state: 'Texas',
+ *   operator: 'ConocoPhillips'
+ * });
+ * ```
+ */
+export declare class EIWellPermitsResource {
+    private client;
+    constructor(client: OilPriceAPI);
+    /**
+     * List all well permit records
+     *
+     * @returns Array of well permit records
+     */
+    list(): Promise<WellPermitRecord[]>;
+    /**
+     * Get a specific well permit record
+     *
+     * @param id - Record ID
+     * @returns Well permit record
+     */
+    get(id: string): Promise<WellPermitRecord>;
+    /**
+     * Get latest well permit
+     *
+     * @returns Latest well permit record
+     */
+    latest(): Promise<WellPermitRecord>;
+    /**
+     * Get well permit summary
+     *
+     * @returns Well permit summary statistics
+     */
+    summary(): Promise<WellPermitSummary>;
+    /**
+     * Get permits by state
+     *
+     * @returns Array of permits grouped by state
+     */
+    byState(): Promise<PermitsByState[]>;
+    /**
+     * Get permits by operator
+     *
+     * @returns Array of permits grouped by operator
+     */
+    byOperator(): Promise<PermitsByOperator[]>;
+    /**
+     * Get permits by formation
+     *
+     * @returns Array of permits grouped by formation
+     */
+    byFormation(): Promise<PermitsByFormation[]>;
+    /**
+     * Search well permits
+     *
+     * @param query - Search query parameters
+     * @returns Array of matching well permit records
+     */
+    search(query: WellPermitSearchQuery): Promise<WellPermitRecord[]>;
+}

package/dist/resources/ei/well-permits.js

@@ -0,0 +1,120 @@
+/**
+ * Energy Intelligence - Well Permits Resource
+ *
+ * Access oil and gas well permit data by state, operator, and formation.
+ */
+import { ValidationError } from "../../errors.js";
+/**
+ * EI Well Permits Resource
+ *
+ * Access oil and gas well permit data with detailed breakdowns.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest permits
+ * const latest = await client.ei.wellPermits.latest();
+ * console.log(`Permit: ${latest.permit_number} - ${latest.operator}`);
+ *
+ * // Get permits by state
+ * const states = await client.ei.wellPermits.byState();
+ * states.forEach(s => console.log(`${s.state}: ${s.permit_count} permits`));
+ *
+ * // Search permits
+ * const results = await client.ei.wellPermits.search({
+ *   state: 'Texas',
+ *   operator: 'ConocoPhillips'
+ * });
+ * ```
+ */
+export class EIWellPermitsResource {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List all well permit records
+     *
+     * @returns Array of well permit records
+     */
+    async list() {
+        const response = await this.client["request"]("/v1/ei/well-permits", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get a specific well permit record
+     *
+     * @param id - Record ID
+     * @returns Well permit record
+     */
+    async get(id) {
+        if (!id || typeof id !== "string") {
+            throw new ValidationError("Record ID must be a non-empty string");
+        }
+        return this.client["request"](`/v1/ei/well-permits/${id}`, {});
+    }
+    /**
+     * Get latest well permit
+     *
+     * @returns Latest well permit record
+     */
+    async latest() {
+        return this.client["request"]("/v1/ei/well-permits/latest", {});
+    }
+    /**
+     * Get well permit summary
+     *
+     * @returns Well permit summary statistics
+     */
+    async summary() {
+        return this.client["request"]("/v1/ei/well-permits/summary", {});
+    }
+    /**
+     * Get permits by state
+     *
+     * @returns Array of permits grouped by state
+     */
+    async byState() {
+        const response = await this.client["request"]("/v1/ei/well-permits/by-state", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get permits by operator
+     *
+     * @returns Array of permits grouped by operator
+     */
+    async byOperator() {
+        const response = await this.client["request"]("/v1/ei/well-permits/by-operator", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get permits by formation
+     *
+     * @returns Array of permits grouped by formation
+     */
+    async byFormation() {
+        const response = await this.client["request"]("/v1/ei/well-permits/by-formation", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Search well permits
+     *
+     * @param query - Search query parameters
+     * @returns Array of matching well permit records
+     */
+    async search(query) {
+        const params = {};
+        if (query.state)
+            params.state = query.state;
+        if (query.operator)
+            params.operator = query.operator;
+        if (query.formation)
+            params.formation = query.formation;
+        if (query.start_date)
+            params.start_date = query.start_date;
+        if (query.end_date)
+            params.end_date = query.end_date;
+        const response = await this.client["request"]("/v1/ei/well-permits/search", params);
+        return Array.isArray(response) ? response : response.data;
+    }
+}