MPT-19057: add first-level field annotations to commerce resource models

mpt_api_client/resources/commerce/agreements.py

@@ -6,6 +6,7 @@
     ManagedResourceMixin,
 )
 from mpt_api_client.models import Model
+from mpt_api_client.models.model import BaseModel
 from mpt_api_client.resources.commerce.agreements_attachments import (
     AgreementsAttachmentService,
     AsyncAgreementsAttachmentService,
@@ -19,7 +20,61 @@
 
 
 class Agreement(Model):
-    """Agreement resource."""
+    """Agreement resource.
+
+    Attributes:
+        icon: URL or identifier for the agreement icon.
+        status: Agreement status.
+        name: Agreement name.
+        start_date: Agreement start date.
+        end_date: Agreement end date.
+        listing: Reference to the listing.
+        authorization: Reference to the authorization.
+        vendor: Reference to the vendor account.
+        client: Reference to the client account.
+        price: Price information.
+        template: Reference to the template.
+        error: Error information.
+        lines: List of agreement lines.
+        assets: List of assets.
+        subscriptions: List of subscriptions.
+        parameters: Agreement parameters.
+        licensee: Reference to the licensee.
+        buyer: Reference to the buyer.
+        seller: Reference to the seller.
+        product: Reference to the product.
+        external_ids: External identifiers.
+        split: Split billing information.
+        terms_and_conditions: List of terms and conditions.
+        certificates: List of certificates.
+        audit: Audit information.
+    """
+
+    icon: str | None
+    status: str | None
+    name: str | None
+    start_date: str | None
+    end_date: str | None
+    listing: BaseModel | None
+    authorization: BaseModel | None
+    vendor: BaseModel | None
+    client: BaseModel | None
+    price: BaseModel | None
+    template: BaseModel | None
+    error: BaseModel | None
+    lines: list[BaseModel] | None
+    assets: list[BaseModel] | None
+    subscriptions: list[BaseModel] | None
+    parameters: BaseModel | None  # noqa: WPS110
+    licensee: BaseModel | None
+    buyer: BaseModel | None
+    seller: BaseModel | None
+    product: BaseModel | None
+    external_ids: BaseModel | None
+    split: BaseModel | None
+    terms_and_conditions: list[BaseModel] | None
+    certificates: list[BaseModel] | None
+    audit: BaseModel | None
 
 
 class AgreementsServiceConfig:

mpt_api_client/resources/commerce/agreements_attachments.py

@@ -14,10 +14,19 @@
     UpdateMixin,
 )
 from mpt_api_client.models import Model
+from mpt_api_client.models.model import BaseModel
 
 
 class AgreementAttachment(Model):
-    """Agreement attachment resource."""
+    """Agreement attachment resource.
+
+    Attributes:
+        attachment: Attachment metadata.
+        file: File reference or URL.
+    """
+
+    attachment: BaseModel | None
+    file: str | None  # noqa: WPS110
 
 
 class AgreementsAttachmentServiceConfig:

mpt_api_client/resources/commerce/assets.py

@@ -10,6 +10,7 @@
     UpdateMixin,
 )
 from mpt_api_client.models import Model
+from mpt_api_client.models.model import BaseModel
 from mpt_api_client.resources.commerce.mixins import (
     AsyncRenderMixin,
     AsyncTerminateMixin,
@@ -19,7 +20,39 @@
 
 
 class Asset(Model):
-    """Asset resource."""
+    """Asset resource.
+
+    Attributes:
+        name: Asset name.
+        status: Asset status.
+        external_ids: External identifiers.
+        price: Price information.
+        template: Reference to the template.
+        parameters: Asset parameters.
+        terms: Reference to terms and conditions.
+        agreement: Reference to the agreement.
+        product: Reference to the product.
+        price_list: Reference to the price list.
+        listing: Reference to the listing.
+        licensee: Reference to the licensee.
+        lines: List of asset lines.
+        audit: Audit information.
+    """
+
+    name: str | None
+    status: str | None
+    external_ids: BaseModel | None
+    price: BaseModel | None
+    template: BaseModel | None
+    parameters: BaseModel | None  # noqa: WPS110
+    terms: BaseModel | None
+    agreement: BaseModel | None
+    product: BaseModel | None
+    price_list: BaseModel | None
+    listing: BaseModel | None
+    licensee: BaseModel | None
+    lines: list[BaseModel] | None
+    audit: BaseModel | None
 
 
 class AssetTemplate(Model):

mpt_api_client/resources/commerce/orders.py

@@ -9,6 +9,7 @@
     ManagedResourceMixin,
 )
 from mpt_api_client.models import Model, ResourceData
+from mpt_api_client.models.model import BaseModel
 from mpt_api_client.resources.commerce.mixins import (
     AsyncRenderMixin,
     AsyncTemplateMixin,
@@ -26,7 +27,69 @@
 
 
 class Order(Model):
-    """Order resource."""
+    """Order resource.
+
+    Attributes:
+        type: Order type.
+        status: Order status.
+        notes: Order notes.
+        comments: Order comments.
+        default_markup_source: Default markup source.
+        status_notes: Status notes details.
+        template: Reference to the template.
+        listing: Reference to the listing.
+        authorization: Reference to the authorization.
+        agreement: Reference to the agreement.
+        assignee: Reference to the assignee.
+        external_ids: External identifiers.
+        price: Price information.
+        lines: List of order lines.
+        subscriptions: List of subscriptions.
+        assets: List of assets.
+        parameters: Order parameters.
+        error: Error information.
+        product: Reference to the product.
+        client: Reference to the client account.
+        licensee: Reference to the licensee.
+        buyer: Reference to the buyer.
+        seller: Reference to the seller.
+        vendor: Reference to the vendor account.
+        bill_to: Bill-to address.
+        pricing_policy: Reference to the pricing policy.
+        terms_and_conditions: List of terms and conditions.
+        certificates: List of certificates.
+        audit: Audit information.
+    """
+
+    type: str | None
+    status: str | None
+    notes: str | None
+    comments: str | None
+    default_markup_source: str | None
+    status_notes: BaseModel | None
+    template: BaseModel | None
+    listing: BaseModel | None
+    authorization: BaseModel | None
+    agreement: BaseModel | None
+    assignee: BaseModel | None
+    external_ids: BaseModel | None
+    price: BaseModel | None
+    lines: list[BaseModel] | None
+    subscriptions: list[BaseModel] | None
+    assets: list[BaseModel] | None
+    parameters: BaseModel | None  # noqa: WPS110
+    error: BaseModel | None
+    product: BaseModel | None
+    client: BaseModel | None
+    licensee: BaseModel | None
+    buyer: BaseModel | None
+    seller: BaseModel | None
+    vendor: BaseModel | None
+    bill_to: BaseModel | None
+    pricing_policy: BaseModel | None
+    terms_and_conditions: list[BaseModel] | None
+    certificates: list[BaseModel] | None
+    audit: BaseModel | None
 
 
 class OrdersServiceConfig:

mpt_api_client/resources/commerce/orders_asset.py

@@ -6,11 +6,34 @@
     ManagedResourceMixin,
 )
 from mpt_api_client.models import Model
+from mpt_api_client.models.model import BaseModel
 from mpt_api_client.resources.commerce.mixins import AsyncRenderMixin, RenderMixin
 
 
 class OrdersAsset(Model):
-    """Orders Asset resource."""
+    """Orders Asset resource.
+
+    Attributes:
+        name: Asset name.
+        status: Asset status.
+        external_ids: External identifiers.
+        price: Price information.
+        template: Reference to the template.
+        parameters: Asset parameters.
+        terms: Reference to terms and conditions.
+        lines: List of asset lines.
+        audit: Audit information.
+    """
+
+    name: str | None
+    status: str | None
+    external_ids: BaseModel | None
+    price: BaseModel | None
+    template: BaseModel | None
+    parameters: BaseModel | None  # noqa: WPS110
+    terms: BaseModel | None
+    lines: list[BaseModel] | None
+    audit: BaseModel | None
 
 
 class OrdersAssetServiceConfig:

mpt_api_client/resources/commerce/orders_subscription.py

@@ -6,10 +6,45 @@
     ManagedResourceMixin,
 )
 from mpt_api_client.models import Model
+from mpt_api_client.models.model import BaseModel
 
 
 class OrderSubscription(Model):
-    """Order Subscription resource."""
+    """Order Subscription resource.
+
+    Attributes:
+        name: Subscription name.
+        status: Subscription status.
+        start_date: Subscription start date.
+        termination_date: Subscription termination date.
+        commitment_date: Subscription commitment date.
+        auto_renew: Whether the subscription auto-renews.
+        external_ids: External identifiers.
+        terms: Reference to terms and conditions.
+        product: Reference to the product.
+        parameters: Subscription parameters.
+        agreement: Reference to the agreement.
+        price: Price information.
+        template: Reference to the template.
+        lines: List of subscription lines.
+        audit: Audit information.
+    """
+
+    name: str | None
+    status: str | None
+    start_date: str | None
+    termination_date: str | None
+    commitment_date: str | None
+    auto_renew: bool | None
+    external_ids: BaseModel | None
+    terms: BaseModel | None
+    product: BaseModel | None
+    parameters: BaseModel | None  # noqa: WPS110
+    agreement: BaseModel | None
+    price: BaseModel | None
+    template: BaseModel | None
+    lines: list[BaseModel] | None
+    audit: BaseModel | None
 
 
 class OrderSubscriptionsServiceConfig:

mpt_api_client/resources/commerce/subscriptions.py

@@ -13,6 +13,7 @@
     UpdateMixin,
 )
 from mpt_api_client.models import Model
+from mpt_api_client.models.model import BaseModel
 from mpt_api_client.resources.commerce.mixins import (
     AsyncRenderMixin,
     AsyncTerminateMixin,
@@ -22,7 +23,51 @@
 
 
 class Subscription(Model):
-    """Subscription resource."""
+    """Subscription resource.
+
+    Attributes:
+        name: Subscription name.
+        status: Subscription status.
+        start_date: Subscription start date.
+        termination_date: Subscription termination date.
+        commitment_date: Subscription commitment date.
+        split_status: Split billing status.
+        auto_renew: Whether the subscription auto-renews.
+        external_ids: External identifiers.
+        terms: Reference to terms and conditions.
+        product: Reference to the product.
+        price: Price information.
+        parameters: Subscription parameters.
+        agreement: Reference to the agreement.
+        buyer: Reference to the buyer.
+        licensee: Reference to the licensee.
+        seller: Reference to the seller.
+        split: Split billing information.
+        template: Reference to the template.
+        lines: List of subscription lines.
+        audit: Audit information.
+    """
+
+    name: str | None
+    status: str | None
+    start_date: str | None
+    termination_date: str | None
+    commitment_date: str | None
+    split_status: str | None
+    auto_renew: bool | None
+    external_ids: BaseModel | None
+    terms: BaseModel | None
+    product: BaseModel | None
+    price: BaseModel | None
+    parameters: BaseModel | None  # noqa: WPS110
+    agreement: BaseModel | None
+    buyer: BaseModel | None
+    licensee: BaseModel | None
+    seller: BaseModel | None
+    split: BaseModel | None
+    template: BaseModel | None
+    lines: list[BaseModel] | None
+    audit: BaseModel | None
 
 
 class SubscriptionsServiceConfig: