shopware-api-client 1.0.118__py3-none-any.whl → 1.1.1__py3-none-any.whl

shopware_api_client/models/media_thumbnail.py

@@ -0,0 +1,15 @@
+from pydantic import Field
+
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class MediaThumbnailBase(ApiModelBase, CustomFieldsMixin):
+    _identifier = "media_thumbnail"
+
+    media_id: IdField
+    media_thumbnail_size_id: IdField | None = None  # Will get required with 6.8.0
+    width: int = Field(default=0, exclude=True)
+    height: int = Field(default=0, exclude=True)
+    url: str | None = Field(default=None, description="Runtime field, cannot be used as part of the criteria.")
+    path: str | None = None

shopware_api_client/models/media_thumbnail_size.py

@@ -0,0 +1,8 @@
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+
+
+class MediaThumbnailSizeBase(ApiModelBase, CustomFieldsMixin):
+    _identifier = "media_thumbnail_size"
+
+    width: int
+    height: int

shopware_api_client/models/order.py

@@ -0,0 +1,36 @@
+from datetime import date
+
+from pydantic import AwareDatetime, Field
+
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import Amount, Price, IdField
+
+
+class OrderBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "order"
+
+    auto_increment: int | None = Field(default=None, exclude=True)
+    order_number: str | None = None
+    billing_address_id: IdField
+    billing_address_version_id: IdField | None = None
+    currency_id: IdField
+    language_id: IdField
+    sales_channel_id: IdField
+    order_date_time: AwareDatetime
+    order_date: date | None = Field(default=None, exclude=True)
+    price: Price | None = None
+    amount_total: float | None = Field(default=None, exclude=True)
+    amount_net: float | None = Field(default=None, exclude=True)
+    position_price: float | None = Field(default=None, exclude=True)
+    tax_status: str | None = Field(default=None, exclude=True)
+    shipping_costs: Amount | None = None
+    shipping_total: float | None = Field(default=None, exclude=True)
+    currency_factor: float
+    deep_link_code: str | None = None
+    affiliate_code: str | None = None
+    campaign_code: str | None = None
+    customer_comment: str | None = None
+    source: str | None = None
+    rule_ids: list[str] | None = None
+    created_by_id: IdField | None = None
+    updated_by_id: IdField | None = None

shopware_api_client/models/order_address.py

@@ -0,0 +1,23 @@
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class OrderAddressBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "order_address"
+
+    country_id: IdField
+    country_state_id: IdField | None = None
+    order_version_id: IdField | None = None
+    salutation_id: IdField | None = None
+    first_name: str
+    last_name: str
+    street: str
+    zipcode: str | None = None
+    city: str
+    company: str | None = None
+    department: str | None = None
+    title: str | None = None
+    vat_id: str | None = None
+    phone_number: str | None = None
+    additional_address_line1: str | None = None
+    additional_address_line2: str | None = None

shopware_api_client/models/order_customer.py

@@ -0,0 +1,18 @@
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class OrderCustomerBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "order_customer"
+
+    customer_id: IdField | None = None
+    order_version_id: IdField | None = None
+    email: str
+    salutation_id: IdField | None = None
+    first_name: str
+    last_name: str
+    company: str | None = None
+    title: str | None = None
+    vat_ids: list[str] | None = None
+    customer_number: str | None = None
+    remote_address: str | None = None

shopware_api_client/models/order_delivery.py

@@ -0,0 +1,19 @@
+from pydantic import AwareDatetime, Field
+
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import Amount, IdField
+
+
+class OrderDeliveryBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "order_delivery"
+
+    order_id: IdField
+    order_version_id: IdField | None = None
+    shipping_order_address_id: IdField
+    shipping_order_address_version_id: IdField | None = None
+    shipping_method_id: IdField
+    state_id: IdField = Field(..., exclude=True)
+    tracking_codes: list[str]
+    shipping_date_earliest: AwareDatetime
+    shipping_date_latest: AwareDatetime
+    shipping_costs: Amount | None = None

shopware_api_client/models/order_delivery_position.py

@@ -0,0 +1,15 @@
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import IdField, Price
+
+
+class OrderDeliveryPositionBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "order_delivery_position"
+
+    order_delivery_id: IdField
+    order_delivery_version_id: IdField | None = None
+    order_line_item_id: IdField
+    order_line_item_version_id: IdField | None = None
+    price: Price | None = None
+    unit_price: float | None = None
+    total_price: float | None = None
+    quantity: int | None = None

shopware_api_client/models/order_line_item.py

@@ -0,0 +1,34 @@
+from typing import Any
+
+from pydantic import Field
+
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class OrderLineItemBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "order_line_item"
+
+    order_id: IdField
+    order_version_id: IdField | None = None
+    product_id: IdField | None = None
+    product_version_id: IdField | None = None
+    promotion_id: IdField | None = Field(default=None, exclude=True)
+    parent_id: IdField | None = None
+    parent_version_id: IdField | None = None
+    cover_id: IdField | None = None
+    identifier: str
+    referenced_id: str | None = None
+    quantity: int
+    label: str
+    payload: dict[str, Any] | list | None = None
+    good: bool | None = None
+    removable: bool | None = None
+    stackable: bool | None = None
+    position: int
+    states: list[str]
+    price_definition: dict[str, Any] | None = None
+    unit_price: float | None = None
+    total_price: float | None = None
+    description: str | None = None
+    type: str | None = None

shopware_api_client/models/order_line_item_download.py

@@ -0,0 +1,12 @@
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class OrderLineItemDownloadBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "order_line_item_download"
+
+    order_line_item_id: IdField
+    order_line_item_version_id: IdField | None = None
+    media_id: IdField
+    position: int
+    access_granted: bool

shopware_api_client/models/order_transaction.py

@@ -0,0 +1,15 @@
+from pydantic import Field
+
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import Amount, IdField
+
+
+class OrderTransactionBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "order_transaction"
+
+    version_id: IdField | None = None
+    order_id: IdField
+    order_version_id: IdField | None = None
+    payment_method_id: IdField
+    amount: Amount
+    state_id: IdField = Field(..., exclude=True)

shopware_api_client/models/order_transaction_capture.py

@@ -0,0 +1,15 @@
+from pydantic import Field
+
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import Amount, IdField
+
+
+class OrderTransactionCaptureBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "order_transaction_capture"
+
+    version_id: IdField | None = None
+    order_transaction_id: IdField
+    order_transaction_version_id: IdField | None = None
+    state_id: IdField = Field(..., exclude=True)
+    external_reference: str | None = None
+    amount: Amount

shopware_api_client/models/order_transaction_capture_refund.py

@@ -0,0 +1,16 @@
+from pydantic import Field
+
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import Amount, IdField
+
+
+class OrderTransactionCaptureRefundBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "order_transaction_capture_refund"
+
+    version_id: IdField | None = None
+    capture_id: IdField
+    capture_version_id: IdField | None = None
+    state_id: IdField = Field(..., exclude=True)
+    external_reference: str | None = None
+    reason: str | None = None
+    amount: Amount

shopware_api_client/models/order_transaction_capture_refund_position.py

@@ -0,0 +1,15 @@
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import Amount, IdField
+
+
+class OrderTransactionCaptureRefundPositionBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "order_transaction_capture_refund_position"
+
+    refund_id: IdField
+    refund_version_id: IdField | None = None
+    order_line_item_id: IdField
+    order_line_item_version_id: IdField | None = None
+    external_reference: str | None = None
+    reason: str | None = None
+    quantity: int | None = None
+    amount: Amount

shopware_api_client/models/payment_method.py

@@ -0,0 +1,29 @@
+from pydantic import Field
+
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import IdField
+
+_FILED_DESCRIPTION = "Runtime field, cannot be used as part of the criteria."
+
+
+class PaymentMethodBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "payment_method"
+
+    plugin_id: IdField | None = None
+    handler_identifier: str | None = None
+    name: str
+    distinguishable_name: str | None = Field(default=None, exclude=True)
+    description: str | None = None
+    position: int | None = None
+    active: bool | None = None
+    after_order_enabled: bool | None = None
+    availability_rule_id: IdField | None = None
+    media_id: IdField | None = None
+    formatted_handler_identifier: str | None = Field(None, description=_FILED_DESCRIPTION, exclude=True)
+    synchronous: bool | None = Field(None, description=_FILED_DESCRIPTION, exclude=True)
+    asynchronous: bool | None = Field(None, description=_FILED_DESCRIPTION, exclude=True)
+    prepared: bool | None = Field(None, description=_FILED_DESCRIPTION, exclude=True)
+    refundable: bool | None = Field(None, description=_FILED_DESCRIPTION, exclude=True)
+    recurring: bool | None = Field(None, description=_FILED_DESCRIPTION, exclude=True)
+    short_name: str | None = Field(None, description=_FILED_DESCRIPTION)
+    technical_name: str | None = Field(default=None, exclude=True)

shopware_api_client/models/product.py

@@ -0,0 +1,72 @@
+from typing import Any
+from pydantic import AwareDatetime, Field
+
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import IdField
+from shopware_api_client.structs.variant_listing_config import VariantListingConfig
+
+
+class ProductBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "product"
+
+    parent_id: IdField | None = None
+    parent_version_id: IdField | None = None
+    manufacturer_id: IdField | None = None
+    product_manufacturer_version_id: IdField | None = None
+    unit_id: IdField | None = None
+    tax_id: IdField | None = None
+    cover_id: IdField | None = None
+    product_media_version_id: IdField | None = None
+    delivery_time_id: IdField | None = None
+    feature_set_id: IdField | None = None
+    canonical_product_id: IdField | None = None
+    cms_page_id: IdField | None = None
+    cms_page_version_id: IdField | None = None
+    price: list[dict[str, Any]] | None = None
+    product_number: str
+    restock_time: int | None = None
+    auto_increment: int | None = Field(default=None, exclude=True)
+    active: bool | None = None
+    available: bool | None = Field(default=None, exclude=True)
+    is_closeout: bool | None = None
+    variation: list[str] | None = None
+    display_group: str | None = Field(default=None, exclude=True)
+    variant_listing_config: VariantListingConfig | None = None
+    variant_restrictions: dict[str, Any] | None = None
+    manufacturer_number: str | None = None
+    ean: str | None = None
+    purchase_steps: int | None = None
+    max_purchase: int | None = None
+    min_purchase: int | None = None
+    purchase_unit: float | None = None
+    reference_unit: float | None = None
+    shipping_free: bool | None = None
+    purchase_prices: list[dict[str, Any]] | None = None
+    mark_as_topseller: bool | None = None
+    weight: float | None = None
+    width: float | None = None
+    height: float | None = None
+    length: float | None = None
+    release_date: AwareDatetime | None = None
+    rating_average: float | None = Field(default=None, exclude=True)
+    category_tree: list[IdField] | None = Field(default=None, exclude=True)
+    property_ids: list[IdField] | None = Field(default=None, exclude=True)
+    option_ids: list[IdField] | None = Field(default=None, exclude=True)
+    stream_ids: list[IdField] | None = Field(default=None, exclude=True)
+    tag_ids: list[IdField] | None = Field(default=None, exclude=True)
+    category_ids: list[IdField] | None = Field(default=None, exclude=True)
+    child_count: int | None = Field(default=None, exclude=True)
+    custom_field_set_selection_active: bool | None = None
+    sales: int | None = Field(default=None, exclude=True)
+    states: list[str] | None = Field(default=None, exclude=True)
+    meta_description: str | None = None
+    name: str | None = None
+    keywords: str | None = None
+    description: str | None = None
+    meta_title: str | None = None
+    pack_unit: str | None = None
+    pack_unit_plural: str | None = None
+    slot_config: dict[str, Any] | list | None = None
+    custom_search_keywords: list[str] | None = None
+    available_stock: int | None = Field(default=None, exclude=True)
+    stock: int | None = None

shopware_api_client/models/product_configurator_setting.py

@@ -0,0 +1,14 @@
+from typing import Any
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class ProductConfiguratorSettingBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "product_configurator_setting"
+
+    product_id: IdField
+    product_version_id: IdField | None = None
+    media_id: IdField | None = None
+    option_id: IdField
+    price: dict[str, Any] | None = None
+    position: int | None = None

shopware_api_client/models/product_cross_selling.py

@@ -0,0 +1,17 @@
+from shopware_api_client.base import ApiModelBase
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class ProductCrossSellingBase(ApiModelBase):
+    _identifier: str = "product_cross_selling"
+
+    name: str
+    position: int
+    sort_by: str | None = None
+    sort_direction: str | None = None
+    type: str
+    active: bool | None = None
+    limit: int | None = None
+    product_id: IdField
+    product_version_id: IdField | None = None
+    product_stream_id: IdField | None = None

shopware_api_client/models/product_cross_selling_assigned_products.py

@@ -0,0 +1,11 @@
+from shopware_api_client.base import ApiModelBase
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class ProductCrossSellingAssignedProductsBase(ApiModelBase):
+    _identifier: str = "product_cross_selling_assigned_products"
+
+    cross_selling_id: IdField
+    product_id: IdField
+    product_version_id: IdField | None = None
+    position: int | None = None

shopware_api_client/models/product_download.py

@@ -0,0 +1,11 @@
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class ProductDownloadBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "product_download"
+
+    product_id: IdField
+    product_version_id: IdField | None = None
+    media_id: IdField
+    position: int | None = None

shopware_api_client/models/product_export.py

@@ -0,0 +1,27 @@
+from pydantic import AwareDatetime
+
+from shopware_api_client.base import ApiModelBase
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class ProductExportBase(ApiModelBase):
+    _identifier: str = "product_export"
+
+    product_stream_id: IdField
+    storefront_sales_channel_id: IdField
+    sales_channel_id: IdField
+    sales_channel_domain_id: IdField
+    currency_id: IdField
+    file_name: str
+    access_key: str
+    encoding: str
+    file_format: str
+    include_variants: bool | None = None
+    generate_by_cronjob: bool
+    generated_at: AwareDatetime | None = None
+    interval: int
+    header_template: str | None = None
+    body_template: str | None = None
+    footer_template: str | None = None
+    paused_schedule: bool | None = None
+    is_running: bool | None = None

shopware_api_client/models/product_feature_set.py

@@ -0,0 +1,11 @@
+from typing import Any
+
+from shopware_api_client.base import ApiModelBase
+
+
+class ProductFeatureSetBase(ApiModelBase):
+    _identifier: str = "product_feature_set"
+
+    name: str
+    description: str | None = None
+    features: dict[str, Any] | None = None

shopware_api_client/models/product_manufacturer.py

@@ -0,0 +1,11 @@
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class ProductManufacturerBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "product_manufacturer"
+
+    media_id: IdField | None = None
+    link: str | None = None
+    name: str
+    description: str | None = None

shopware_api_client/models/product_media.py

@@ -0,0 +1,11 @@
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class ProductMediaBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "product_media"
+
+    product_id: IdField
+    product_version_id: IdField | None = None
+    media_id: IdField
+    position: int | None = None

shopware_api_client/models/product_price.py

@@ -0,0 +1,15 @@
+from typing import Any
+
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class ProductPriceBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "product_price"
+
+    product_id: IdField
+    product_version_id: IdField | None = None
+    rule_id: IdField
+    price: dict[str, Any]
+    quantity_start: int
+    quantity_end: int | None = None

shopware_api_client/models/product_review.py

@@ -0,0 +1,19 @@
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class ProductReviewBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "product_review"
+
+    product_id: IdField
+    product_version_id: IdField | None = None
+    customer_id: IdField | None = None
+    sales_channel_id: IdField
+    language_id: IdField
+    external_user: str | None = None
+    external_email: str | None = None
+    title: str
+    content: str
+    points: float | None = None
+    status: bool | None = None
+    comment: str | None = None

shopware_api_client/models/product_search_keyword.py

@@ -0,0 +1,13 @@
+from shopware_api_client.base import ApiModelBase
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class ProductSearchKeywordBase(ApiModelBase):
+    _identifier: str = "product_search_keyword"
+
+    version_id: IdField | None = None
+    language_id: IdField
+    product_id: IdField
+    product_version_id: IdField | None = None
+    keyword: str
+    ranking: float

shopware_api_client/models/product_stream.py

@@ -0,0 +1,14 @@
+from typing import Any
+
+from pydantic import Field
+
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+
+
+class ProductStreamBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "product_stream"
+
+    api_filter: dict[str, Any] | None = Field(default=None, exclude=True)
+    invalid: bool | None = Field(default=None, exclude=True)
+    name: str
+    description: str | None = None

shopware_api_client/models/product_visibility.py

@@ -0,0 +1,11 @@
+from shopware_api_client.base import ApiModelBase
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class ProductVisibilityBase(ApiModelBase):
+    _identifier: str = "product_visibility"
+
+    product_id: IdField
+    product_version_id: IdField | None = None
+    sales_channel_id: IdField
+    visibility: int

shopware_api_client/models/product_warehouse.py

@@ -0,0 +1,10 @@
+from shopware_api_client.base import ApiModelBase
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class ProductWarehouseBase(ApiModelBase):
+    _identifier = "product_warehouse"
+
+    stock: int
+    product_id: IdField
+    warehouse_id: IdField

shopware_api_client/models/promotion.py

@@ -0,0 +1,29 @@
+from typing import Any
+
+from pydantic import AwareDatetime, Field
+
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class PromotionBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "promotion"
+
+    name: str
+    active: bool
+    valid_from: AwareDatetime | None = None
+    valid_until: AwareDatetime | None = None
+    max_redemptions_global: int | None = None
+    max_redemptions_per_customer: int | None = None
+    priority: int
+    exclusive: bool
+    code: str | None = None
+    use_codes: bool
+    use_individual_codes: bool
+    individual_code_pattern: str | None = None
+    use_set_groups: bool
+    customer_restriction: bool | None = None
+    prevent_combination: bool
+    order_count: int | None = Field(default=None, exclude=True)
+    orders_per_customer_count: dict[str, Any] | None = Field(default=None, exclude=True)
+    exclusion_ids: list[IdField] | None = None

shopware_api_client/models/promotion_discount.py

@@ -0,0 +1,17 @@
+from shopware_api_client.base import ApiModelBase
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class PromotionDiscountBase(ApiModelBase):
+    _identifier: str = "promotion_discount"
+
+    promotion_id: IdField
+    scope: str
+    type: str
+    value: float
+    consider_advanced_rules: bool
+    max_value: float | None = None
+    sorter_key: str | None = None
+    applier_key: str | None = None
+    usage_key: str | None = None
+    picker_key: str | None = None

shopware_api_client/models/promotion_discount_prices.py

@@ -0,0 +1,10 @@
+from shopware_api_client.base import ApiModelBase
+from shopware_api_client.endpoints.base_fields import IdField
+
+
+class PromotionDiscountPricesBase(ApiModelBase):
+    _identifier: str = "promotion_discount_prices"
+
+    discount_id: IdField
+    currency_id: IdField
+    price: float

shopware_api_client/models/property_group.py

@@ -0,0 +1,13 @@
+from shopware_api_client.base import ApiModelBase, CustomFieldsMixin
+
+
+class PropertyGroupBase(ApiModelBase, CustomFieldsMixin):
+    _identifier: str = "property_group"
+
+    name: str
+    description: str | None = None
+    display_type: str
+    sorting_type: str
+    filterable: bool | None = None
+    visible_on_product_detail_page: bool | None = None
+    position: int | None = None