bidkit 0.1.0__py3-none-any.whl

bidkit/generated/models/buy_deal.py

@@ -0,0 +1,604 @@
+# ruff: noqa
+# generated by datamodel-codegen:
+#   filename:  buy_deal_v1_oas3.json
+
+from __future__ import annotations
+
+from bidkit.models import OpenStrEnum
+
+from bidkit.models import EbayModel
+from pydantic import Field
+
+
+class CurrencyCodeEnum(OpenStrEnum):
+    aed = 'AED'
+    afn = 'AFN'
+    all = 'ALL'
+    amd = 'AMD'
+    ang = 'ANG'
+    aoa = 'AOA'
+    ars = 'ARS'
+    aud = 'AUD'
+    awg = 'AWG'
+    azn = 'AZN'
+    bam = 'BAM'
+    bbd = 'BBD'
+    bdt = 'BDT'
+    bgn = 'BGN'
+    bhd = 'BHD'
+    bif = 'BIF'
+    bmd = 'BMD'
+    bnd = 'BND'
+    bob = 'BOB'
+    brl = 'BRL'
+    bsd = 'BSD'
+    btn = 'BTN'
+    bwp = 'BWP'
+    byr = 'BYR'
+    bzd = 'BZD'
+    cad = 'CAD'
+    cdf = 'CDF'
+    chf = 'CHF'
+    clp = 'CLP'
+    cny = 'CNY'
+    cop = 'COP'
+    crc = 'CRC'
+    cup = 'CUP'
+    cve = 'CVE'
+    czk = 'CZK'
+    djf = 'DJF'
+    dkk = 'DKK'
+    dop = 'DOP'
+    dzd = 'DZD'
+    egp = 'EGP'
+    ern = 'ERN'
+    etb = 'ETB'
+    eur = 'EUR'
+    fjd = 'FJD'
+    fkp = 'FKP'
+    gbp = 'GBP'
+    gel = 'GEL'
+    ghs = 'GHS'
+    gip = 'GIP'
+    gmd = 'GMD'
+    gnf = 'GNF'
+    gtq = 'GTQ'
+    gyd = 'GYD'
+    hkd = 'HKD'
+    hnl = 'HNL'
+    hrk = 'HRK'
+    htg = 'HTG'
+    huf = 'HUF'
+    idr = 'IDR'
+    ils = 'ILS'
+    inr = 'INR'
+    iqd = 'IQD'
+    irr = 'IRR'
+    isk = 'ISK'
+    jmd = 'JMD'
+    jod = 'JOD'
+    jpy = 'JPY'
+    kes = 'KES'
+    kgs = 'KGS'
+    khr = 'KHR'
+    kmf = 'KMF'
+    kpw = 'KPW'
+    krw = 'KRW'
+    kwd = 'KWD'
+    kyd = 'KYD'
+    kzt = 'KZT'
+    lak = 'LAK'
+    lbp = 'LBP'
+    lkr = 'LKR'
+    lrd = 'LRD'
+    lsl = 'LSL'
+    ltl = 'LTL'
+    lyd = 'LYD'
+    mad = 'MAD'
+    mdl = 'MDL'
+    mga = 'MGA'
+    mkd = 'MKD'
+    mmk = 'MMK'
+    mnt = 'MNT'
+    mop = 'MOP'
+    mro_1 = 'MRO'
+    mur = 'MUR'
+    mvr = 'MVR'
+    mwk = 'MWK'
+    mxn = 'MXN'
+    myr = 'MYR'
+    mzn = 'MZN'
+    nad = 'NAD'
+    ngn = 'NGN'
+    nio = 'NIO'
+    nok = 'NOK'
+    npr = 'NPR'
+    nzd = 'NZD'
+    omr = 'OMR'
+    pab = 'PAB'
+    pen = 'PEN'
+    pgk = 'PGK'
+    php = 'PHP'
+    pkr = 'PKR'
+    pln = 'PLN'
+    pyg = 'PYG'
+    qar = 'QAR'
+    ron = 'RON'
+    rsd = 'RSD'
+    rub = 'RUB'
+    rwf = 'RWF'
+    sar = 'SAR'
+    sbd = 'SBD'
+    scr = 'SCR'
+    sdg = 'SDG'
+    sek = 'SEK'
+    sgd = 'SGD'
+    shp = 'SHP'
+    sll = 'SLL'
+    sos = 'SOS'
+    srd = 'SRD'
+    std = 'STD'
+    syp = 'SYP'
+    szl = 'SZL'
+    thb = 'THB'
+    tjs = 'TJS'
+    tmt = 'TMT'
+    tnd = 'TND'
+    top = 'TOP'
+    try_ = 'TRY'
+    ttd = 'TTD'
+    twd = 'TWD'
+    tzs = 'TZS'
+    uah = 'UAH'
+    ugx = 'UGX'
+    usd = 'USD'
+    uyu = 'UYU'
+    uzs = 'UZS'
+    vef = 'VEF'
+    vnd = 'VND'
+    vuv = 'VUV'
+    wst = 'WST'
+    xaf = 'XAF'
+    xcd = 'XCD'
+    xof = 'XOF'
+    xpf = 'XPF'
+    yer = 'YER'
+    zar = 'ZAR'
+    zmw = 'ZMW'
+    zwl = 'ZWL'
+
+
+class ErrorParameter(EbayModel):
+    name: str | None = Field(None, description='The object of the error.')
+    value: str | None = Field(None, description='The value of the object.')
+
+
+class Image(EbayModel):
+    height: str | None = Field(None, description='The height of the image.')
+    image_url: str | None = Field(
+        None, alias='imageUrl', description='The relative path to the image location.'
+    )
+    text: str | None = Field(None, description='The text associated with the image.')
+    width: str | None = Field(None, description='The width of the image.')
+
+
+class ItemGroupTypeEnum(OpenStrEnum):
+    seller_defined_variations = 'SELLER_DEFINED_VARIATIONS'
+
+
+class PriceTreatmentEnum(OpenStrEnum):
+    minimum_advertised_price = 'MINIMUM_ADVERTISED_PRICE'
+    list_price = 'LIST_PRICE'
+    markdown = 'MARKDOWN'
+
+
+class ProgramEnum(OpenStrEnum):
+    ebay_plus = 'EBAY_PLUS'
+
+
+class Terms(EbayModel):
+    full_text: str | None = Field(
+        None, alias='fullText', description='A full-text description of the terms.'
+    )
+    summary: str | None = Field(
+        None, description='A summarized description of the terms.'
+    )
+
+
+class Amount(EbayModel):
+    currency: CurrencyCodeEnum | None = Field(
+        None,
+        description="The three-letter ISO 4217 code representing the currency of the amount in the value field. Default: The currency of the authenticated user's country.",
+    )
+    value: str | None = Field(
+        None,
+        description='The monetary value, in the currency specified by the currency field.',
+    )
+
+
+class Coupon(EbayModel):
+    redemption_code: str | None = Field(
+        None, alias='redemptionCode', description='The coupon code.'
+    )
+    terms: Terms | None = Field(
+        None, description='The terms of use associated with the coupon.'
+    )
+
+
+class Error(EbayModel):
+    category: str | None = Field(None, description='Identifies the type of error.')
+    domain: str | None = Field(
+        None,
+        description='Name for the primary system where the error occurred. This is relevant for application errors.',
+    )
+    error_id: int | None = Field(
+        None, alias='errorId', description='A unique number to identify the error.'
+    )
+    input_ref_ids: list[str] | None = Field(
+        None,
+        alias='inputRefIds',
+        description='An array of request elements most closely associated to the error.',
+    )
+    long_message: str | None = Field(
+        None,
+        alias='longMessage',
+        description='A more detailed explanation of the error.',
+    )
+    message: str | None = Field(
+        None,
+        description="Information on how to correct the problem, in the end user's terms and language where applicable.",
+    )
+    output_ref_ids: list[str] | None = Field(
+        None,
+        alias='outputRefIds',
+        description='An array of request elements most closely associated to the error.',
+    )
+    parameters: list[ErrorParameter] | None = Field(
+        None,
+        description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.',
+    )
+    subdomain: str | None = Field(
+        None,
+        description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.',
+    )
+
+
+class Event(EbayModel):
+    applicable_coupons: list[Coupon] | None = Field(
+        None,
+        alias='applicableCoupons',
+        description='A list of coupons associated with the event.',
+    )
+    description: str | None = Field(None, description='The event description.')
+    end_date: str | None = Field(
+        None, alias='endDate', description='The end date for the event.'
+    )
+    event_affiliate_web_url: str | None = Field(
+        None,
+        alias='eventAffiliateWebUrl',
+        description='The URL of the View Event page for the event, which includes the affiliate tracking ID.',
+    )
+    event_id: str | None = Field(
+        None, alias='eventId', description='The unique identifier for the event.'
+    )
+    event_web_url: str | None = Field(
+        None, alias='eventWebUrl', description='The web URL for the event.'
+    )
+    images: list[Image] | None = Field(None, description='The images for the event.')
+    start_date: str | None = Field(
+        None, alias='startDate', description='The start date for the event.'
+    )
+    terms: Terms | None = Field(
+        None, description='The terms associated with the event.'
+    )
+    title: str | None = Field(None, description='The title of the event.')
+
+
+class EventSearchResponse(EbayModel):
+    events: list[Event] | None = Field(
+        None, description='A list of results that match the search criteria.'
+    )
+    href: str | None = Field(
+        None, description='The relative path to the current set of results.'
+    )
+    limit: int | None = Field(
+        None,
+        description='The maximum number of items, from the current result set, returned on a single page. Default: 20',
+    )
+    next: str | None = Field(
+        None, description='The relative path to the next set of results.'
+    )
+    offset: int | None = Field(
+        None,
+        description='The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to 0 and the limit is set to 10 , the method will retrieve items 1 through 10 from the list of items returned.',
+    )
+    prev: str | None = Field(
+        None, description='The relative path to the previous set of results.'
+    )
+    total: int | None = Field(
+        None,
+        description='The total number of matches for the specified search criteria.',
+    )
+
+
+class MarketingPrice(EbayModel):
+    discount_amount: Amount | None = Field(
+        None,
+        alias='discountAmount',
+        description='The monetary value of the seller discount.',
+    )
+    discount_percentage: str | None = Field(
+        None,
+        alias='discountPercentage',
+        description='The percentage of the seller discount based on the value returned in the originalPrice field.',
+    )
+    original_price: Amount | None = Field(
+        None,
+        alias='originalPrice',
+        description='The monetary value of the item prior to the discount.',
+    )
+    price_treatment: PriceTreatmentEnum | None = Field(
+        None,
+        alias='priceTreatment',
+        description='The pricing treatment (discount) that was applied to the price of the item. Note: The pricing treatment affects how and where the discounted price can be displayed.',
+    )
+
+
+class ShippingOption(EbayModel):
+    shipping_cost: Amount | None = Field(
+        None,
+        alias='shippingCost',
+        description='The final shipping cost for all items after all discounts are applied. Note: The price does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB ) to see the VAT-inclusive pricing.',
+    )
+    shipping_cost_type: str | None = Field(
+        None,
+        alias='shippingCostType',
+        description='The class of the shipping cost. Valid Values: FIXED or CALCULATED Code so that your app gracefully handles any future changes to this list.',
+    )
+
+
+class DealItem(EbayModel):
+    additional_images: list[Image] | None = Field(
+        None,
+        alias='additionalImages',
+        description='The additional images for the deal item.',
+    )
+    category_ancestor_ids: list[str] | None = Field(
+        None,
+        alias='categoryAncestorIds',
+        description='The IDs of the ancestors for the primary category.',
+    )
+    category_id: str | None = Field(
+        None,
+        alias='categoryId',
+        description='The ID of the leaf category for the deal item. A leaf category is the lowest level in a category and has no children.',
+    )
+    commissionable: bool | None = Field(
+        None,
+        description='A boolean value specifying whether the listing has commission.',
+    )
+    deal_affiliate_web_url: str | None = Field(
+        None,
+        alias='dealAffiliateWebUrl',
+        description='The deal associated with the item with affiliate attribution.',
+    )
+    deal_end_date: str | None = Field(
+        None, alias='dealEndDate', description='The date after which the deal ends.'
+    )
+    deal_start_date: str | None = Field(
+        None, alias='dealStartDate', description='The date on which the deal starts.'
+    )
+    deal_web_url: str | None = Field(
+        None,
+        alias='dealWebUrl',
+        description='The web URL for the deal associated with the item.',
+    )
+    energy_efficiency_class: str | None = Field(
+        None,
+        alias='energyEfficiencyClass',
+        description='A string value specifying the Energy Efficiency class.',
+    )
+    image: Image | None = Field(
+        None, description='The primary image for the deal item.'
+    )
+    item_affiliate_web_url: str | None = Field(
+        None,
+        alias='itemAffiliateWebUrl',
+        description='The item web URL with affiliate attribution.',
+    )
+    item_group_id: str | None = Field(
+        None,
+        alias='itemGroupId',
+        description='The unique identifier for the deal item group. This is the parent item ID for the seller-defined variations. Note: This field is returned for multiple-SKU items.',
+    )
+    item_group_type: ItemGroupTypeEnum | None = Field(
+        None,
+        alias='itemGroupType',
+        description='An enumeration value that indicates the type of item group. An item group contains items that have various aspect differences, such as color, size, or storage capacity.',
+    )
+    item_id: str | None = Field(
+        None,
+        alias='itemId',
+        description='The unique identifier for the deal item. Note: This field is only returned for single-SKU items.',
+    )
+    item_web_url: str | None = Field(
+        None, alias='itemWebUrl', description='The web URL for the deal item.'
+    )
+    legacy_item_id: str | None = Field(
+        None,
+        alias='legacyItemId',
+        description='The legacy item ID associated with the deal item.',
+    )
+    marketing_price: MarketingPrice | None = Field(
+        None,
+        alias='marketingPrice',
+        description='The original price for the deal item, and the discount amount and percentage.',
+    )
+    price: Amount | None = Field(
+        None,
+        description='The price for the deal item. Note: The price does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB ) to see the VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU .',
+    )
+    qualified_programs: list[ProgramEnum] | None = Field(
+        None,
+        alias='qualifiedPrograms',
+        description='A list of programs applicable to the item.',
+    )
+    shipping_options: list[ShippingOption] | None = Field(
+        None,
+        alias='shippingOptions',
+        description='The cost required to ship the deal item. Note: For items with calculated shipping, this array is only returned if the X-EBAY-C-ENDUSERCTX header is supplied.',
+    )
+    title: str | None = Field(None, description='The title of the deal item.')
+    unit_price: Amount | None = Field(
+        None,
+        alias='unitPrice',
+        description='The price per unit for the deal item. Some European countries require listings for certain types of products to include the price per unit so that buyers can accurately compare prices. For example: "unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"',
+    )
+    unit_pricing_measure: str | None = Field(
+        None,
+        alias='unitPricingMeasure',
+        description='The designation used to specify the quantity of the deal item, such as size, weight, volume, and count. This helps buyers compare prices. For example, the following tells the buyer that the item is 7.99 per 100 grams. "unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"',
+    )
+
+
+class DealItemSearchResponse(EbayModel):
+    deal_items: list[DealItem] | None = Field(
+        None,
+        alias='dealItems',
+        description='A list of deal items that match the search criteria.',
+    )
+    href: str | None = Field(
+        None, description='The relative path to the current set of results.'
+    )
+    limit: int | None = Field(
+        None,
+        description='The maximum number of items, from the current result set, returned on a single page. Default: 20',
+    )
+    next: str | None = Field(
+        None, description='The relative path to the next set of results.'
+    )
+    offset: int | None = Field(
+        None,
+        description='The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to 0 and the limit is set to 10 , the method will retrieve items 1 through 10 from the list of items returned.',
+    )
+    prev: str | None = Field(
+        None, description='The relative path to the previous set of results.'
+    )
+    total: int | None = Field(
+        None, description='The total number of matches for the search criteria.'
+    )
+
+
+class EventItem(EbayModel):
+    additional_images: list[Image] | None = Field(
+        None,
+        alias='additionalImages',
+        description='The additional images for the event item.',
+    )
+    category_ancestor_ids: list[str] | None = Field(
+        None,
+        alias='categoryAncestorIds',
+        description='The IDs of the ancestors for the primary category.',
+    )
+    category_id: str | None = Field(
+        None,
+        alias='categoryId',
+        description='The ID of the leaf category for the event item. A leaf category is the lowest level in a category and has no children.',
+    )
+    energy_efficiency_class: str | None = Field(
+        None,
+        alias='energyEfficiencyClass',
+        description='A string value specifying the Energy Efficiency class.',
+    )
+    event_id: str | None = Field(
+        None,
+        alias='eventId',
+        description='The unique event identifier associated with the item.',
+    )
+    image: Image | None = Field(None, description='The image for the event item.')
+    item_affiliate_web_url: str | None = Field(
+        None,
+        alias='itemAffiliateWebUrl',
+        description='The item web URL with affiliate attribution.',
+    )
+    item_group_id: str | None = Field(
+        None,
+        alias='itemGroupId',
+        description='The unique identifier for the event item group. This is the parent item ID for the seller-defined variations. Note: This field is returned for multiple-SKU items.',
+    )
+    item_group_type: ItemGroupTypeEnum | None = Field(
+        None,
+        alias='itemGroupType',
+        description='An enumeration value that indicates the type of item group. An item group contains items that have various aspect differences, such as color, size, or storage capacity.',
+    )
+    item_id: str | None = Field(
+        None,
+        alias='itemId',
+        description='The unique identifier for the event item. Note: This field is only returned for single-SKU items.',
+    )
+    item_web_url: str | None = Field(
+        None, alias='itemWebUrl', description='The web URL for the event item.'
+    )
+    legacy_item_id: str | None = Field(
+        None,
+        alias='legacyItemId',
+        description='The legacy item ID associated with the event item.',
+    )
+    marketing_price: MarketingPrice | None = Field(
+        None,
+        alias='marketingPrice',
+        description='The original price for the event item, and the discount amount and percentage.',
+    )
+    price: Amount | None = Field(
+        None, description='The applicable price for the event item.'
+    )
+    qualified_programs: list[ProgramEnum] | None = Field(
+        None,
+        alias='qualifiedPrograms',
+        description='A list of programs applicable to the event item.',
+    )
+    shipping_options: list[ShippingOption] | None = Field(
+        None,
+        alias='shippingOptions',
+        description='The cost required to ship the event item. Note: For items with calculated shipping, this array is only returned if the X-EBAY-C-ENDUSERCTX header is supplied.',
+    )
+    title: str | None = Field(None, description='The title of the event item.')
+    unit_price: Amount | None = Field(
+        None,
+        alias='unitPrice',
+        description='The price per unit for the event item. Some European countries require listings for certain types of products to include the price per unit so that buyers can accurately compare prices. For example: "unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"',
+    )
+    unit_pricing_measure: str | None = Field(
+        None,
+        alias='unitPricingMeasure',
+        description='The designation used to specify the quantity of the event item, such as size, weight, volume, and count. This helps buyers compare prices. For example, the following tells the buyer that the item is 7.99 per 100 grams. "unitPricingMeasure": "100g", "unitPrice": { "value": "7.99", "currency": "GBP"',
+    )
+
+
+class EventItemSearchResponse(EbayModel):
+    event_items: list[EventItem] | None = Field(
+        None,
+        alias='eventItems',
+        description='A list of event items that match the search criteria.',
+    )
+    href: str | None = Field(
+        None, description='The relative path to the current set of results.'
+    )
+    limit: int | None = Field(
+        None,
+        description='The maximum number of items, from the current result set, returned on a single page. Default: 20',
+    )
+    next: str | None = Field(
+        None, description='The relative path to the next set of results.'
+    )
+    offset: int | None = Field(
+        None,
+        description='The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output. For example, if the offset is set to 0 and the limit is set to 10 , the method will retrieve items 1 through 10 from the list of items returned.',
+    )
+    prev: str | None = Field(
+        None, description='The relative path to the previous set of results.'
+    )
+    total: int | None = Field(
+        None,
+        description='The total number of matches for the specified search criteria.',
+    )