UNPKG

bananas-commerce

Version:

A client for bananas-commerce with support for TypeScript

1,148 lines 82 kB
/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { "/api/v1/{site_code}/pos/items/": { get: operations["bcom_pos_rest_views_items"]; }; "/api/v1/{site_code}/pos/availability/": { get: operations["bcom_pos_rest_views_availability"]; }; "/api/v1/{site_code}/pos/cart/": { post: operations["bcom_pos_rest_views_cart"]; }; "/api/v1/{site_code}/pos/checkout/": { post: operations["bcom_pos_rest_views_checkout"]; }; "/api/v1/pos/checkout/receipt/{checkout_session}/": { get: operations["bcom_pos_rest_views_checkout_receipt"]; }; "/api/v1/{site_code}/subscription/plan/{code}/subscribe/": { post: operations["bcom_subscription_rest_views_subscribe_to_plan"]; }; "/api/v1/kco3/begin/": { /** Create a purchase with Klarna KCO3 as PSP */ post: operations["klarna_kco3_rest_views_begin"]; }; "/api/v1/kco3/{merchant_id}/confirm/{order_id}/": { /** Create a purchase with Klarna KCO3 as PSP */ post: operations["klarna_kco3_rest_views_confirm"]; }; "/api/v1/{site_code}/aco/begin/": { /** Create a purchase with Adyen as PSP */ post: operations["adyen_aco_rest_views_begin"]; }; "/api/v1/{site_code}/aco/seal/": { /** Seal a purchase with Adyen as PSP */ post: operations["adyen_aco_rest_views_seal"]; }; "/api/v1/aco/begin/": { /** Create a purchase with Adyen as PSP */ post: operations["adyen_aco_rest_views_begin_v2"]; }; "/api/v1/aco/seal/": { /** Seal a purchase with Adyen as PSP */ post: operations["adyen_aco_rest_views_seal_v2"]; }; "/api/v1/aco/pay/": { /** Seal a purchase and create payment with Adyen as PSP */ post: operations["adyen_aco_rest_views_pay"]; /** List available Adyen payment methods for country */ options: operations["adyen_aco_rest_views_payment_methods"]; }; "/api/v1/{site_code}/ingrid/begin/": { post: operations["ingrid_rest_views_begin"]; }; "/api/v1/ingrid/confirm/": { post: operations["ingrid_rest_views_confirm"]; }; "/api/v1/webshipper/shipping-options/": { post: operations["webshipper_rest_views_shipping_options"]; }; "/api/v1/member/me/purchase/": { get: operations["bcom_member_contrib_pos_views_my_purchase_list"]; }; "/api/v1/member/me/purchase/{number}/": { get: operations["bcom_member_contrib_pos_views_my_purchase_detail"]; }; "/api/v1/member/me/payment-methods/": { get: operations["bcom_member_contrib_pos_views_my_payment_methods"]; }; "/api/v1/member/me/payment-methods/{payment_token_id}/": { delete: operations["bcom_member_contrib_pos_views_revoke_my_payment_method"]; }; "/api/v1/member/me/subscription/": { get: operations["bcom_member_contrib_subscription_views_list_my_subscriptions"]; }; "/api/v1/member/me/subscription/{subscription_id}/cancel/": { post: operations["bcom_member_contrib_subscription_views_cancel_my_subscription"]; }; "/api/v1/member/me/subscription/{subscription_id}/resume/": { post: operations["bcom_member_contrib_subscription_views_resume_my_subscription"]; }; } export interface components { schemas: { /** ItemResponse */ ItemResponse: { /** Reference */ reference: string; /** Name */ name: string; /** Variant */ variant: string; /** Base Price */ base_price: string; /** Price */ price: string; /** Is Available */ is_available: boolean; /** Error */ error?: string; /** Warning */ warning?: string; }; /** ItemsResponse */ ItemsResponse: { /** Items */ items: components["schemas"]["ItemResponse"][]; }; /** ErrorDetail */ ErrorDetail_str_: { /** Detail */ detail: string; }; /** ItemGroupResponse */ ItemGroupResponse: { /** Reference */ reference: string; /** * Price * @description Lowest price of related items */ price?: string; /** Is Available */ is_available: boolean; /** Warnings */ warnings: string[]; }; /** AvailabilityResponse */ AvailabilityResponse: { /** Groups */ groups: components["schemas"]["ItemGroupResponse"][]; }; /** AddonResponse */ AddonResponse: { /** Reference */ reference: string; /** Total */ total?: string; /** Name */ name?: string; /** Variant */ variant?: string; /** Group */ group?: string; /** Properties */ properties?: { [key: string]: Partial<string> & Partial<number> & Partial<boolean>; }; /** Error */ error?: string; /** Warning */ warning?: string; }; /** CartItemResponse */ CartItemResponse: { /** Reference */ reference: string; /** Quantity */ quantity: number; /** Name */ name?: string; /** Group */ group?: string; /** Variant */ variant?: string; /** Discount */ discount?: string; /** Total */ total?: string; /** Properties */ properties?: { [key: string]: Partial<string> & Partial<number> & Partial<boolean>; }; /** Addons */ addons?: components["schemas"]["AddonResponse"][]; /** Error */ error?: string; /** Warning */ warning?: string; }; /** CartResponse */ CartResponse: { /** Items */ items: components["schemas"]["CartItemResponse"][]; /** Total */ total: string; }; /** * Error * @example { * "loc": [ * "body", * "country_code" * ], * "msg": "unexpected value; permitted: 'SE', 'DK', 'NO'", * "type": "value_error.const", * "ctx": { * "given": "ABC", * "permitted": [ * "SE", * "DK", * "NO" * ] * } * } */ LocationError: { /** * Location * @description Location of the error */ loc: (Partial<string> & Partial<number>)[]; /** * Message * @description Verbose error message */ msg: string; /** * Type * @description Error code */ type: string; /** * Context * @description Additional, structured, context for the error */ ctx?: { [key: string]: unknown; }; }; /** Errors */ LocationErrors: components["schemas"]["LocationError"][]; /** ErrorDetail */ ErrorDetail_LocationErrors_: { detail: components["schemas"]["LocationErrors"]; }; /** AddonRequest */ AddonRequest: { /** Reference */ reference: string; /** User Input */ user_input?: string; }; /** CartItemRequest */ CartItemRequest: { /** Reference */ reference: string; /** Quantity */ quantity: number; /** User Input */ user_input?: string; /** Addons */ addons?: components["schemas"]["AddonRequest"][]; }; /** CartRequest */ CartRequest: { /** Items */ items: components["schemas"]["CartItemRequest"][]; }; /** POSCartResponse */ POSCartResponse: { /** Items */ items: components["schemas"]["CartItemResponse"][]; /** Total */ total: string; /** Fingerprint */ fingerprint: string; }; /** CustomerAddress */ CustomerAddressModel: { /** Street Address */ street_address: string; /** Street Address2 */ street_address2?: string; /** Postal Code */ postal_code: string; /** City */ city: string; /** Country Code */ country_code: Partial<"AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CA" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "XK" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "US" | "UM" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW"> & Partial<string>; /** Region */ region?: string; /** * Given Name * @default */ given_name?: string; /** * Family Name * @default */ family_name?: string; /** * Company Name * @default */ company_name?: string; /** Care Of */ care_of?: string; }; /** POSBillingResponse */ POSBillingResponse: { /** * Email * Format: email */ email: string; /** * PhoneNumber * Format: E.164 * @description A valid E.164 phone number. */ phone?: string; address: components["schemas"]["CustomerAddressModel"]; }; /** POSShippingResponse */ POSShippingResponse: { /** Reference */ reference: string; /** Name */ name?: string; /** Price */ price?: string; /** * Email * Format: email */ email?: string; /** * PhoneNumber * Format: E.164 * @description A valid E.164 phone number. */ phone?: string; address?: components["schemas"]["CustomerAddressModel"]; /** Error */ error?: string; /** Fingerprint */ fingerprint: string; }; /** * TaxBehavior * @description An enumeration. * @enum {string} */ TaxBehavior: "INCLUSIVE" | "EXCLUSIVE"; /** POSCheckoutResponse */ POSCheckoutResponse: { /** Checkout Session */ checkout_session: string; cart: components["schemas"]["POSCartResponse"]; billing?: components["schemas"]["POSBillingResponse"]; shipping?: components["schemas"]["POSShippingResponse"]; tax_behavior: components["schemas"]["TaxBehavior"]; /** Tax Total */ tax_total?: string; /** Total */ total: string; /** Tags */ tags?: string[]; /** Error */ error?: string; }; /** POSBillingRequest */ POSBillingRequest: { /** * Email * Format: email */ email: string; /** * PhoneNumber * Format: E.164 * @description A valid E.164 phone number. */ phone?: string; address: components["schemas"]["CustomerAddressModel"]; }; /** POSShippingRequest */ POSShippingRequest: { /** Reference */ reference: string; /** * Email * Format: email */ email?: string; /** * PhoneNumber * Format: E.164 * @description A valid E.164 phone number. */ phone?: string; address?: components["schemas"]["CustomerAddressModel"]; }; /** POSMemberRequest */ POSMemberRequest: { /** Token */ token?: string; }; /** * POSCheckoutRequest * @example { * "cart": { * "items": [ * { * "reference": "COFFEE-1", * "quantity": 3 * }, * { * "reference": "COFFEE-2", * "quantity": 1 * } * ] * }, * "country_code": "SE" * } */ POSCheckoutRequest: { /** Checkout Session */ checkout_session?: string; cart: components["schemas"]["CartRequest"]; /** Country Code */ country_code?: Partial<"AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CA" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "XK" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "US" | "UM" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW"> & Partial<string>; billing?: components["schemas"]["POSBillingRequest"]; shipping?: components["schemas"]["POSShippingRequest"]; member?: components["schemas"]["POSMemberRequest"]; /** Tags */ tags?: string[]; }; /** CheckoutReceiptLineDiscount */ CheckoutReceiptLineDiscountResponse: { /** Title */ title: string; /** Amount */ amount: string; }; /** CheckoutReceiptLine */ CheckoutReceiptLineResponse: { /** * Reference * @description The reference for what item has been bought. */ reference: string; /** Title */ title: string; /** Line Number */ line_number: number; /** Item Type */ item_type: string; /** Quantity */ quantity: number; /** * Total Amount * @description Total amount _after_ discounts have been applied. */ total_amount: string; /** Total Discount Amount */ total_discount_amount: string; /** * Discounts * @description Contains discounts that have been applied to this line. */ discounts: components["schemas"]["CheckoutReceiptLineDiscountResponse"][]; }; /** * CheckoutReceipt * @description The receipt of a completed checkout * @example { * "purchase_number": "7000001", * "currency": "SEK", * "site_code": "SE", * "total_amount": "161.00", * "total_discount_amount": "39.00", * "total_tax_amount": "32.20", * "tax_behavior": "INCLUSIVE", * "lines": [ * { * "reference": "COFFEE-AA-1", * "title": "Americano Arabica (large)", * "line_number": 1, * "item_type": "SKU", * "quantity": 1, * "total_amount": "99.00", * "total_discount_amount": "17.00", * "discounts": [ * { * "title": "17 lax", * "reference": "17_LAX", * "amount": "17.00" * } * ] * }, * { * "reference": "COFFEE-CE-2", * "title": "Cappuccino Excelsa (medium)", * "line_number": 2, * "item_type": "SKU", * "quantity": 1, * "total_amount": "33.00", * "total_discount_amount": "22.00", * "discounts": [ * { * "title": "22 lax", * "reference": "22_LAX", * "amount": "22.00" * } * ] * }, * { * "reference": "SHIPPING_1", * "title": "Postnord Hemleverans", * "line_number": 3, * "item_type": "SHIPPING", * "quantity": 1, * "total_amount": "29.00", * "total_discount_amount": "0.00", * "discounts": [] * } * ] * } */ CheckoutReceiptResponse: { /** * Purchase Number * @description The globally unique reference of this purchase. If this value is `null`, the purchase hasn't completed processing yet. */ purchase_number?: string; /** Currency */ currency: string; /** Site Code */ site_code: string; /** * Total Amount * @description Total amount _after_ discounts have been applied. */ total_amount: number; /** Total Discount Amount */ total_discount_amount: number; /** Total Tax Amount */ total_tax_amount: number; tax_behavior: components["schemas"]["TaxBehavior"]; /** Lines */ lines: components["schemas"]["CheckoutReceiptLineResponse"][]; }; /** * SubscriptionPeriodicity * @description An enumeration. * @enum {string} */ SubscriptionPeriodicity: "MONTH" | "DAY"; /** * SubscriptionState * @description An enumeration. * @enum {string} */ SubscriptionState: "PENDING" | "RUNNING" | "ENDED"; /** SubscriptionResponse */ SubscriptionResponse: { /** Id */ id: number; /** Plan Id */ plan: string; /** Name */ name: string; /** Nth */ nth?: number; periodicity?: components["schemas"]["SubscriptionPeriodicity"]; /** Amount */ amount: string; /** Currency */ currency: string; state: components["schemas"]["SubscriptionState"]; /** Is Cancelled */ is_cancelled: boolean; /** * TZAware * Format: date-time * @description A date-time with timezone data. */ start_date?: string; /** * TZAware * Format: date-time * @description A date-time with timezone data. */ end_date?: string; /** * TZAware * Format: date-time * @description A date-time with timezone data. */ expiry_date?: string; /** Membership Number */ membership_number: number; }; /** KCOCartItemResponse */ KCOCartItemResponse: { /** Reference */ reference: string; /** Quantity */ quantity: number; /** Name */ name?: string; /** Variant */ variant?: string; /** Total */ total?: string; /** Error */ error?: string; /** Warning */ warning?: string; }; /** KCOCartResponse */ KCOCartResponse: { /** Items */ items: components["schemas"]["KCOCartItemResponse"][]; /** Total */ total: string; }; /** KCOShippingResponse */ KCOShippingResponse: { /** Reference */ reference: string; /** Name */ name?: string; /** Price */ price?: string; /** Error */ error?: string; }; /** * KCOCheckoutResponse * @example { * "cart": { * "items": [ * { * "reference": "COFFEE-1", * "quantity": 3, * "name": "Americano Arabica (large)", * "variant": "large", * "total": "69.00", * "error": null, * "warning": null * }, * { * "reference": "COFFEE-2", * "quantity": 1, * "name": "Cappuccino Excelsa (medium)", * "variant": "medium", * "total": "42.00", * "error": null, * "warning": null * } * ], * "total": "111.00" * }, * "psp_data": "some session data", * "shipping": { * "reference": "provider|0ce68bac98564c00964b27c46f3c6494", * "name": "Pickup in Store", * "total": "29.00" * } * } */ KCOCheckoutResponse: { cart: components["schemas"]["KCOCartResponse"]; /** Psp Data */ psp_data?: string; shipping?: components["schemas"]["KCOShippingResponse"]; }; /** * KCOCheckoutErrorResponse * @example { * "cart": { * "items": [ * { * "reference": "COFFEE-1", * "quantity": 3, * "name": null, * "total": null, * "error": "INVALID_REFERENCE", * "warning": null * }, * { * "reference": "COFFEE-2", * "quantity": 1, * "name": "Cappuccino Excelsa (medium)", * "total": "42.00", * "error": null, * "warning": null * } * ], * "total": "42.00" * }, * "psp_data": null * } */ KCOCheckoutErrorResponse: { cart: components["schemas"]["KCOCartResponse"]; /** Psp Data */ psp_data?: string; shipping?: components["schemas"]["KCOShippingResponse"]; }; /** * KCOCheckoutRequest * @example { * "checkout_session": ".fk4d234829238..." * } */ KCOCheckoutRequest: { /** Checkout Session */ checkout_session: string; }; /** ACOCartItemResponse */ ACOCartItemResponse: { /** Reference */ reference: string; /** Quantity */ quantity: number; /** Name */ name?: string; /** Variant */ variant?: string; /** Total */ total?: string; /** Error */ error?: string; /** Warning */ warning?: string; }; /** ACOCartResponse */ ACOCartResponse: { /** Items */ items: components["schemas"]["ACOCartItemResponse"][]; /** Total */ total: string; }; /** ACOShippingResponse */ ACOShippingResponse: { /** Reference */ reference: string; /** Name */ name?: string; /** Price */ price?: string; /** Error */ error?: string; }; /** * ACOCheckoutResponse * @example { * "cart": { * "items": [ * { * "reference": "COFFEE-1", * "quantity": 3, * "name": "Americano Arabica (large)", * "variant": "large", * "total": "69.00", * "error": null, * "warning": null * }, * { * "reference": "COFFEE-2", * "quantity": 1, * "name": "Cappuccino Excelsa (medium)", * "variant": "medium", * "total": "42.00", * "error": null, * "warning": null * } * ], * "total": "111.00" * }, * "psp_data": "some session data", * "psp_session_id": "some session id", * "shipping": { * "reference": "provider|0ce68bac98564c00964b27c46f3c6494", * "name": "Pickup in Store", * "total": "29.00" * }, * "tags": [ * "SIGNUP" * ] * } */ ACOCheckoutResponse: { cart: components["schemas"]["ACOCartResponse"]; /** Psp Data */ psp_data?: string; /** Psp Session Id */ psp_session_id?: string; shipping?: components["schemas"]["ACOShippingResponse"]; /** Tags */ tags?: string[]; }; /** * ACOCheckoutErrorResponse * @example { * "cart": { * "items": [ * { * "reference": "COFFEE-1", * "quantity": 3, * "name": null, * "total": null, * "error": "INVALID_REFERENCE", * "warning": null * }, * { * "reference": "COFFEE-2", * "quantity": 1, * "name": "Cappuccino Excelsa (medium)", * "total": "42.00", * "error": null, * "warning": null * } * ], * "total": "42.00" * }, * "psp_data": null * } */ ACOCheckoutErrorResponse: { cart: components["schemas"]["ACOCartResponse"]; /** Psp Data */ psp_data?: string; /** Psp Session Id */ psp_session_id?: string; shipping?: components["schemas"]["ACOShippingResponse"]; /** Tags */ tags?: string[]; }; /** CustomerAddress */ Customer: { /** Street Address */ street_address: string; /** Street Address2 */ street_address2?: string; /** Postal Code */ postal_code: string; /** City */ city: string; /** Country Code */ country_code: Partial<"AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CA" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "XK" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "US" | "UM" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW"> & Partial<string>; /** Region */ region?: string; /** * Given Name * @default */ given_name?: string; /** * Family Name * @default */ family_name?: string; /** * Company Name * @default */ company_name?: string; /** Care Of */ care_of?: string; /** * Email * Format: email */ email: string; /** * PhoneNumber * Format: E.164 * @description A valid E.164 phone number. */ phone?: string; }; /** ACOShippingRequest */ ACOShippingRequest: { /** Reference */ reference: string; }; /** * ACOCheckoutRequest * @example { * "cart": { * "items": [ * { * "reference": "COFFEE-1", * "quantity": 3 * }, * { * "reference": "COFFEE-2", * "quantity": 1 * } * ] * }, * "country_code": "SE" * } */ ACOCheckoutRequest: { cart: components["schemas"]["CartRequest"]; /** Country Code */ country_code?: Partial<"AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CA" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "XK" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "US" | "UM" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW"> & Partial<string>; customer?: components["schemas"]["Customer"]; shipping?: components["schemas"]["ACOShippingRequest"]; /** Tags */ tags?: string[]; }; /** ACOSealResponse */ ACOSealResponse: { /** * Checkout Session * @description The reference for this checkout session. Can be used to fetch a receipt. */ checkout_session: string; }; /** ErrorDetail */ DetailWithCode: { /** Msg */ msg: string; /** Code */ code: string; }; /** ErrorDetail */ ErrorDetail_DetailWithCode_: { detail: components["schemas"]["DetailWithCode"]; }; /** * ACOSealRequest * @example { * "cart": { * "items": [ * { * "reference": "COFFEE-1", * "quantity": 3 * }, * { * "reference": "COFFEE-2", * "quantity": 1 * } * ] * }, * "country_code": "SE" * } */ ACOSealRequest: { cart: components["schemas"]["CartRequest"]; /** Country Code */ country_code?: Partial<"AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CA" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "XK" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "US" | "UM" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW"> & Partial<string>; customer: components["schemas"]["Customer"]; shipping?: components["schemas"]["ACOShippingRequest"]; /** Tags */ tags?: string[]; }; /** * ACOCheckoutRequestV2 * @example { * "checkout_session": ".fk4d234829238..." * } */ ACOCheckoutRequestV2: { /** Checkout Session */ checkout_session: string; }; /** ACOPaymentMethodConfiguration */ ACOPaymentMethodConfiguration: { /** Merchantid */ merchant_id: string; /** Merchantname */ merchant_name: string; }; /** ACOPaymentMethod */ ACOPaymentMethod: { /** Name */ name: string; /** Type */ method: string; /** Brands */ brands?: string[]; configuration?: components["schemas"]["ACOPaymentMethodConfiguration"]; }; /** * ACOPaymentMethodsResponse * @example [ * { * "brands": [ * "amex", * "mc", * "visa" * ], * "configuration": { * "merchant_id": "000000000123456", * "merchant_name": "CompanyECOM" * }, * "name": "Apple Pay", * "method": "applepay" * } * ] */ ACOPaymentMethodsResponse: components["schemas"]["ACOPaymentMethod"][]; /** * ACOPaymentRequest * @example { * "checkout_session": ".fk4d234829238..." * } */ ACOPaymentRequest: { /** Checkout Session */ checkout_session: string; /** Applepay Token */ applepay_token?: string; }; /** IngridShippingResponse */ IngridShippingResponse: { /** Reference */ reference: string; /** Name */ name?: string; /** Total */ total?: string; }; /** * IngridSessionResponse * @example { * "shipping_data": "<div>räksmörgås</div>", * "shipping": { * "reference": "ingrid|0ce68bac98564c00964b27c46f3c6494", * "name": "Pickup in Store", * "total": "29.00" * } * } */ IngridSessionResponse: { /** Shipping Data */ shipping_data: string; shipping: components["schemas"]["IngridShippingResponse"]; }; /** IngridSearchAddress */ IngridSearchAddress: { /** Country */ country: Partial<"AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CA" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "XK" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "US" | "UM" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW"> & Partial<string>; /** Postal Code */ postal_code: string; /** Address Lines */ address_lines?: string[]; /** City */ city?: string; /** Region */ region?: string; }; /** * IngridCheckoutRequest * @example { * "cart": { * "items": [ * { * "reference": "COFFEE-1", * "quantity": 3 * }, * { * "reference": "COFFEE-2", * "quantity": 1 * } * ] * }, * "country_code": "SE" * } */ IngridCheckoutRequest: { cart: components["schemas"]["CartRequest"]; /** Country Code */ country_code: Partial<"AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CA" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "XK" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "US" | "UM" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW"> & Partial<string>; search_address?: components["schemas"]["IngridSearchAddress"]; }; /** * IngridConfirmRequest * @example { * "customer": { * "given_name": "John", * "family_name": "Smith", * "street_address": "10 Downing St", * "postal_code": "SW1A2AB", * "city": "London", * "country_code": "GB", * "email": "someone@example.com", * "phone": "+46701234567" * } * } */ IngridConfirmRequest: { customer: components["schemas"]["Customer"]; }; /** WebshipperPickupLocation */ WebshipperPickupLocation: { /** Reference */ reference: string; /** Name */ name: string; /** Street Address */ street_address: string; /** Street Address2 */ street_address2?: string; /** Postal Code */ postal_code: string; /** City */ city: string; /** Country Code */ country_code: Partial<"AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CA" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "XK" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "US" | "UM" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW"> & Partial<string>; /** Region */ region?: string; /** Fingerprint */ fingerprint: string; }; /** WebshipperOption */ WebshipperOption: { /** Reference */ reference?: string; /** Price */ price: string; /** Name */ name: string; /** Carrier Code */ carrier_code: string; /** Pickup Locations */ pickup_locations?: components["schemas"]["WebshipperPickupLocation"][]; /** Fingerprint */ fingerprint?: string; }; /** WebshipperOptionsList */ WebshipperOptionsList: { /** Results */ results: components["schemas"]["WebshipperOption"][]; }; /** WebshipperDeliveryAddress */ WebshipperDeliveryAddress: { /** Street Address */ street_address?: string; /** Postal Code */ postal_code: string; /** City */ city?: string; /** Region */ region?: string; /** Country Code */ country_code: Partial<"AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CA" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FJ" | "FI" | "F