mgx 1.0.0__tar.gz

mgx-1.0.0/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.4
+Name: mgx
+Version: 1.0.0
+Summary: MGX Enterprise API
+Home-page: 
+Author: MGX Developer Support
+Author-email: MGX Developer Support <team@openapitools.org>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
+Keywords: OpenAPI,OpenAPI-Generator,MGX Enterprise API
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+
+# mgx
+
+Official Python client for the [MGX Enterprise API](https://developers.mygrainexchange.com).
+
+```bash
+pip install mgx
+```
+
+## Quickstart
+
+The ergonomic client lives in `mgx.overlay`:
+
+```python
+import os
+from mgx.overlay import MgxClient, MgxApiError
+
+mgx = MgxClient(
+    client_id=os.environ["MGX_CLIENT_ID"],
+    client_secret=os.environ["MGX_CLIENT_SECRET"],
+    scopes=["inventory.read", "market.read"],
+    # base_url="https://dashboard.mgx.test/v1",  # for local development
+)
+
+# Auto-paginates the { items, limit, offset, next } envelope.
+for lot in mgx.inventory.list(commodity="wheat", min_quantity=50):
+    print(lot.id, lot.quantity_mt, lot.asking_price.amount if lot.asking_price else None)
+```
+
+## Authentication
+
+- **Client credentials** (read-only data) — pass `client_id` + `client_secret` + `scopes`; the SDK acquires and refreshes the token for you.
+- **Login with MGX** (user-context: bids, trades, teams, cash bids, webhooks) — complete the authorization-code + PKCE flow, then pass the resulting `access_token` (and optionally `refresh_token`) to `MgxClient`.
+
+## Features
+
+- **Resource namespaces** — `inventory`, `market`, `bids`, `trades`, `teams`, `cash_bids`, `webhooks`.
+- **Auto-pagination** — every `list()` returns a generator that follows `next` and yields items lazily.
+- **Idempotency** — `inventory.place_bid()` sends an `Idempotency-Key` automatically (pass `idempotency_key=` to override).
+- **Typed errors** — non-2xx responses raise `MgxApiError` with `status`, `code`, `message`, and `field_errors`.
+
+```python
+try:
+    bid = mgx.inventory.place_bid(
+        "inv_3Kd9aZ",
+        quantity_mt=50,
+        price={"amount": 312.5},
+        delivery={"from": "2026-08-01", "to": "2026-09-30"},
+    )
+except MgxApiError as e:
+    print(e.status, e.code, e.message, e.field_errors)
+```
+
+## Generated code
+
+The `mgx/` client (everything except `mgx/overlay/`) is generated from the OpenAPI
+spec; the ergonomic layer lives in `mgx/overlay/`. Do not hand-edit the generated
+modules — change the API spec and regenerate. See the
+[mgx-sdks](https://github.com/mygrainexchange/mgx-sdks) repo.
+
+## License
+
+MIT

mgx-1.0.0/README.md

@@ -0,0 +1,62 @@
+# mgx
+
+Official Python client for the [MGX Enterprise API](https://developers.mygrainexchange.com).
+
+```bash
+pip install mgx
+```
+
+## Quickstart
+
+The ergonomic client lives in `mgx.overlay`:
+
+```python
+import os
+from mgx.overlay import MgxClient, MgxApiError
+
+mgx = MgxClient(
+    client_id=os.environ["MGX_CLIENT_ID"],
+    client_secret=os.environ["MGX_CLIENT_SECRET"],
+    scopes=["inventory.read", "market.read"],
+    # base_url="https://dashboard.mgx.test/v1",  # for local development
+)
+
+# Auto-paginates the { items, limit, offset, next } envelope.
+for lot in mgx.inventory.list(commodity="wheat", min_quantity=50):
+    print(lot.id, lot.quantity_mt, lot.asking_price.amount if lot.asking_price else None)
+```
+
+## Authentication
+
+- **Client credentials** (read-only data) — pass `client_id` + `client_secret` + `scopes`; the SDK acquires and refreshes the token for you.
+- **Login with MGX** (user-context: bids, trades, teams, cash bids, webhooks) — complete the authorization-code + PKCE flow, then pass the resulting `access_token` (and optionally `refresh_token`) to `MgxClient`.
+
+## Features
+
+- **Resource namespaces** — `inventory`, `market`, `bids`, `trades`, `teams`, `cash_bids`, `webhooks`.
+- **Auto-pagination** — every `list()` returns a generator that follows `next` and yields items lazily.
+- **Idempotency** — `inventory.place_bid()` sends an `Idempotency-Key` automatically (pass `idempotency_key=` to override).
+- **Typed errors** — non-2xx responses raise `MgxApiError` with `status`, `code`, `message`, and `field_errors`.
+
+```python
+try:
+    bid = mgx.inventory.place_bid(
+        "inv_3Kd9aZ",
+        quantity_mt=50,
+        price={"amount": 312.5},
+        delivery={"from": "2026-08-01", "to": "2026-09-30"},
+    )
+except MgxApiError as e:
+    print(e.status, e.code, e.message, e.field_errors)
+```
+
+## Generated code
+
+The `mgx/` client (everything except `mgx/overlay/`) is generated from the OpenAPI
+spec; the ergonomic layer lives in `mgx/overlay/`. Do not hand-edit the generated
+modules — change the API spec and regenerate. See the
+[mgx-sdks](https://github.com/mygrainexchange/mgx-sdks) repo.
+
+## License
+
+MIT

mgx-1.0.0/mgx/__init__.py

@@ -0,0 +1,183 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    MGX Enterprise API
+
+    Public REST API for grain elevators and enterprise buyers. Browse anonymized inventory, place bids, read your team's trades and bids, manage cash bids, subscribe to webhooks, and read market prices. Authenticate with OAuth2 (Login with MGX). Seller identity is never exposed until a trade is paid on both sides.
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# Define package exports
+__all__ = [
+    "BidsApi",
+    "CashBidsApi",
+    "InventoryApi",
+    "ListingsApi",
+    "MarketApi",
+    "TeamsApi",
+    "TradesApi",
+    "WebhooksApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "Bid",
+    "BidEnvelope",
+    "BidGradesInner",
+    "BidPage",
+    "CashBid",
+    "CashBidEnvelope",
+    "CashBidOffer",
+    "CashBidOfferEnvelope",
+    "CashBidOfferPage",
+    "CashBidPage",
+    "Commodity",
+    "Counterparty",
+    "DateWindow",
+    "Deleted",
+    "DeletedData",
+    "DeliveryLocationsGet200Response",
+    "DeliveryLocationsGet200ResponseItemsInner",
+    "Error",
+    "ErrorError",
+    "ErrorErrorErrorsInner",
+    "Inventory",
+    "InventoryEnvelope",
+    "InventoryFilters",
+    "InventoryPage",
+    "Location",
+    "MarketCommodity",
+    "MarketCommodityList",
+    "MarketPrice",
+    "MarketPriceList",
+    "MarketPriceRange",
+    "Money",
+    "Page",
+    "PlaceBid",
+    "PlaceBidBidsInner",
+    "PlaceListing",
+    "PlaceListingQuality",
+    "PlaceListingTargetPrice",
+    "PriceHistory",
+    "PriceHistoryPointsInner",
+    "Quality",
+    "Quantity",
+    "StoreCashBid",
+    "StoreCashBidDelivery",
+    "StoreFarm",
+    "Team",
+    "TeamEnvelope",
+    "TeamList",
+    "Trade",
+    "TradeEnvelope",
+    "TradePage",
+    "UpdateCashBid",
+    "UpdateCashBidDelivery",
+    "Webhook",
+    "WebhookCreated",
+    "WebhookCreatedEnvelope",
+    "WebhookDelivery",
+    "WebhookDeliveryPage",
+    "WebhookEvent",
+    "WebhookEventType",
+    "WebhookList",
+    "WebhookResource",
+]
+
+# import apis into sdk package
+from mgx.api.bids_api import BidsApi as BidsApi
+from mgx.api.cash_bids_api import CashBidsApi as CashBidsApi
+from mgx.api.inventory_api import InventoryApi as InventoryApi
+from mgx.api.listings_api import ListingsApi as ListingsApi
+from mgx.api.market_api import MarketApi as MarketApi
+from mgx.api.teams_api import TeamsApi as TeamsApi
+from mgx.api.trades_api import TradesApi as TradesApi
+from mgx.api.webhooks_api import WebhooksApi as WebhooksApi
+
+# import ApiClient
+from mgx.api_response import ApiResponse as ApiResponse
+from mgx.api_client import ApiClient as ApiClient
+from mgx.configuration import Configuration as Configuration
+from mgx.exceptions import OpenApiException as OpenApiException
+from mgx.exceptions import ApiTypeError as ApiTypeError
+from mgx.exceptions import ApiValueError as ApiValueError
+from mgx.exceptions import ApiKeyError as ApiKeyError
+from mgx.exceptions import ApiAttributeError as ApiAttributeError
+from mgx.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from mgx.models.bid import Bid as Bid
+from mgx.models.bid_envelope import BidEnvelope as BidEnvelope
+from mgx.models.bid_grades_inner import BidGradesInner as BidGradesInner
+from mgx.models.bid_page import BidPage as BidPage
+from mgx.models.cash_bid import CashBid as CashBid
+from mgx.models.cash_bid_envelope import CashBidEnvelope as CashBidEnvelope
+from mgx.models.cash_bid_offer import CashBidOffer as CashBidOffer
+from mgx.models.cash_bid_offer_envelope import CashBidOfferEnvelope as CashBidOfferEnvelope
+from mgx.models.cash_bid_offer_page import CashBidOfferPage as CashBidOfferPage
+from mgx.models.cash_bid_page import CashBidPage as CashBidPage
+from mgx.models.commodity import Commodity as Commodity
+from mgx.models.counterparty import Counterparty as Counterparty
+from mgx.models.date_window import DateWindow as DateWindow
+from mgx.models.deleted import Deleted as Deleted
+from mgx.models.deleted_data import DeletedData as DeletedData
+from mgx.models.delivery_locations_get200_response import DeliveryLocationsGet200Response as DeliveryLocationsGet200Response
+from mgx.models.delivery_locations_get200_response_items_inner import DeliveryLocationsGet200ResponseItemsInner as DeliveryLocationsGet200ResponseItemsInner
+from mgx.models.error import Error as Error
+from mgx.models.error_error import ErrorError as ErrorError
+from mgx.models.error_error_errors_inner import ErrorErrorErrorsInner as ErrorErrorErrorsInner
+from mgx.models.inventory import Inventory as Inventory
+from mgx.models.inventory_envelope import InventoryEnvelope as InventoryEnvelope
+from mgx.models.inventory_filters import InventoryFilters as InventoryFilters
+from mgx.models.inventory_page import InventoryPage as InventoryPage
+from mgx.models.location import Location as Location
+from mgx.models.market_commodity import MarketCommodity as MarketCommodity
+from mgx.models.market_commodity_list import MarketCommodityList as MarketCommodityList
+from mgx.models.market_price import MarketPrice as MarketPrice
+from mgx.models.market_price_list import MarketPriceList as MarketPriceList
+from mgx.models.market_price_range import MarketPriceRange as MarketPriceRange
+from mgx.models.money import Money as Money
+from mgx.models.page import Page as Page
+from mgx.models.place_bid import PlaceBid as PlaceBid
+from mgx.models.place_bid_bids_inner import PlaceBidBidsInner as PlaceBidBidsInner
+from mgx.models.place_listing import PlaceListing as PlaceListing
+from mgx.models.place_listing_quality import PlaceListingQuality as PlaceListingQuality
+from mgx.models.place_listing_target_price import PlaceListingTargetPrice as PlaceListingTargetPrice
+from mgx.models.price_history import PriceHistory as PriceHistory
+from mgx.models.price_history_points_inner import PriceHistoryPointsInner as PriceHistoryPointsInner
+from mgx.models.quality import Quality as Quality
+from mgx.models.quantity import Quantity as Quantity
+from mgx.models.store_cash_bid import StoreCashBid as StoreCashBid
+from mgx.models.store_cash_bid_delivery import StoreCashBidDelivery as StoreCashBidDelivery
+from mgx.models.store_farm import StoreFarm as StoreFarm
+from mgx.models.team import Team as Team
+from mgx.models.team_envelope import TeamEnvelope as TeamEnvelope
+from mgx.models.team_list import TeamList as TeamList
+from mgx.models.trade import Trade as Trade
+from mgx.models.trade_envelope import TradeEnvelope as TradeEnvelope
+from mgx.models.trade_page import TradePage as TradePage
+from mgx.models.update_cash_bid import UpdateCashBid as UpdateCashBid
+from mgx.models.update_cash_bid_delivery import UpdateCashBidDelivery as UpdateCashBidDelivery
+from mgx.models.webhook import Webhook as Webhook
+from mgx.models.webhook_created import WebhookCreated as WebhookCreated
+from mgx.models.webhook_created_envelope import WebhookCreatedEnvelope as WebhookCreatedEnvelope
+from mgx.models.webhook_delivery import WebhookDelivery as WebhookDelivery
+from mgx.models.webhook_delivery_page import WebhookDeliveryPage as WebhookDeliveryPage
+from mgx.models.webhook_event import WebhookEvent as WebhookEvent
+from mgx.models.webhook_event_type import WebhookEventType as WebhookEventType
+from mgx.models.webhook_list import WebhookList as WebhookList
+from mgx.models.webhook_resource import WebhookResource as WebhookResource

mgx-1.0.0/mgx/api/__init__.py

@@ -0,0 +1,12 @@
+# flake8: noqa
+
+# import apis into api package
+from mgx.api.bids_api import BidsApi
+from mgx.api.cash_bids_api import CashBidsApi
+from mgx.api.inventory_api import InventoryApi
+from mgx.api.listings_api import ListingsApi
+from mgx.api.market_api import MarketApi
+from mgx.api.teams_api import TeamsApi
+from mgx.api.trades_api import TradesApi
+from mgx.api.webhooks_api import WebhooksApi
+