Api reference

components.instant_quote.public.blueprint ¶

create_api ¶

create_api(app_or_blueprint)

Source code in components/instant_quote/public/blueprint.py

def create_api(app_or_blueprint) -> None:  # type: ignore[no-untyped-def]  # noqa: D103
    from shared.api.custom_api import CustomApi

    api = CustomApi(app_or_blueprint)

    @api.representation("application/json")
    def output_json(data, code, headers=None):  # type: ignore[no-untyped-def]
        """Tells flask-restful to use the flask json serializer instead of json."""
        return make_response(jsonify(data), code, headers)

    from components.instant_quote.public.controllers.admin_instant_quotes import (
        admin_instant_quote_endpoint,
    )
    from components.instant_quote.public.controllers.instant_quote import (
        instant_quote_endpoint,
    )

    api.add_endpoint(instant_quote_endpoint)
    api.add_endpoint(admin_instant_quote_endpoint)

instant_quote_api_blueprint `module-attribute` ¶

instant_quote_api_blueprint = CustomBlueprint(
    "instant_quote_api_blueprint", __name__
)

components.instant_quote.public.controllers ¶

admin_instant_quotes ¶

AdminInstantQuoteController ¶

Bases: BaseController

delete ¶

delete(id)

Source code in components/instant_quote/public/controllers/admin_instant_quotes.py

@view_method(
    auth_strategy=GlobalAuthorizationStrategies().alaner_admin(
        permitted_for={EmployeePermission.use_offer_builder}
    ),
)
@obs.api_call()
def delete(self, id: str):  # type: ignore[no-untyped-def]  # noqa: D102
    from components.instant_quote.internal.instant_quote import (
        delete_instant_quote as delete_instant_quote_api,
    )

    delete_instant_quote_api(instant_quote_id=id)
    current_session.commit()
    return make_json_response()

admin_instant_quote_endpoint `module-attribute` ¶

admin_instant_quote_endpoint = Endpoint(
    "/marmot/instant_quotes"
)

create_instant_quote ¶

create_instant_quote(params)

Source code in components/instant_quote/public/controllers/admin_instant_quotes.py

@AdminInstantQuoteController.action_route(
    "",
    methods=["POST"],
    auth_strategy=GlobalAuthorizationStrategies().alaner_admin(
        permitted_for={EmployeePermission.use_offer_builder}
    ),
)
@request_argument("account_ref", type=str, required=True)
@request_argument("title", type=str, required=True)
@request_argument("introduction_paragraph", type=str, required=False)
@request_argument("competitor_product_ref", type=str, required=False)
@request_argument(
    "product_version",
    type=dict,  # TODO simplify in frontend, can send product_version_ref as simple str instead of dict
    required=True,
)
@request_argument("contact_email", type=str, required=False)
@obs.api_call()
def create_instant_quote(params):  # type: ignore[no-untyped-def]  # noqa: D103
    from datetime import timedelta

    from components.instant_quote.public.controllers.presenters.instant_quote import (
        InstantQuotePresenter,
    )
    from components.instant_quote.public.main import (
        create_instant_quote as create_instant_quote_api,
    )
    from shared.helpers.time.utc import utctoday

    instant_quote = create_instant_quote_api(
        account_ref=params["account_ref"],
        title=params["title"],
        introduction_paragraph=params.get("introduction_paragraph"),
        competitor_product_ref=params.get("competitor_product_ref"),
        product_version_ref=params["product_version"]["id"],
        creator_ref=g.current_user.id,
        creator_display_name=g.current_user.full_name,
        contact_email=params.get("contact_email"),
        expire_on=utctoday() + timedelta(days=7),
    )
    current_session.commit()

    return make_json_response(InstantQuotePresenter.from_entity(entity=instant_quote))

paginate_instant_quotes ¶

paginate_instant_quotes(params)

Source code in components/instant_quote/public/controllers/admin_instant_quotes.py

@AdminInstantQuoteController.action_route(
    "",
    methods=["GET"],
    auth_strategy=GlobalAuthorizationStrategies().alaner_admin(
        permitted_for={EmployeePermission.use_offer_builder}
    ),
)
@request_argument("account_ref", type=str, required=True)
@obs.api_call()
def paginate_instant_quotes(params: dict):  # type: ignore[type-arg,no-untyped-def]  # noqa: D103
    from components.instant_quote.public.controllers.presenters.instant_quote import (
        InstantQuotePresenter,
    )
    from components.instant_quote.public.main import (
        paginate_instant_quotes as paginate_instant_quotes_api,
    )

    instant_quotes = paginate_instant_quotes_api(
        page=1, per_page=30, account_ref=params["account_ref"]
    )

    return make_json_response(
        [
            InstantQuotePresenter.from_entity(entity=quote)
            for quote in instant_quotes.items
        ]
    )

refresh_token ¶

refresh_token(params)

Source code in components/instant_quote/public/controllers/admin_instant_quotes.py

@AdminInstantQuoteController.action_route(
    "/refresh_token",
    methods=["POST"],
    auth_strategy=GlobalAuthorizationStrategies().alaner_admin(
        permitted_for={EmployeePermission.use_offer_builder}
    ),
)
@request_argument("id", type=str, required=True)
@obs.api_call()
def refresh_token(params):  # type: ignore[no-untyped-def]  # noqa: D103
    from components.instant_quote.public.controllers.presenters.instant_quote import (
        InstantQuotePresenter,
    )
    from components.instant_quote.public.main import (
        get_instant_quote as get_instant_quote_entity,
        refresh_token as refresh_token_api,
    )

    refresh_token_api(instant_quote_id=params["id"])
    current_session.commit()

    instant_quote_entity = get_instant_quote_entity(instant_quote_id=params["id"])

    return make_json_response(
        InstantQuotePresenter.from_entity(entity=instant_quote_entity)
    )

instant_quote ¶