@burdenoff/sdk-libs 2026.627.4 → 2026.629.1

package/dist/modules/theglobalfuel/index.d.cts

@@ -0,0 +1,395 @@
+import { S as SdkModule } from '../../module-JDbvil5h.cjs';
+import 'graphql-request';
+
+interface TheFileRef {
+    id: string;
+}
+type TheAssetKind = 'GAS_FIELD' | 'MINE' | 'OIL_FIELD' | 'PIPELINE' | 'POWER_PLANT' | 'PROCESSING_PLANT' | 'QUARRY' | 'REFINERY' | 'SOLAR_FARM' | 'STORAGE_TERMINAL' | 'WELL' | 'WIND_FARM';
+type TheAssetStatus = 'APPRAISAL' | 'DECOMMISSIONING' | 'DEVELOPMENT' | 'EXPLORATION' | 'PRODUCING' | 'RETIRED' | 'SUSPENDED';
+type TheCommodityType = 'BAUXITE' | 'BIOFUEL' | 'COAL' | 'COPPER' | 'CRUDE_OIL' | 'ELECTRICITY' | 'GOLD' | 'HYDROGEN' | 'IRON_ORE' | 'LITHIUM' | 'LNG' | 'NATURAL_GAS' | 'RARE_EARTH';
+type TheComplianceCategory = 'CARBON_CREDIT' | 'CHAIN_OF_CUSTODY' | 'EMISSIONS_REPORT' | 'ENVIRONMENTAL_PERMIT' | 'EXPORT_LICENSE' | 'EXTRACTION_LICENSE' | 'SAFETY_AUDIT';
+type TheComplianceStatus = 'APPROVED' | 'EXPIRED' | 'PENDING' | 'REJECTED' | 'REVOKED' | 'SUBMITTED';
+type TheContractSide = 'BUY' | 'SELL';
+type TheContractStatus = 'ACTIVE' | 'COMPLETED' | 'DRAFT' | 'NEGOTIATION' | 'SIGNED' | 'SUSPENDED' | 'TERMINATED';
+type TheEmissionScope = 'SCOPE_1' | 'SCOPE_2' | 'SCOPE_3';
+type TheInventoryStatus = 'AVAILABLE' | 'CONSUMED' | 'IN_TRANSIT' | 'RESERVED' | 'WRITTEN_OFF';
+type ThePricingBasis = 'FIXED' | 'FORMULA' | 'INDEX_LINKED' | 'SPOT';
+type TheReserveCategory = 'CONTINGENT' | 'POSSIBLE' | 'PROBABLE' | 'PROSPECTIVE' | 'PROVED';
+type TheShipmentStatus = 'CANCELLED' | 'DELIVERED' | 'IN_TRANSIT' | 'LOADING' | 'SCHEDULED';
+type TheTransportMode = 'GRID' | 'PIPELINE' | 'RAIL' | 'TANKER' | 'TRUCK' | 'VESSEL_BULK';
+type TheUnit = 'BARRELS' | 'CUBIC_METERS' | 'GJ' | 'KILOGRAMS' | 'MCF' | 'MWH' | 'TONNES';
+interface TheAsset {
+    id: string;
+    name: string;
+    code?: string | null;
+    commodity: TheCommodityType;
+    kind: TheAssetKind;
+    status: TheAssetStatus;
+    capacityPerDay: number;
+    capacityUnit: TheUnit;
+    workingInterestPct: number;
+    location?: string | null;
+    latitude?: number | null;
+    longitude?: number | null;
+    operatorLeadId?: string | null;
+    commissionedAt?: string | null;
+    decommissionedAt?: string | null;
+    tags: string[];
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+    productionRecords?: TheProductionRecord[];
+    reserveEstimates?: TheReserveEstimate[];
+}
+interface TheProductionRecord {
+    id: string;
+    assetId: string;
+    volume: number;
+    unit: TheUnit;
+    grade?: number | null;
+    downtimeHours: number;
+    periodStart: string;
+    periodEnd: string;
+    notes?: string | null;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+    asset?: TheAsset | null;
+}
+interface TheReserveEstimate {
+    id: string;
+    assetId: string;
+    category: TheReserveCategory;
+    recoverable: number;
+    recoveryFactor?: number | null;
+    unit: TheUnit;
+    asOfDate: string;
+    methodology?: string | null;
+    notes?: string | null;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+    asset?: TheAsset | null;
+}
+interface TheOfftakeContract {
+    id: string;
+    reference: string;
+    counterparty: string;
+    side: TheContractSide;
+    commodity: TheCommodityType;
+    status: TheContractStatus;
+    contractedVolume: number;
+    deliveredVolume: number;
+    unit: TheUnit;
+    pricingBasis: ThePricingBasis;
+    pricePerUnit: number;
+    priceIndex?: string | null;
+    currency: string;
+    deliveryLocation?: string | null;
+    startDate?: string | null;
+    endDate?: string | null;
+    signedAt?: string | null;
+    notes?: string | null;
+    tags: string[];
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+    shipments?: TheShipment[];
+}
+interface TheShipment {
+    id: string;
+    reference: string;
+    contractId: string;
+    status: TheShipmentStatus;
+    mode: TheTransportMode;
+    volume: number;
+    unit: TheUnit;
+    origin?: string | null;
+    destination?: string | null;
+    carrier?: string | null;
+    scheduledAt?: string | null;
+    departedAt?: string | null;
+    deliveredAt?: string | null;
+    notes?: string | null;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+    contract?: TheOfftakeContract | null;
+    document?: TheFileRef | null;
+}
+interface TheInventoryLot {
+    id: string;
+    lotCode: string;
+    commodity: TheCommodityType;
+    status: TheInventoryStatus;
+    quantity: number;
+    unit: TheUnit;
+    grade?: number | null;
+    unitValue: number;
+    currency: string;
+    location?: string | null;
+    assetId?: string | null;
+    producedAt?: string | null;
+    notes?: string | null;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface TheEmissionRecord {
+    id: string;
+    assetId?: string | null;
+    scope: TheEmissionScope;
+    co2eTonnes: number;
+    periodStart: string;
+    periodEnd: string;
+    source?: string | null;
+    methodology?: string | null;
+    verified: boolean;
+    verifiedAt?: string | null;
+    notes?: string | null;
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface TheComplianceCert {
+    id: string;
+    title: string;
+    category: TheComplianceCategory;
+    status: TheComplianceStatus;
+    certNumber?: string | null;
+    authority?: string | null;
+    assetId?: string | null;
+    ownerId?: string | null;
+    issuedAt?: string | null;
+    expiresAt?: string | null;
+    notes?: string | null;
+    tags: string[];
+    workspaceId: string;
+    createdAt: string;
+    updatedAt: string;
+    evidence?: TheFileRef | null;
+}
+interface ThePageInfo {
+    cursor?: string | null;
+    hasMore: boolean;
+}
+interface TheAssetConnection {
+    items: TheAsset[];
+    pageInfo: ThePageInfo;
+}
+interface TheOfftakeContractConnection {
+    items: TheOfftakeContract[];
+    pageInfo: ThePageInfo;
+}
+interface TheInventoryLotConnection {
+    items: TheInventoryLot[];
+    pageInfo: ThePageInfo;
+}
+interface TheProductionRecordConnection {
+    items: TheProductionRecord[];
+    pageInfo: ThePageInfo;
+}
+interface TheEmissionRecordConnection {
+    items: TheEmissionRecord[];
+    pageInfo: ThePageInfo;
+}
+interface ThePaginationInput {
+    cursor?: string;
+    limit?: number;
+    offset?: number;
+}
+interface TheCreateAssetInput {
+    name: string;
+    commodity: TheCommodityType;
+    capacityPerDay?: number;
+    capacityUnit?: TheUnit;
+    code?: string;
+    commissionedAt?: string;
+    kind?: TheAssetKind;
+    latitude?: number;
+    location?: string;
+    longitude?: number;
+    operatorLeadId?: string;
+    status?: TheAssetStatus;
+    tags?: string[];
+    workingInterestPct?: number;
+}
+interface TheUpdateAssetInput {
+    name?: string;
+    commodity?: TheCommodityType;
+    capacityPerDay?: number;
+    capacityUnit?: TheUnit;
+    code?: string;
+    commissionedAt?: string;
+    decommissionedAt?: string;
+    kind?: TheAssetKind;
+    latitude?: number;
+    location?: string;
+    longitude?: number;
+    operatorLeadId?: string;
+    tags?: string[];
+    workingInterestPct?: number;
+}
+interface TheCreateComplianceCertInput {
+    title: string;
+    assetId?: string;
+    authority?: string;
+    category?: TheComplianceCategory;
+    certNumber?: string;
+    evidenceFileId?: string;
+    expiresAt?: string;
+    issuedAt?: string;
+    notes?: string;
+    ownerId?: string;
+    tags?: string[];
+}
+interface TheCreateOfftakeContractInput {
+    commodity: TheCommodityType;
+    counterparty: string;
+    reference: string;
+    contractedVolume?: number;
+    currency?: string;
+    deliveryLocation?: string;
+    endDate?: string;
+    notes?: string;
+    priceIndex?: string;
+    pricePerUnit?: number;
+    pricingBasis?: ThePricingBasis;
+    side?: TheContractSide;
+    startDate?: string;
+    tags?: string[];
+    unit?: TheUnit;
+}
+interface TheUpdateOfftakeContractInput {
+    contractedVolume?: number;
+    counterparty?: string;
+    currency?: string;
+    deliveryLocation?: string;
+    endDate?: string;
+    notes?: string;
+    priceIndex?: string;
+    pricePerUnit?: number;
+    pricingBasis?: ThePricingBasis;
+    startDate?: string;
+    tags?: string[];
+    unit?: TheUnit;
+}
+interface TheCreateInventoryLotInput {
+    commodity: TheCommodityType;
+    lotCode: string;
+    quantity: number;
+    assetId?: string;
+    currency?: string;
+    grade?: number;
+    location?: string;
+    notes?: string;
+    producedAt?: string;
+    unit?: TheUnit;
+    unitValue?: number;
+}
+interface TheCreateReserveEstimateInput {
+    asOfDate: string;
+    assetId: string;
+    recoverable: number;
+    category?: TheReserveCategory;
+    methodology?: string;
+    notes?: string;
+    recoveryFactor?: number;
+    unit?: TheUnit;
+}
+interface TheCreateShipmentInput {
+    contractId: string;
+    reference: string;
+    volume: number;
+    carrier?: string;
+    destination?: string;
+    documentFileId?: string;
+    mode?: TheTransportMode;
+    notes?: string;
+    origin?: string;
+    scheduledAt?: string;
+    unit?: TheUnit;
+}
+interface TheRecordEmissionInput {
+    co2eTonnes: number;
+    periodEnd: string;
+    periodStart: string;
+    assetId?: string;
+    methodology?: string;
+    notes?: string;
+    scope?: TheEmissionScope;
+    source?: string;
+}
+interface TheRecordProductionInput {
+    assetId: string;
+    periodEnd: string;
+    periodStart: string;
+    volume: number;
+    downtimeHours?: number;
+    grade?: number;
+    notes?: string;
+    unit?: TheUnit;
+}
+
+interface TheAssetsApi {
+    get(id: string): Promise<TheAsset | null>;
+    list(commodity?: TheCommodityType, kind?: TheAssetKind, pagination?: ThePaginationInput, status?: TheAssetStatus): Promise<TheAssetConnection>;
+    create(input: TheCreateAssetInput): Promise<TheAsset>;
+    update(id: string, input: TheUpdateAssetInput): Promise<TheAsset>;
+    transition(id: string, status: TheAssetStatus): Promise<TheAsset>;
+    retire(id: string): Promise<boolean>;
+}
+interface TheProductionApi {
+    list(assetId?: string, pagination?: ThePaginationInput): Promise<TheProductionRecordConnection>;
+    record(input: TheRecordProductionInput): Promise<TheProductionRecord>;
+}
+interface TheReservesApi {
+    list(assetId?: string, category?: TheReserveCategory): Promise<TheReserveEstimate[]>;
+    create(input: TheCreateReserveEstimateInput): Promise<TheReserveEstimate>;
+}
+interface TheContractsApi {
+    get(id: string): Promise<TheOfftakeContract | null>;
+    list(commodity?: TheCommodityType, pagination?: ThePaginationInput, side?: TheContractSide, status?: TheContractStatus): Promise<TheOfftakeContractConnection>;
+    create(input: TheCreateOfftakeContractInput): Promise<TheOfftakeContract>;
+    update(id: string, input: TheUpdateOfftakeContractInput): Promise<TheOfftakeContract>;
+    transition(id: string, status: TheContractStatus): Promise<TheOfftakeContract>;
+}
+interface TheShipmentsApi {
+    list(contractId?: string, status?: TheShipmentStatus): Promise<TheShipment[]>;
+    schedule(input: TheCreateShipmentInput): Promise<TheShipment>;
+    deliver(id: string): Promise<TheShipment>;
+}
+interface TheInventoryApi {
+    list(commodity?: TheCommodityType, pagination?: ThePaginationInput, status?: TheInventoryStatus): Promise<TheInventoryLotConnection>;
+    create(input: TheCreateInventoryLotInput): Promise<TheInventoryLot>;
+    setStatus(id: string, status: TheInventoryStatus): Promise<TheInventoryLot>;
+}
+interface TheEmissionsApi {
+    list(assetId?: string, pagination?: ThePaginationInput, scope?: TheEmissionScope): Promise<TheEmissionRecordConnection>;
+    record(input: TheRecordEmissionInput): Promise<TheEmissionRecord>;
+    verify(id: string): Promise<TheEmissionRecord>;
+}
+interface TheComplianceApi {
+    get(id: string): Promise<TheComplianceCert | null>;
+    list(assetId?: string, category?: TheComplianceCategory, status?: TheComplianceStatus): Promise<TheComplianceCert[]>;
+    create(input: TheCreateComplianceCertInput): Promise<TheComplianceCert>;
+    transition(id: string, status: TheComplianceStatus): Promise<TheComplianceCert>;
+}
+interface TheSystemApi {
+    health(): Promise<string>;
+}
+interface TheglobalfuelApi {
+    assets: TheAssetsApi;
+    production: TheProductionApi;
+    reserves: TheReservesApi;
+    contracts: TheContractsApi;
+    shipments: TheShipmentsApi;
+    inventory: TheInventoryApi;
+    emissions: TheEmissionsApi;
+    compliance: TheComplianceApi;
+    system: TheSystemApi;
+}
+
+declare const theglobalfuelModule: SdkModule<TheglobalfuelApi>;
+
+export { type TheAsset, type TheAssetConnection, type TheAssetKind, type TheAssetStatus, type TheAssetsApi, type TheCommodityType, type TheComplianceApi, type TheComplianceCategory, type TheComplianceCert, type TheComplianceStatus, type TheContractSide, type TheContractStatus, type TheContractsApi, type TheCreateAssetInput, type TheCreateComplianceCertInput, type TheCreateInventoryLotInput, type TheCreateOfftakeContractInput, type TheCreateReserveEstimateInput, type TheCreateShipmentInput, type TheEmissionRecord, type TheEmissionRecordConnection, type TheEmissionScope, type TheEmissionsApi, type TheFileRef, type TheInventoryApi, type TheInventoryLot, type TheInventoryLotConnection, type TheInventoryStatus, type TheOfftakeContract, type TheOfftakeContractConnection, type ThePageInfo, type ThePaginationInput, type ThePricingBasis, type TheProductionApi, type TheProductionRecord, type TheProductionRecordConnection, type TheRecordEmissionInput, type TheRecordProductionInput, type TheReserveCategory, type TheReserveEstimate, type TheReservesApi, type TheShipment, type TheShipmentStatus, type TheShipmentsApi, type TheSystemApi, type TheTransportMode, type TheUnit, type TheUpdateAssetInput, type TheUpdateOfftakeContractInput, type TheglobalfuelApi, theglobalfuelModule as default };