payments/pkg/client/models/components/v3orderadjustment.go

// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.

package components

import (
	"github.com/hanzo-fi/payments/pkg/client/internal/utils"
	"math/big"
	"time"
)

// V3OrderAdjustmentRaw - Untransformed PSP response payload that produced this adjustment. Retained for debugging and replay.
type V3OrderAdjustmentRaw struct {
}

// V3OrderAdjustment - Immutable snapshot of an order's state at a single observation.
// Formance records one adjustment per distinct state the PSP reports
// (status change, fill progress, fee update). Events are emitted
// per-adjustment, not per-order — so a single order can produce many
// events over its lifetime.
type V3OrderAdjustment struct {
	// Adjustment ID, composed from the order ID plus the state fields that define uniqueness (status, filled quantity, fee). Idempotent — replaying the same observation produces the same ID.
	ID string `json:"id"`
	// PSP reference the adjustment belongs to (equal to the parent order's `reference`).
	Reference string `json:"reference"`
	// When Formance observed this state. Not the PSP's own timestamp — reflects ingestion time.
	CreatedAt time.Time `json:"createdAt"`
	// Lifecycle of an order on the exchange.
	// `PENDING` — accepted by the exchange, not yet working.
	// `OPEN` — live on the book, no fills yet.
	// `PARTIALLY_FILLED` — live on the book, some base quantity filled.
	// `FILLED` — fully filled, terminal.
	// `CANCELLED` — cancelled by the user or system, terminal.
	// `FAILED` — rejected by the exchange, terminal. See `error` for details.
	// `EXPIRED` — `timeInForce` elapsed before full fill, terminal.
	//
	Status V3OrderStatusEnum `json:"status"`
	// Base asset filled at this observation, at the base asset's precision.
	BaseQuantityFilled *big.Int `json:"baseQuantityFilled,omitempty"`
	// Cumulative fee at this observation, at `feeAsset` precision.
	Fee *big.Int `json:"fee,omitempty"`
	// Currency the fee is denominated in, in `SYMBOL/precision` form.
	FeeAsset *string           `json:"feeAsset,omitempty"`
	Metadata map[string]string `json:"metadata,omitempty"`
	// Untransformed PSP response payload that produced this adjustment. Retained for debugging and replay.
	Raw *V3OrderAdjustmentRaw `json:"raw,omitempty"`
}

func (v V3OrderAdjustment) MarshalJSON() ([]byte, error) {
	return utils.MarshalJSON(v, "", false)
}

func (v *V3OrderAdjustment) UnmarshalJSON(data []byte) error {
	if err := utils.UnmarshalJSON(data, &v, "", false, false); err != nil {
		return err
	}
	return nil
}

func (o *V3OrderAdjustment) GetID() string {
	if o == nil {
		return ""
	}
	return o.ID
}

func (o *V3OrderAdjustment) GetReference() string {
	if o == nil {
		return ""
	}
	return o.Reference
}

func (o *V3OrderAdjustment) GetCreatedAt() time.Time {
	if o == nil {
		return time.Time{}
	}
	return o.CreatedAt
}

func (o *V3OrderAdjustment) GetStatus() V3OrderStatusEnum {
	if o == nil {
		return V3OrderStatusEnum("")
	}
	return o.Status
}

func (o *V3OrderAdjustment) GetBaseQuantityFilled() *big.Int {
	if o == nil {
		return nil
	}
	return o.BaseQuantityFilled
}

func (o *V3OrderAdjustment) GetFee() *big.Int {
	if o == nil {
		return nil
	}
	return o.Fee
}

func (o *V3OrderAdjustment) GetFeeAsset() *string {
	if o == nil {
		return nil
	}
	return o.FeeAsset
}

func (o *V3OrderAdjustment) GetMetadata() map[string]string {
	if o == nil {
		return nil
	}
	return o.Metadata
}

func (o *V3OrderAdjustment) GetRaw() *V3OrderAdjustmentRaw {
	if o == nil {
		return nil
	}
	return o.Raw
}