Routers

Card Templates

ccbenefits.routers.card_templates.list_card_templates(db=Depends(dependency=<function get_db>, use_cache=True, scope=None))

Parameters:

db (Session)

ccbenefits.routers.card_templates.get_card_template(card_template_id, db=Depends(dependency=<function get_db>, use_cache=True, scope=None))

Parameters:

• card_template_id (int)

• db (Session)

User Cards

ccbenefits.routers.user_cards.create_user_card(data, db=Depends(dependency=<function get_db>, use_cache=True, scope=None), current_user=Depends(dependency=<function get_current_user>, use_cache=True, scope=None))

Parameters:

• data (UserCardCreate)

• db (Session)

• current_user (User)

ccbenefits.routers.user_cards.update_user_card(user_card_id, data, db=Depends(dependency=<function get_db>, use_cache=True, scope=None), current_user=Depends(dependency=<function get_current_user>, use_cache=True, scope=None))

Parameters:

• user_card_id (int)

• data (UserCardUpdate)

• db (Session)

• current_user (User)

ccbenefits.routers.user_cards.list_user_cards(db=Depends(dependency=<function get_db>, use_cache=True, scope=None), current_user=Depends(dependency=<function get_current_user>, use_cache=True, scope=None), year=Query(None))

Parameters:

• db (Session)

• current_user (User)

• year (int | None)

ccbenefits.routers.user_cards.list_user_card_details(db=Depends(dependency=<function get_db>, use_cache=True, scope=None), current_user=Depends(dependency=<function get_current_user>, use_cache=True, scope=None), year=Query(None))

Parameters:

• db (Session)

• current_user (User)

• year (int | None)

ccbenefits.routers.user_cards.get_user_card_detail(user_card_id, db=Depends(dependency=<function get_db>, use_cache=True, scope=None), current_user=Depends(dependency=<function get_current_user>, use_cache=True, scope=None), year=Query(None))

Parameters:

• user_card_id (int)

• db (Session)

• current_user (User)

• year (int | None)

ccbenefits.routers.user_cards.delete_user_card(user_card_id, db=Depends(dependency=<function get_db>, use_cache=True, scope=None), current_user=Depends(dependency=<function get_current_user>, use_cache=True, scope=None))

Parameters:

• user_card_id (int)

• db (Session)

• current_user (User)

ccbenefits.routers.user_cards.close_user_card(user_card_id, data, db=Depends(dependency=<function get_db>, use_cache=True, scope=None), current_user=Depends(dependency=<function get_current_user>, use_cache=True, scope=None))

Parameters:

• user_card_id (int)

• data (CardCloseRequest)

• db (Session)

• current_user (User)

ccbenefits.routers.user_cards.reopen_user_card(user_card_id, db=Depends(dependency=<function get_db>, use_cache=True, scope=None), current_user=Depends(dependency=<function get_current_user>, use_cache=True, scope=None))

Parameters:

• user_card_id (int)

• db (Session)

• current_user (User)

ccbenefits.routers.user_cards.log_usage(user_card_id, data, db=Depends(dependency=<function get_db>, use_cache=True, scope=None), current_user=Depends(dependency=<function get_current_user>, use_cache=True, scope=None))

Parameters:

• user_card_id (int)

• data (BenefitUsageCreate)

• db (Session)

• current_user (User)

ccbenefits.routers.user_cards.upsert_benefit_setting(user_card_id, benefit_template_id, data, db=Depends(dependency=<function get_db>, use_cache=True, scope=None), current_user=Depends(dependency=<function get_current_user>, use_cache=True, scope=None))

Parameters:

• user_card_id (int)

• benefit_template_id (int)

• data (BenefitSettingUpdate)

• db (Session)

• current_user (User)

ccbenefits.routers.user_cards.get_card_summary(user_card_id, db=Depends(dependency=<function get_db>, use_cache=True, scope=None), current_user=Depends(dependency=<function get_current_user>, use_cache=True, scope=None), year=Query(None))

Parameters:

• user_card_id (int)

• db (Session)

• current_user (User)

• year (int | None)

Usage

ccbenefits.routers.usage.update_usage(usage_id, data, db=Depends(dependency=<function get_db>, use_cache=True, scope=None), current_user=Depends(dependency=<function get_current_user>, use_cache=True, scope=None))

Parameters:

• usage_id (int)

• data (BenefitUsageUpdate)

• db (Session)

• current_user (User)

ccbenefits.routers.usage.delete_usage(usage_id, db=Depends(dependency=<function get_db>, use_cache=True, scope=None), current_user=Depends(dependency=<function get_current_user>, use_cache=True, scope=None))

Parameters:

• usage_id (int)

• db (Session)

• current_user (User)