MCPcopy Create free account

hub / github.com/alphagov/notifications-api / endpoints

Endpoints315 in github.com/alphagov/notifications-api

⨍ Functions 5,336◇ Types & classes 258↳ Endpoints 315
Routeraising_auth_error
blue.route("/raise_auth_error", methods=["GET"])
tests/app/v2/test_errors.py:None
Routeraising_bad_request
blue.route("/raise_bad_request", methods=["GET"])
tests/app/v2/test_errors.py:None
Routeraising_data_error
blue.route("raise_data_error", methods=["GET"])
tests/app/v2/test_errors.py:None
Routeraising_document_download_error
blue.route("/raise_document_download_error", methods=["GET"])
tests/app/v2/test_errors.py:None
Routeraising_exception
blue.route("raise_exception", methods=["GET"])
tests/app/v2/test_errors.py:None
Routeraising_invalid_phone_error
blue.route("raise_phone_error/<error_id>", methods=["GET"])
tests/app/v2/test_errors.py:None
Routeraising_too_many_requests
blue.route("/raise_too_many_requests", methods=["GET"])
tests/app/v2/test_errors.py:None
Routeraising_validation_error
blue.route("/raise_validation_error", methods=["GET"])
tests/app/v2/test_errors.py:None
Routereceive_firetext_sms
receive_notifications_blueprint.route("/notifications/sms/receive/firetext", methods=["POST"])
app/notifications/receive_notifications.py:None
Routereceive_mmg_sms
receive_notifications_blueprint.route("/notifications/sms/receive/mmg", methods=["POST"])
app/notifications/receive_notifications.py:None
Routeremove_email_branding_from_organisation_pool
organisation_blueprint.route( "/<uuid:organisation_id>/email-branding-pool/<uuid:email_branding_id>", meth
app/organisation/rest.py:None
Routeremove_inbound_sms_for_service
inbound_sms.route("/remove", methods=["POST"])
app/inbound_sms/rest.py:None
Routeremove_letter_branding_from_organisation_pool
organisation_blueprint.route( "/<uuid:organisation_id>/letter-branding-pool/<uuid:letter_branding_id>", me
app/organisation/rest.py:None
Routeremove_service_callback_api
service_callback_blueprint.route("/callback-api/<uuid:callback_api_id>", methods=["DELETE"])
app/service/callback_rest.py:None
Routeremove_user_from_organisation
organisation_blueprint.route("/<uuid:organisation_id>/users/<uuid:user_id>", methods=["DELETE"])
app/organisation/rest.py:None
Routeremove_user_from_service
service_blueprint.route("/<uuid:service_id>/users/<user_id>", methods=["DELETE"])
app/service/rest.py:None
Routereplay_create_pdf_for_templated_letter
click.option( "-n", "--notification_id", type=click.UUID, required=True, help="Notificatio
app/commands.py:None
Routereturned_letter_statistics
service_blueprint.route("/<uuid:service_id>/returned-letter-statistics", methods=["GET"])
app/service/rest.py:None
Routereturned_letter_summary
service_blueprint.route("/<uuid:service_id>/returned-letter-summary", methods=["GET"])
app/service/rest.py:None
Routerevoke_api_key
service_blueprint.route("/<uuid:service_id>/api-key/revoke/<uuid:api_key_id>", methods=["POST"])
app/service/rest.py:None
Routesearch
organisation_blueprint.route("/search", methods=["GET"])
app/organisation/rest.py:None
Routesend_already_registered_email
user_blueprint.route("/<uuid:user_id>/email-already-registered", methods=["POST"])
app/user/rest.py:None
Routesend_new_user_email_verification
user_blueprint.route("/<uuid:user_id>/email-verification", methods=["POST"])
app/user/rest.py:None
Routesend_user_2fa_code
user_blueprint.route("/<uuid:user_id>/<code_type>-code", methods=["POST"])
app/user/rest.py:None
Routesend_user_confirm_new_email
user_blueprint.route("/<uuid:user_id>/change-email-verification", methods=["POST"])
app/user/rest.py:None
Routesend_user_reset_password
user_blueprint.route("/reset-password", methods=["POST"])
app/user/rest.py:None
Routeset_organisation_permissions
user_blueprint.route("/<uuid:user_id>/organisation/<uuid:organisation_id>/permissions", methods=["POST"])
app/user/rest.py:None
Routeset_permissions
user_blueprint.route("/<uuid:user_id>/service/<uuid:service_id>/permission", methods=["POST"])
app/user/rest.py:None
Routeshow_status
status.route("/", methods=["GET"])
app/status/healthcheck.py:None
Routetest__get_cost_threshold
pytest.mark.parametrize("postage", ["1ST", "2ND", "INTERNATIONAL"])
tests/app/notifications/test_notifications_letter_callbacks.py:None
Routetest_all_known_models
pytest.mark.parametrize( "model, response_type, context_keys", ((value, key, FIND_BY_UUID_EXTR
tests/app/platform_admin/test_rest.py:None
Routetest_create_a_new_template_for_a_service_adds_postage_for_letters_only
pytest.mark.parametrize( "template_type, expected_postage", [(SMS_TYPE, None), (EMAIL_TYPE, None), (LETTER
tests/app/template/test_rest.py:None
Routetest_create_fake_letter_callback_sends_letter_response
pytest.mark.parametrize( "billable_units, postage, response_postage, response_mailing_product", [
tests/app/celery/test_research_mode_tasks.py:None
Routetest_create_letter_notification_with_different_postage
pytest.mark.parametrize("postage", ["second", "first", "economy"])
tests/app/notifications/test_process_letter_notifications.py:None
Routetest_create_letter_template_with_various_postage_options
pytest.mark.parametrize( "postage", ["first", "second", "europe", "rest-of-world", "economy"], )
tests/app/dao/test_templates_dao.py:None
Routetest_create_notification_history_with_various_postage_values
pytest.mark.parametrize("postage", ["first", "second", "europe", "rest-of-world", "economy"])
tests/app/dao/test_notification_history_dao.py:None
Routetest_create_pdf_letter_validates_against_json_schema
pytest.mark.parametrize( "post_data, expected_errors", [ ( {}, [
tests/app/service/test_rest.py:None
Routetest_create_template_validates_against_json_schema
pytest.mark.parametrize( "post_data, expected_errors", [ ( {}, [
tests/app/template/test_rest.py:None
Routetest_deep_archive_notification_history_hour_starting_happy_path
pytest.mark.parametrize("delete_archived", (False, True))
tests/app/celery/test_nightly_tasks.py:None
Routetest_deep_archive_notification_history_hour_starting_upload_fails
pytest.mark.parametrize("delete_archived", (False, True))
tests/app/celery/test_nightly_tasks.py:None
Routetest_deep_archive_notification_history_up_to_limit
pytest.mark.parametrize("delete_archived", (False, True))
tests/app/celery/test_nightly_tasks.py:None
Routetest_format_create_print_job_json_formats_address_lines
pytest.mark.parametrize( "address, recipient, unstructured_address", [ (PostalAddress("The use
tests/app/clients/test_dvla.py:None
Routetest_format_mmg_datetime
pytest.mark.parametrize( "provider_date, expected_output", [ ("2017-01-21+11%3A56%3A11", datet
tests/app/notifications/test_receive_notification.py:None
Routetest_format_mmg_message
pytest.mark.parametrize( "message, expected_output", [ ("abc", "abc"), ("", ""),
tests/app/notifications/test_receive_notification.py:None
Routetest_generate_letter_pdf_filename_returns_correct_postage_for_filename
pytest.mark.parametrize( "postage,expected_postage", [("second", 2), ("first", 1), ("economy", "ECONOM
tests/app/letters/test_letter_utils.py:None
Routetest_get_notification_adds_delivery_estimate_for_letters
pytest.mark.parametrize( "created_at_month, postage, estimated_delivery", [ # no print during
tests/app/v2/notifications/test_get_notifications.py:None
Routetest_get_notifications_valid_json
pytest.mark.parametrize("input", [valid_get_json, valid_get_with_optionals_json])
tests/app/v2/notifications/test_notification_schemas.py:None
Routetest_get_rate_filters_letters_by_post_class
pytest.mark.parametrize( "letter_post_class,expected_rate", [ ("first", "0.61"), ("sec
tests/app/dao/test_fact_billing_dao.py:None
Routetest_get_template_by_id_returns_200
pytest.mark.parametrize( "tmp_type, expected_name, expected_subject,postage", [ (SMS_TYPE, "sm
tests/app/v2/template/test_get_template.py:None
Routetest_get_template_email_files_returns_all_files
pytest.mark.parametrize("get_pending", [True, False, None])
tests/app/template_email_files/test_rest.py:None
Routetest_get_template_response_schema_is_valid
pytest.mark.parametrize("response", [valid_json_get_response, valid_json_get_response_with_optionals])
tests/app/v2/template/test_template_schemas.py:None
Routetest_get_template_returns_letter_attachment
pytest.mark.parametrize( "endpoint,extra_args", [("template.get_template_by_id_and_service_id", {}), (
tests/app/template/test_rest.py:None
Routetest_invalid_get_all_templates_response_schema_is_invalid
pytest.mark.parametrize("response,error_messages", invalid_json_get_all_response)
tests/app/v2/templates/test_templates_schemas.py:None
Routetest_notification_personalisation_setter_always_sets_empty_dict
pytest.mark.parametrize("input_value", [None, {}])
tests/app/test_model.py:None
Routetest_persist_letter_notification_finds_correct_postage
pytest.mark.parametrize( "postage_argument, template_postage, expected_postage", [ ("second",
tests/app/notifications/test_process_notification.py:None
Routetest_persist_notification_for_international_letter
pytest.mark.parametrize("postage", ["europe", "rest-of-world"])
tests/app/notifications/test_process_notification.py:None
Routetest_post_email_schema_invalid_scheduled_for
pytest.mark.parametrize("schema", [post_email_request_schema, post_sms_request_schema])
tests/app/v2/notifications/test_notification_schemas.py:None
Routetest_post_email_schema_is_valid
pytest.mark.parametrize("input", [valid_post_email_json, valid_post_email_json_with_optionals])
tests/app/v2/notifications/test_notification_schemas.py:None
Routetest_post_letter_notification_throws_error_for_bad_address
pytest.mark.parametrize( "permissions, personalisation, expected_error", ( ( [LETT
tests/app/v2/notifications/test_post_letter_notifications.py:None
Routetest_post_notification_returns_401_and_well_formed_auth_error
pytest.mark.parametrize( "notification_type, key_send_to, send_to", [ ("sms", "phone_number",
tests/app/v2/notifications/test_post_notifications.py:None
Routetest_post_precompiled_letter_notification_returns_201
pytest.mark.parametrize( "notification_postage, expected_postage", [("second", "second"), ("first", "first
tests/app/v2/notifications/test_post_letter_notifications.py:None
Routetest_post_schema_valid_scheduled_for
pytest.mark.parametrize("schema", [post_email_request_schema, post_sms_request_schema])
tests/app/v2/notifications/test_notification_schemas.py:None
Routetest_post_sms_schema_is_valid
pytest.mark.parametrize("input", [valid_json, valid_json_with_optionals])
tests/app/v2/notifications/test_notification_schemas.py:None
Routetest_post_template_preview_against_invalid_args_is_invalid
pytest.mark.parametrize("args,error_messages", invalid_json_post_args)
tests/app/v2/template/test_template_schemas.py:None
Routetest_post_template_preview_response_schema_is_valid
pytest.mark.parametrize("response", [valid_json_post_response, valid_json_post_response_with_optionals])
tests/app/v2/template/test_template_schemas.py:None
Routetest_preview_letter_template_precompiled_for_png_shows_overlay_on_pages_with_content_outside_printable_area
pytest.mark.parametrize( "requested_page, message, expected_post_url", [ # page defaults to 1,
tests/app/template/test_rest.py:None
Routetest_process_letter_callback_validation_for_despatch_properties
pytest.mark.parametrize( "despatch_properties, expected_error_message", [ # invalid enum for p
tests/app/notifications/test_notifications_letter_callbacks.py:None
Routetest_process_sanitised_letter_sets_postage_international
pytest.mark.parametrize( "address, expected_postage, expected_international", [ ("Lady Lou, 12
tests/app/celery/test_letters_pdf_tasks.py:None
Routetest_process_sanitised_letter_with_valid_letter
pytest.mark.parametrize( "key_type, destination_bucket, expected_status, postage, destination_filename",
tests/app/celery/test_letters_pdf_tasks.py:None
Routetest_sanitise_personalisation_item
pytest.mark.parametrize( "value, expected_sanitised, expected_sanitised_plain_text, expected_sanitised_htm
tests/app/v2/notifications/test_post_notifications.py:None
Routetest_save_letter_saves_letter_to_database
pytest.mark.parametrize( "personalisation, expected_to, expected_normalised, client_reference", (
tests/app/celery/test_tasks.py:None
Routetest_save_letter_saves_letter_to_database_with_correct_postage
pytest.mark.parametrize( "last_line_of_address, postage, expected_postage, expected_international", [
tests/app/celery/test_tasks.py:None
Routetest_save_tasks_use_cached_service_and_template
pytest.mark.parametrize( "task_function, expected_task_call, recipient, template_args", ( (
tests/app/celery/test_tasks.py:None
Routetest_send_international_letter
pytest.mark.parametrize( "postage, despatch_method", (("europe", "INTERNATIONAL_EU"), ("rest-of-world", "I
tests/app/clients/test_dvla.py:None
Routetest_send_new_user_email_verification
pytest.mark.parametrize( "post_data, expected_url_starts_with", ( ( {},
tests/app/user/test_rest_verify.py:None
Routetest_send_notification_should_send_international_letters
pytest.mark.parametrize( "last_line_of_address, expected_postage, expected_international", [("France",
tests/app/service/send_notification/test_send_notification.py:None
Routetest_send_notification_to_queue
pytest.mark.parametrize( ("requested_queue, notification_type, key_type, expected_queue, expected_task"),
tests/app/notifications/test_process_notification.py:None
Routetest_set_default_free_allowance_for_service
pytest.mark.parametrize( "org_type, year, expected_default", [ ("central", 2021, 150000),
tests/app/dao/test_annual_billing_dao.py:None
Routetest_set_sms_prefixing_for_service
pytest.mark.parametrize( "posted_value, stored_value, returned_value", [ (True, True, True),
tests/app/service/test_rest.py:None
Routetest_update_template_language
pytest.mark.parametrize( "post_data", ( {}, {"letter_welsh_subject": "", "letter_welsh
tests/app/template/test_rest.py:None
Routetest_upload_letter_pdf_uses_postage_from_notification
pytest.mark.parametrize("postage", ["second", "first"])
tests/app/letters/test_letter_utils.py:None
Routetest_valid_get_all_templates_response_schema_is_valid
pytest.mark.parametrize("response", valid_json_get_all_response)
tests/app/v2/templates/test_templates_schemas.py:None
Routetest_valid_post_template_returns_200
pytest.mark.parametrize("subject,content,post_data,expected_subject,expected_content,expected_html", valid_pos
tests/app/v2/template/test_post_template.py:None
Routetest_validate_address
pytest.mark.parametrize( "key, address_line_3, expected_postage", [ ("address_line_3", "SW1 1A
tests/app/notifications/test_validators.py:None
Routeupdate_email_branding
email_branding_blueprint.route("/<uuid:email_branding_id>", methods=["POST"])
app/email_branding/rest.py:None
Routeupdate_guest_list
service_blueprint.route("/<uuid:service_id>/guest-list", methods=["PUT"])
app/service/rest.py:None
Routeupdate_invited_user
service_invite.route("/service/<service_id>/invite/<invited_user_id>", methods=["POST"])
app/service_invite/rest.py:None
Routeupdate_letter_branding
letter_branding_blueprint.route("/<uuid:letter_branding_id>", methods=["POST"])
app/letter_branding/letter_branding_rest.py:None
Routeupdate_org_invite_status
organisation_invite_blueprint.route( "/organisation/<uuid:organisation_id>/invite/<invited_org_user_id>",
app/organisation/invite_rest.py:None
Routeupdate_organisation
organisation_blueprint.route("/<uuid:organisation_id>", methods=["POST"])
app/organisation/rest.py:None
Routeupdate_organisation_email_branding_pool
organisation_blueprint.route("/<uuid:organisation_id>/email-branding-pool", methods=["POST"])
app/organisation/rest.py:None
Routeupdate_organisation_letter_branding_pool
organisation_blueprint.route("/<uuid:organisation_id>/letter-branding-pool", methods=["POST"])
app/organisation/rest.py:None
Routeupdate_password
user_blueprint.route("/<uuid:user_id>/update-password", methods=["POST"])
app/user/rest.py:None
Routeupdate_provider_details
provider_details.route("/<uuid:provider_details_id>", methods=["POST"])
app/provider_details/rest.py:None
Routeupdate_report_status_to_deleted
notify_celery.task(name="update-report-status-to-deleted")
app/celery/nightly_tasks.py:None
Routeupdate_service
service_blueprint.route("/<uuid:service_id>", methods=["POST"])
app/service/rest.py:None
Routeupdate_service_callback_api
service_callback_blueprint.route("/callback-api/<uuid:callback_api_id>", methods=["POST"])
app/service/callback_rest.py:None
Routeupdate_service_join_request_by_id
service_blueprint.route("/<uuid:service_id>/service-join-request/<uuid:request_id>", methods=["POST"])
app/service/rest.py:None
Routeupdate_service_letter_contact
service_blueprint.route("/<uuid:service_id>/letter-contact/<uuid:letter_contact_id>", methods=["POST"])
app/service/rest.py:None
Routeupdate_service_reply_to_email_address
service_blueprint.route("/<uuid:service_id>/email-reply-to/<uuid:reply_to_email_id>", methods=["POST"])
app/service/rest.py:None
← previousnext →201–300 of 315, ranked by callers