Api reference

components.shop.public.commands ¶

app_group ¶

shop_commands `module-attribute` ¶

shop_commands = AppGroup('shop')

backfill_shop_visits ¶

backfill_shop_visits(dry_run)

Backfill shop visits from Segment.

Source code in components/shop/public/commands/backfill_shop_visits.py

@shop_commands.command()
@command_with_dry_run
def backfill_shop_visits(dry_run: bool) -> None:
    """Backfill shop visits from Segment."""
    from components.shop.internal.business_logic.users.backfill_shop_visits import (
        backfill_shop_visits as backfill_shop_visits_action,
    )

    backfill_shop_visits_action(dry_run=dry_run)

global_invoicing ¶

process_contact_lens_invoicing ¶

process_contact_lens_invoicing(
    invoicing_date, app_id, dry_run
)

Process the contact lens invoicing for a given period.

Source code in components/shop/public/commands/global_invoicing.py

@shop_commands.command()
@click.option("--invoicing-date", type=DateCli(), required=True)
@click.option(
    "--app-id",
    type=str,
    required=True,
    default=AppName.ALAN_FR,
    help="App ID",
)
@command_with_dry_run
def process_contact_lens_invoicing(
    invoicing_date: date, app_id: str, dry_run: bool
) -> None:
    """Process the contact lens invoicing for a given period."""
    try:
        saleor_helper = SaleorHelper()
        # retrieve transactions to invoice
        transactions_to_invoice = (
            saleor_helper.retrieve_transactions_to_invoice_for_period(
                usage_type=UsageType.contact_lens,
                period=invoicing_date,
            )
        )

        # generate global invoice
        validated_app_id = AppName.validate(app_id)
        shop_adapter = get_app_specific_shop_adapter(app_id=validated_app_id)

        order_invoice = shop_adapter.generate_contact_lens_global_invoice(
            transactions_to_invoice=transactions_to_invoice,
            period=invoicing_date,
            is_preview=dry_run,
        )

        current_logger.info(
            "Shop: [global_invoicing] Contact lens global invoice generated",
            invoice_url=order_invoice,
        )

    except Exception as e:
        current_logger.error(
            "Shop: [global_invoicing] Error generating contact lens global invoice",
            error=e,
        )
        raise e

supplier_action ¶

daily_routine ¶

daily_routine(dry_run, supplier)

Source code in components/shop/public/commands/supplier_action.py

@shop_commands.command()
@command_with_dry_run
@click.option(
    "--supplier",
    required=False,
    default="",
    help="slug of the supplier to run the 'daily_routine' action for",
)
def daily_routine(  # noqa: D103
    dry_run: bool,
    supplier: str,
) -> None:
    from components.shop.internal.business_logic.suppliers.supplier_action_manager import (
        SupplierActionManager,
    )

    SupplierActionManager(dry_run=dry_run).run_action(
        action="daily_routine",
        for_supplier_only=supplier if supplier else None,
    )

fulfill_orders ¶

fulfill_orders(dry_run, supplier)

Source code in components/shop/public/commands/supplier_action.py

@shop_commands.command()
@command_with_dry_run
@click.option(
    "--supplier",
    required=False,
    default="",
    help="slug of the supplier to run the 'fulfill_orders' action for",
)
def fulfill_orders(  # noqa: D103
    dry_run: bool,
    supplier: str,
) -> None:
    from components.shop.internal.business_logic.suppliers.supplier_action_manager import (
        SupplierActionManager,
    )

    SupplierActionManager(dry_run=dry_run).run_action(
        action="fulfill_orders",
        for_supplier_only=supplier if supplier else None,
    )

run_supplier_action ¶

run_supplier_action(dry_run, action, supplier, days=None)

Source code in components/shop/public/commands/supplier_action.py

@shop_commands.command()
@command_with_dry_run
@click.option(
    "--action",
    is_flag=False,
    required=True,
    default=None,
    help="be it fulfill_orders, update_recent_orders, update_draft_orders, update_trackings or synchronize_stocks, synchronize_catalog, supplier_routine or all",
)
@click.option(
    "--supplier",
    required=False,
    default="",
    help="slug of the supplier to run the action for",
)
@click.option(
    "--days",
    required=False,
    type=int,
    help="number of days used for the update_recent_orders action",
)
def run_supplier_action(  # noqa: D103
    dry_run: bool,
    action: str,
    supplier: str,
    days: Optional[int] = None,
) -> None:
    from components.shop.internal.business_logic.suppliers.supplier_action_manager import (
        SupplierAction,
        SupplierActionManager,
    )

    extra_args = {}
    if days is not None:
        extra_args["days"] = days

    if action == "all":
        for action_enum in SupplierAction:
            SupplierActionManager(dry_run=dry_run).run_action(
                action=action_enum.value,
                for_supplier_only=supplier if supplier else None,
                extra_args=extra_args,
            )
    else:
        SupplierActionManager(dry_run=dry_run).run_action(
            action=action,
            for_supplier_only=supplier if supplier else None,
            extra_args=extra_args,
        )

sync_delivery_status ¶

sync_delivery_status(dry_run)

Source code in components/shop/public/commands/supplier_action.py

@shop_commands.command()
@command_with_dry_run
def sync_delivery_status(  # noqa: D103
    dry_run: bool,
) -> None:
    from components.shop.internal.business_logic.suppliers.supplier_action_manager import (
        SupplierActionManager,
    )

    SupplierActionManager(dry_run=dry_run).run_action(
        action="sync_delivery_status",
    )

synchronize_catalog ¶

synchronize_catalog(dry_run, supplier)

Source code in components/shop/public/commands/supplier_action.py

@shop_commands.command()
@command_with_dry_run
@click.option(
    "--supplier",
    required=False,
    default="",
    help="slug of the supplier to run the 'synchronize_catalog' action for",
)
def synchronize_catalog(  # noqa: D103
    dry_run: bool,
    supplier: str,
) -> None:
    from components.shop.internal.business_logic.suppliers.supplier_action_manager import (
        SupplierActionManager,
    )

    SupplierActionManager(dry_run=dry_run).run_action(
        action="synchronize_catalog",
        for_supplier_only=supplier if supplier else None,
    )

synchronize_stocks ¶

synchronize_stocks(dry_run, supplier)

Source code in components/shop/public/commands/supplier_action.py

@shop_commands.command()
@command_with_dry_run
@click.option(
    "--supplier",
    required=False,
    default="",
    help="slug of the supplier to run the 'synchronize_stocks' action for",
)
def synchronize_stocks(  # noqa: D103
    dry_run: bool,
    supplier: str,
) -> None:
    from components.shop.internal.business_logic.suppliers.supplier_action_manager import (
        SupplierActionManager,
    )

    SupplierActionManager(dry_run=dry_run).run_action(
        action="synchronize_stocks",
        for_supplier_only=supplier if supplier else None,
    )

update_draft_orders ¶

update_draft_orders(dry_run, supplier)

Source code in components/shop/public/commands/supplier_action.py

@shop_commands.command()
@command_with_dry_run
@click.option(
    "--supplier",
    required=False,
    default="",
    help="slug of the supplier to run the 'update_draft_orders' action for",
)
def update_draft_orders(  # noqa: D103
    dry_run: bool,
    supplier: str,
) -> None:
    from components.shop.internal.business_logic.suppliers.supplier_action_manager import (
        SupplierActionManager,
    )

    SupplierActionManager(dry_run=dry_run).run_action(
        action="update_draft_orders",
        for_supplier_only=supplier if supplier else None,
    )

update_orders_by_numbers ¶

update_orders_by_numbers(dry_run, supplier, order_numbers)

Source code in components/shop/public/commands/supplier_action.py

@shop_commands.command()
@command_with_dry_run
@click.option(
    "--supplier",
    required=False,
    default="",
    help="slug of the supplier to run the 'update_orders_by_numbers' action for",
)
@click.option(
    "--order-numbers",
    required=True,
    type=str,
    help="comma-separated order numbers to update (e.g. --order-numbers 123,456)",
)
def update_orders_by_numbers(  # noqa: D103
    dry_run: bool,
    supplier: str,
    order_numbers: str,
) -> None:
    from components.shop.internal.business_logic.suppliers.supplier_action_manager import (
        SupplierActionManager,
    )

    parsed_order_numbers = [
        int(n.strip()) for n in order_numbers.split(",") if n.strip()
    ]
    SupplierActionManager(dry_run=dry_run).run_action(
        action="update_orders_by_numbers",
        for_supplier_only=supplier if supplier else None,
        extra_args={"order_numbers": parsed_order_numbers},
    )

update_recent_orders ¶

update_recent_orders(dry_run, supplier, days=None)

Source code in components/shop/public/commands/supplier_action.py

@shop_commands.command()
@command_with_dry_run
@click.option(
    "--supplier",
    required=False,
    default="",
    help="slug of the supplier to run the 'update_recent_orders' action for",
)
@click.option(
    "--days",
    required=False,
    type=int,
    help="number of days used for the 'update_recent_orders' action",
)
def update_recent_orders(  # noqa: D103
    dry_run: bool,
    supplier: str,
    days: Optional[int] = None,
) -> None:
    from components.shop.internal.business_logic.suppliers.supplier_action_manager import (
        SupplierActionManager,
    )

    extra_args = {}
    if days is not None:
        extra_args["days"] = days

        SupplierActionManager(dry_run=dry_run).run_action(
            action="update_recent_orders",
            for_supplier_only=supplier if supplier else None,
            extra_args=extra_args,
        )

update_trackings ¶

update_trackings(dry_run, supplier)

Source code in components/shop/public/commands/supplier_action.py

@shop_commands.command()
@command_with_dry_run
@click.option(
    "--supplier",
    required=False,
    default="",
    help="slug of the supplier to run the 'update_trackings' action for",
)
def update_trackings(  # noqa: D103
    dry_run: bool,
    supplier: str,
) -> None:
    from components.shop.internal.business_logic.suppliers.supplier_action_manager import (
        SupplierActionManager,
    )

    SupplierActionManager(dry_run=dry_run).run_action(
        action="update_trackings",
        for_supplier_only=supplier if supplier else None,
    )

sync_product_recommendations ¶

sync_product_recommendations(dry_run)

Synchronize product recommendations on Saleor.

Source code in components/shop/public/commands/sync_product_recommendations.py

@shop_commands.command()
@command_with_dry_run
def sync_product_recommendations(dry_run: bool) -> None:
    """Synchronize product recommendations on Saleor."""
    from components.shop.internal.business_logic.recommendations.sync_product_recommendations import (
        sync_product_recommendations as sync_product_recommendations_action,
    )

    sync_product_recommendations_action(dry_run=dry_run)

sync_saleor_channels ¶

sync_saleor_channels(from_channel, to_channel, dry_run)

Synchronize two Saleor channels

Source code in components/shop/public/commands/sync_saleor_channels.py

@shop_commands.command()
@click.option(
    "--from-channel",
    required=True,
    help="slug of the source channel",
)
@click.option(
    "--to-channel",
    required=True,
    help="slug of the destination channel",
)
@command_with_dry_run
def sync_saleor_channels(from_channel: str, to_channel: str, dry_run: bool) -> None:
    """Synchronize two Saleor channels"""
    from components.shop.internal.business_logic.channels.sync_saleor_channels import (
        sync_saleor_channels as sync_saleor_channels_action,
    )

    sync_saleor_channels_action(
        from_channel_slug=from_channel,
        to_channel_slug=to_channel,
        dry_run=dry_run,
    )

components.shop.public.const ¶

REFUNDABLE_FULFILLMENT_STATUSES `module-attribute` ¶

REFUNDABLE_FULFILLMENT_STATUSES = [
    RETURNED,
    REFUNDED_AND_RETURNED,
    CANCELED,
]

SHOP_EMAIL `module-attribute` ¶

SHOP_EMAIL = 'shop@alan.eu'

SHOP_EMAIL_TEMPLATE `module-attribute` ¶

SHOP_EMAIL_TEMPLATE = 'shop+{supplier_slug}@alan.eu'

UNTRACKED_STOCK `module-attribute` ¶

UNTRACKED_STOCK = 999

components.shop.public.controllers ¶

admin_cancellation_mail ¶

AdminCancellationMailsController ¶

Bases: BaseController

admin_cancellation_mails_endpoint `module-attribute` ¶

admin_cancellation_mails_endpoint = Endpoint('')

admin_order ¶

AdminShopOrderController ¶

Bases: BaseController

ApproveFulfillmentPostJsonSchema ¶

Bases: Schema

JSON body for POST approve fulfillment.

decision_reason `class-attribute` `instance-attribute` ¶

decision_reason = Str(required=False, allow_none=True)

CancelFulfillmentPostJsonSchema ¶

Bases: Schema

JSON body for POST cancel fulfillment.

decision_reason `class-attribute` `instance-attribute` ¶

decision_reason = Str(required=False, allow_none=True)

mail_body `class-attribute` `instance-attribute` ¶

mail_body = Str(required=True)

mail_subject `class-attribute` `instance-attribute` ¶

mail_subject = Str(required=True)

admin_order_endpoint `module-attribute` ¶

admin_order_endpoint = Endpoint('')

admin_testimonial ¶

AdminTestimonialController ¶

Bases: BaseController

TestimonialPayload `dataclass` ¶

TestimonialPayload(
    testimonial=None,
    internal_comment=None,
    alan_answer=None,
    is_reviewed=False,
    is_visible_from_product=False,
)

Bases: DataClassJsonMixin

Data class for admin testimonial payload.

alan_answer `class-attribute` `instance-attribute` ¶

alan_answer = None

internal_comment `class-attribute` `instance-attribute` ¶

internal_comment = None

is_reviewed `class-attribute` `instance-attribute` ¶

is_reviewed = False

is_visible_from_product `class-attribute` `instance-attribute` ¶

is_visible_from_product = False

testimonial `class-attribute` `instance-attribute` ¶

testimonial = None

admin_testimonial_endpoint `module-attribute` ¶

admin_testimonial_endpoint = Endpoint('')

eligibility ¶

ShopEligibilityController ¶

Bases: BaseController

shop_eligibility_endpoint `module-attribute` ¶

shop_eligibility_endpoint = Endpoint('eligibility')

intercom ¶

CreateConversationForFulfillmentPostJsonSchema ¶

Bases: Schema

Schema for POST /create_conversation_for_fulfillment.

fulfillment_id `class-attribute` `instance-attribute` ¶

fulfillment_id = Str(
    required=True,
    validate=OwnerController(NoOwner),
    metadata={"description": "The ID of the fulfillment"},
)

intercom_space `class-attribute` `instance-attribute` ¶

intercom_space = Enum(
    IntercomSpace,
    by_value=True,
    required=True,
    validate=OwnerController(NoOwner),
    metadata={
        "description": "The Intercom space to use (shop or care)"
    },
)

operator_full_name `class-attribute` `instance-attribute` ¶

operator_full_name = Str(
    required=True,
    validate=OwnerController(NoOwner),
    metadata={
        "description": "The full name of Saleor connected user"
    },
)

order_id `class-attribute` `instance-attribute` ¶

order_id = Str(
    required=True,
    validate=OwnerController(NoOwner),
    metadata={"description": "The ID of the order"},
)

template_id `class-attribute` `instance-attribute` ¶

template_id = Str(
    required=True,
    validate=OwnerController(NoOwner),
    metadata={"description": "The ID of the template"},
)

IntercomController ¶

Bases: BaseController

intercom_endpoint `module-attribute` ¶

intercom_endpoint = Endpoint('intercom')

invoicing ¶

InvoicingController ¶

Bases: BaseController

InvoicingSchema ¶

Bases: Schema

Schema for POST /generate_and_upload_invoice and GET /retrieve_transactions_to_invoice.

app_id `class-attribute` `instance-attribute` ¶

app_id = Enum(required=True, enum=AppName, by_value=True)

period `class-attribute` `instance-attribute` ¶

period = Date(required=True, format='%Y-%m-%d')

unique_id `class-attribute` `instance-attribute` ¶

unique_id = Str(required=True)

usage_type `class-attribute` `instance-attribute` ¶

usage_type = Enum(required=True, enum=UsageType)

invoicing_endpoint `module-attribute` ¶

invoicing_endpoint = Endpoint('invoicing')

saleor_admin_token ¶

SaleorAdminTokenController ¶

Bases: BaseController

saleor_admin_token_endpoint `module-attribute` ¶

saleor_admin_token_endpoint = Endpoint('')

saleor_checkout ¶

SaleorCheckoutController ¶

Bases: BaseController

saleor_checkout_endpoint `module-attribute` ¶

saleor_checkout_endpoint = Endpoint('saleor_checkouts')

saleor_manifest ¶

FULFILLMENT_EVENTS_SUBSCRIPTION_QUERY `module-attribute` ¶

FULFILLMENT_EVENTS_SUBSCRIPTION_QUERY = "subscription {\n  event {\n    ... on FulfillmentApproved {\n      __typename\n      order {\n        id\n      }\n      fulfillment {\n        id\n      }\n    }\n    ... on FulfillmentCanceled {\n      __typename\n      order {\n        id\n      }\n      fulfillment {\n        id\n      }\n    }\n  }\n}\n"

ORDER_EVENTS_SUBSCRIPTION_QUERY `module-attribute` ¶

ORDER_EVENTS_SUBSCRIPTION_QUERY = "subscription {\n  event {\n    ... on OrderCancelled {\n      __typename\n      order {\n        id\n      }\n    }\n    ... on OrderConfirmed {\n      __typename\n      order {\n        id\n      }\n    }\n    ... on OrderCreated {\n      __typename\n      order {\n        id\n      }\n    }\n    ... on OrderFulfilled {\n      __typename\n      order {\n        id\n      }\n    }\n    ... on OrderUpdated {\n      __typename\n      order {\n        id\n      }\n    }\n    ... on OrderRefunded {\n      __typename\n      order {\n        id\n      }\n    }\n    ... on OrderPaid {\n      __typename\n      order {\n        id\n      }\n    }\n    ... on OrderMetadataUpdated {\n      __typename\n      order {\n        id\n      }\n    }\n    ... on OrderFullyRefunded {\n      __typename\n      order {\n        id\n      }\n    }\n    ... on OrderFullyPaid {\n      __typename\n      order {\n        id\n      }\n    }\n    ... on OrderExpired {\n      __typename\n      order {\n        id\n      }\n    }\n  }\n}\n"

PAYMENT_EVENTS_SUBSCRIPTION_QUERY `module-attribute` ¶

PAYMENT_EVENTS_SUBSCRIPTION_QUERY = "subscription {\n  event {\n    ... on TransactionInitializeSession {\n      __typename\n      transaction {\n        ...SaleorTransactionItem\n      }\n      action {\n        ...SaleorTransactionProcessAction\n      }\n      sourceObject {\n        __typename\n        ...SaleorOrder\n        ...SaleorCheckout\n      }\n    }\n    ... on TransactionProcessSession {\n      __typename\n      transaction {\n        ...SaleorTransactionItem\n      }\n      action {\n        ...SaleorTransactionProcessAction\n      }\n    }\n  }\n}\n\nfragment SaleorTransactionItem on TransactionItem {\n  id\n  pspReference\n}\n\nfragment SaleorTransactionProcessAction on TransactionProcessAction {\n  actionType\n  amount\n  currency\n}\n\nfragment SaleorOrder on Order {\n  id\n}\n\nfragment SaleorCheckout on Checkout {\n  id\n}\n"

PERMISSIONS `module-attribute` ¶

PERMISSIONS = [
    "HANDLE_CHECKOUTS",
    "HANDLE_PAYMENTS",
    "HANDLE_TAXES",
    "IMPERSONATE_USER",
    "MANAGE_APPS",
    "MANAGE_CHANNELS",
    "MANAGE_CHECKOUTS",
    "MANAGE_DISCOUNTS",
    "MANAGE_GIFT_CARD",
    "MANAGE_MENUS",
    "MANAGE_OBSERVABILITY",
    "MANAGE_ORDERS",
    "MANAGE_ORDERS_IMPORT",
    "MANAGE_PAGES",
    "MANAGE_PAGE_TYPES_AND_ATTRIBUTES",
    "MANAGE_PLUGINS",
    "MANAGE_PRODUCTS",
    "MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES",
    "MANAGE_SETTINGS",
    "MANAGE_SHIPPING",
    "MANAGE_STAFF",
    "MANAGE_TAXES",
    "MANAGE_TRANSLATIONS",
    "MANAGE_USERS",
]

SaleorManifestController ¶

Bases: BaseController

TRANSACTION_EVENTS_SUBSCRIPTION_QUERY `module-attribute` ¶

TRANSACTION_EVENTS_SUBSCRIPTION_QUERY = "subscription {\n  event {\n    ... on TransactionCancelationRequested {\n      __typename\n      transaction {\n        ...SaleorTransactionItem\n      }\n      action {\n        ...SaleorTransactionAction\n      }\n    }\n    ... on TransactionChargeRequested {\n      __typename\n      transaction {\n        ...SaleorTransactionItem\n      }\n      action {\n        ...SaleorTransactionAction\n      }\n    }\n    ... on TransactionRefundRequested {\n      __typename\n      transaction {\n        ...SaleorTransactionItem\n      }\n      action {\n        ...SaleorTransactionAction\n      }\n    }\n  }\n}\n\nfragment SaleorTransactionItem on TransactionItem {\n  id\n  pspReference\n}\n\nfragment SaleorTransactionAction on TransactionAction {\n  actionType\n  amount\n  currency\n}\n"

saleor_manifest_endpoint `module-attribute` ¶

saleor_manifest_endpoint = Endpoint('saleor_manifest')

saleor_register ¶

SaleorRegisterController ¶

Bases: BaseController

saleor_register_endpoint `module-attribute` ¶

saleor_register_endpoint = Endpoint('saleor_register')

saleor_webhook ¶

SaleorFulfillmentEventsPostJsonSchema ¶

Bases: _SaleorWebhookBaseSchema

fulfillment `class-attribute` `instance-attribute` ¶

fulfillment = Dict(
    required=True,
    metadata={"description": "Saleor fulfillment"},
)

order `class-attribute` `instance-attribute` ¶

order = Dict(
    required=True, metadata={"description": "Saleor order"}
)

SaleorOrderEventsPostJsonSchema ¶

Bases: _SaleorWebhookBaseSchema

order `class-attribute` `instance-attribute` ¶

order = Dict(
    required=True, metadata={"description": "Saleor order"}
)

SaleorPaymentEventsPostJsonSchema ¶

Bases: _SaleorWebhookBaseSchema

action `class-attribute` `instance-attribute` ¶

action = Dict(
    required=False,
    load_default={},
    metadata={"description": "action of the event"},
)

sourceObject `class-attribute` `instance-attribute` ¶

sourceObject = Dict(
    required=False,
    load_default={},
    metadata={
        "description": "could be either an order or a checkout"
    },
)

transaction `class-attribute` `instance-attribute` ¶

transaction = Dict(
    required=True,
    metadata={"description": "transaction of the event"},
)

SaleorTransactionEventsPostJsonSchema ¶

Bases: _SaleorWebhookBaseSchema

action `class-attribute` `instance-attribute` ¶

action = Dict(
    required=True,
    metadata={"description": "action of the event"},
)

transaction `class-attribute` `instance-attribute` ¶

transaction = Dict(
    required=True,
    metadata={"description": "transaction of the event"},
)

SaleorWebhookController ¶

Bases: BaseController

saleor_webhook_endpoint `module-attribute` ¶

saleor_webhook_endpoint = Endpoint('saleor_webhooks')

saleor_webhooks_config ¶

SaleorWebhooksConfigController ¶

Bases: BaseController

saleor_webhooks_config_endpoint `module-attribute` ¶

saleor_webhooks_config_endpoint = Endpoint(
    "saleor_webhooks_config"
)

shop_user ¶

GetShopUserGetQuerySchema ¶

Bases: Schema

Schema for GET /shop_user.

update_visit `class-attribute` `instance-attribute` ¶

update_visit = Bool(load_default=True)

ShopUserController ¶

Bases: BaseController

UpdateShopUserPatchJsonSchema ¶

Bases: Schema

Schema for PATCH /shop_user.

shop_notifications_disabled `class-attribute` `instance-attribute` ¶

shop_notifications_disabled = Bool(
    required=False, allow_none=True
)

shop_user_endpoint `module-attribute` ¶

shop_user_endpoint = Endpoint('shop_user')

shopify_order ¶

ShopifyOrderController ¶

Bases: BaseController

shopify_order_endpoint `module-attribute` ¶

shopify_order_endpoint = Endpoint('shopify_orders')

stripe_webhook ¶

StripeWebhookController ¶

Bases: BaseController

stripe_webhook_endpoint `module-attribute` ¶

stripe_webhook_endpoint = Endpoint('stripe_webhooks')

testimonial ¶

TestimonialController ¶

Bases: BaseController

testimonial_endpoint `module-attribute` ¶

testimonial_endpoint = Endpoint('')

components.shop.public.enums ¶

ContactLensAddition ¶

Bases: AlanBaseEnum

This enum is used to store the addition of a contact lens.

high `class-attribute` `instance-attribute` ¶

high = 'high'

low `class-attribute` `instance-attribute` ¶

low = 'low'

medium `class-attribute` `instance-attribute` ¶

medium = 'medium'

ContactLensItemType ¶

Bases: AlanBaseEnum

This enum is used to store the type of a contact lens item.

left_eye `class-attribute` `instance-attribute` ¶

left_eye = 'left_eye'

right_eye `class-attribute` `instance-attribute` ¶

right_eye = 'right_eye'

solution `class-attribute` `instance-attribute` ¶

solution = 'solution'

ContactLensND ¶

Bases: AlanBaseEnum

This enum is used to store the ND of a contact lens.

D `class-attribute` `instance-attribute` ¶

D = 'D'

N `class-attribute` `instance-attribute` ¶

N = 'N'

ContactLensProductType ¶

Bases: AlanBaseEnum

This enum is used to store the product type of a contact lens.

contact_lens `class-attribute` `instance-attribute` ¶

contact_lens = 'contact_lens'

contact_lens_bi_monthly `class-attribute` `instance-attribute` ¶

contact_lens_bi_monthly = 'contact_lens_bi_monthly'

contact_lens_bifocal `class-attribute` `instance-attribute` ¶

contact_lens_bifocal = 'contact_lens_bifocal'

contact_lens_colored `class-attribute` `instance-attribute` ¶

contact_lens_colored = 'contact_lens_colored'

contact_lens_daily `class-attribute` `instance-attribute` ¶

contact_lens_daily = 'contact_lens_daily'

contact_lens_extended_wear `class-attribute` `instance-attribute` ¶

contact_lens_extended_wear = 'contact_lens_extended_wear'

contact_lens_for_sport `class-attribute` `instance-attribute` ¶

contact_lens_for_sport = 'contact_lens_for_sport'

contact_lens_monthly `class-attribute` `instance-attribute` ¶

contact_lens_monthly = 'contact_lens_monthly'

contact_lens_multifocal `class-attribute` `instance-attribute` ¶

contact_lens_multifocal = 'contact_lens_multifocal'

contact_lens_progressive `class-attribute` `instance-attribute` ¶

contact_lens_progressive = 'contact_lens_progressive'

contact_lens_spherical `class-attribute` `instance-attribute` ¶

contact_lens_spherical = 'contact_lens_spherical'

contact_lens_toric `class-attribute` `instance-attribute` ¶

contact_lens_toric = 'contact_lens_toric'

ContactLensSolutionType ¶

Bases: AlanBaseEnum

This enum is used to store the solution type of a contact lens.

solution `class-attribute` `instance-attribute` ¶

solution = 'solution'

solution_for_rigid `class-attribute` `instance-attribute` ¶

solution_for_rigid = 'solution_for_rigid'

solution_for_soft `class-attribute` `instance-attribute` ¶

solution_for_soft = 'solution_for_soft'

solution_ophtalmic `class-attribute` `instance-attribute` ¶

solution_ophtalmic = 'solution_ophtalmic'

solution_travel_kit `class-attribute` `instance-attribute` ¶

solution_travel_kit = 'solution_travel_kit'

ContactLensStatus ¶

Bases: AlanBaseEnum

This enum is used to store the status of a contact lens.

available `class-attribute` `instance-attribute` ¶

available = 'available'

not_available `class-attribute` `instance-attribute` ¶

not_available = 'not_available'

out_of_stock `class-attribute` `instance-attribute` ¶

out_of_stock = 'out_of_stock'

InvoicingDocumentType ¶

Bases: AlanBaseEnum

This enum is used to store the type of invoice generation.

credit_note `class-attribute` `instance-attribute` ¶

credit_note = 'credit_note'

invoice_update `class-attribute` `instance-attribute` ¶

invoice_update = 'invoice_update'

regular_invoice `class-attribute` `instance-attribute` ¶

regular_invoice = 'regular_invoice'

PrescriptionCheckProblemSeverity ¶

Bases: AlanBaseEnum

This enum is used to store the severity of a prescription check problem.

high `class-attribute` `instance-attribute` ¶

high = 'high'

low `class-attribute` `instance-attribute` ¶

low = 'low'

PrescriptionCheckProblemType ¶

Bases: AlanBaseEnum

This enum is used to store the type of a prescription check problem.

beneficiary `class-attribute` `instance-attribute` ¶

beneficiary = 'beneficiary'

brand `class-attribute` `instance-attribute` ¶

brand = 'brand'

date `class-attribute` `instance-attribute` ¶

date = 'date'

left_addition `class-attribute` `instance-attribute` ¶

left_addition = 'left-addition'

left_axis `class-attribute` `instance-attribute` ¶

left_axis = 'left-axis'

left_curve `class-attribute` `instance-attribute` ¶

left_curve = 'left-curve'

left_cylinder `class-attribute` `instance-attribute` ¶

left_cylinder = 'left-cylinder'

left_sphere `class-attribute` `instance-attribute` ¶

left_sphere = 'left-sphere'

right_addition `class-attribute` `instance-attribute` ¶

right_addition = 'right-addition'

right_axis `class-attribute` `instance-attribute` ¶

right_axis = 'right-axis'

right_curve `class-attribute` `instance-attribute` ¶

right_curve = 'right-curve'

right_cylinder `class-attribute` `instance-attribute` ¶

right_cylinder = 'right-cylinder'

right_sphere `class-attribute` `instance-attribute` ¶

right_sphere = 'right-sphere'

trial_lenses `class-attribute` `instance-attribute` ¶

trial_lenses = 'trial_lenses'

type `class-attribute` `instance-attribute` ¶

type = 'type'

TransactionType ¶

Bases: AlanBaseEnum

This enum is used to store the type of a transaction.

claim `class-attribute` `instance-attribute` ¶

claim = 'claim'

stripe `class-attribute` `instance-attribute` ¶

stripe = 'stripe'

UsageSource ¶

Bases: AlanBaseEnum

This enum is used to store the source of an claim usage.

backend `class-attribute` `instance-attribute` ¶

backend = 'backend'

saleor `class-attribute` `instance-attribute` ¶

saleor = 'saleor'

UsageStatus ¶

Bases: AlanBaseEnum

This enum is used to store the status of a claim usage.

pending `class-attribute` `instance-attribute` ¶

pending = 'pending'

processed `class-attribute` `instance-attribute` ¶

processed = 'processed'

refunded `class-attribute` `instance-attribute` ¶

refunded = 'refunded'

UsageType ¶

Bases: AlanBaseEnum

This enum is used to store the type of claim usage.

contact_lens `class-attribute` `instance-attribute` ¶

contact_lens = 'contact_lens'

glasses `class-attribute` `instance-attribute` ¶

glasses = 'glasses'

other `class-attribute` `instance-attribute` ¶

other = 'other'

ValidationDecision ¶

Bases: AlanBaseEnum

This enum is used to store the decision of a validation.

approved `class-attribute` `instance-attribute` ¶

approved = 'approved'

rejected `class-attribute` `instance-attribute` ¶

rejected = 'rejected'

skipped `class-attribute` `instance-attribute` ¶

skipped = 'skipped'

components.shop.public.events ¶

ShopTestimonialPublished `dataclass` ¶

ShopTestimonialPublished(
    testimonial,
    rating,
    product_id,
    user_name,
    app_user_id,
    app_id,
    external_order_id,
)

Bases: WebhookMessage

Event triggered when a ShopTestimonial has been published.

app_id `instance-attribute` ¶

app_id

app_user_id `instance-attribute` ¶

app_user_id

external_order_id `instance-attribute` ¶

external_order_id

product_id `instance-attribute` ¶

product_id

rating `instance-attribute` ¶

rating

testimonial `instance-attribute` ¶

testimonial

user_name `instance-attribute` ¶

user_name

components.shop.public.flask_admin_configuration ¶

components.shop.public.globalization ¶

base_prescription_checker ¶

BasePrescriptionChecker ¶

BasePrescriptionChecker(saleor_client=None, dry_run=False)

Bases: ABC

Base class for prescription checkers, providing methods to implement the prescription checking logic.

Source code in components/shop/public/globalization/base_prescription_checker.py

def __init__(
    self, saleor_client: Optional[SaleorClient] = None, dry_run: bool = False
):
    self.saleor_client = saleor_client or SaleorClient()
    self.dry_run = dry_run

check_contact_lens_prescription_content `abstractmethod` ¶

check_contact_lens_prescription_content(
    beneficiary_user_id,
    content,
    contact_lens_items,
    order_date=None,
)

Check the contact lenses prescription content.

Source code in components/shop/public/globalization/base_prescription_checker.py

@abstractmethod
def check_contact_lens_prescription_content(
    self,
    beneficiary_user_id: str,
    content: PrescriptionContent,
    contact_lens_items: list[ContactLensItem],
    order_date: date | None = None,
) -> PrescriptionCheckerResult:
    """Check the contact lenses prescription content."""

check_glasses_prescription_content `abstractmethod` ¶

check_glasses_prescription_content(
    beneficiary_user_id, beneficiary_calendar_age, content
)

Check the glasses prescription content.

Source code in components/shop/public/globalization/base_prescription_checker.py

@abstractmethod
def check_glasses_prescription_content(
    self,
    beneficiary_user_id: str,
    beneficiary_calendar_age: int,
    content: PrescriptionContent,
) -> PrescriptionCheckerResult:
    """Check the glasses prescription content."""

check_saleor_contact_lens_checkout_prescription_content `abstractmethod` ¶

check_saleor_contact_lens_checkout_prescription_content(
    checkout_id, content
)

Check the SaleorCheckout contact lens prescription.

Source code in components/shop/public/globalization/base_prescription_checker.py

@abstractmethod
def check_saleor_contact_lens_checkout_prescription_content(
    self,
    checkout_id: str,
    content: PrescriptionContent,
) -> PrescriptionCheckerResult:
    """Check the SaleorCheckout contact lens prescription."""

check_saleor_contact_lens_fulfillment_prescription `abstractmethod` ¶

check_saleor_contact_lens_fulfillment_prescription(
    order, fulfillment
)

Check the SaleorOrder prescription.

Source code in components/shop/public/globalization/base_prescription_checker.py

@abstractmethod
def check_saleor_contact_lens_fulfillment_prescription(
    self,
    order: SaleorOrder,
    fulfillment: SaleorFulfillment,
) -> PrescriptionCheckerResult:
    """Check the SaleorOrder prescription."""

check_saleor_glasses_checkout_prescription_content `abstractmethod` ¶

check_saleor_glasses_checkout_prescription_content(
    checkout_id, content
)

Check the SaleorCheckout glasses prescription.

Source code in components/shop/public/globalization/base_prescription_checker.py

@abstractmethod
def check_saleor_glasses_checkout_prescription_content(
    self,
    checkout_id: str,
    content: PrescriptionContent,
) -> PrescriptionCheckerResult:
    """Check the SaleorCheckout glasses prescription."""

document_content_is_of_type `abstractmethod` ¶

document_content_is_of_type(content, document_type)

Abstract method to check if the document content is of the given type.

Source code in components/shop/public/globalization/base_prescription_checker.py

@abstractmethod
def document_content_is_of_type(
    self,
    content: PrescriptionContent,
    document_type: str,
) -> bool:
    """Abstract method to check if the document content is of the given type."""

dry_run `class-attribute` `instance-attribute` ¶

dry_run = dry_run

extract_prescription_duration_in_years `abstractmethod` ¶

extract_prescription_duration_in_years(
    content, duration_type="any"
)

Extract prescription duration in years from transcription.

Source code in components/shop/public/globalization/base_prescription_checker.py

@abstractmethod
def extract_prescription_duration_in_years(
    self,
    content: PrescriptionContent,
    duration_type: Literal["any", "qsp", "validity"] = "any",
) -> int | None:
    """Extract prescription duration in years from transcription."""

retrieve_prescription_content `abstractmethod` ¶

retrieve_prescription_content(
    prescription_id,
    compute_if_not_parsed_yet=False,
    use_transcription=False,
    automated_parsing_only=False,
)

Abstract method to retrieve the prescription content.

Source code in components/shop/public/globalization/base_prescription_checker.py

@abstractmethod
def retrieve_prescription_content(
    self,
    prescription_id: str,
    compute_if_not_parsed_yet: bool = False,
    use_transcription: bool = False,
    automated_parsing_only: bool = False,
) -> Optional[PrescriptionContent]:
    """Abstract method to retrieve the prescription content."""

retrieve_prescription_transcription `abstractmethod` ¶

retrieve_prescription_transcription(prescription_id)

Abstract method to retrieve the prescription transcription.

Source code in components/shop/public/globalization/base_prescription_checker.py

@abstractmethod
def retrieve_prescription_transcription(
    self,
    prescription_id: str,
) -> Optional[PrescriptionTranscription]:
    """Abstract method to retrieve the prescription transcription."""

saleor_client `instance-attribute` ¶

saleor_client = saleor_client or SaleorClient()

base_shop_adapter ¶

BaseShopAdapter ¶

Bases: ABC

Base class for shop adapters, providing methods to implement the Shop.

generate_contact_lens_global_invoice `abstractmethod` ¶

generate_contact_lens_global_invoice(
    transactions_to_invoice, period, is_preview=False
)

Generate the invoice from Alan Tech to Alan Insurance for the contact lens claim transactions of a given period.