wg-api-sdk
Version:
An SDK that provides auto-generated fetch functions and types for interacting with WeGroup 's APIs, based on the OpenAPI specification file.
1,498 lines (1,497 loc) • 4.88 MB
TypeScript
import createClient, { Middleware as Middleware$1, ClientOptions } from 'openapi-fetch';
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
interface paths {
"/v1/api/weather/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Weather Info
* @description Get information of the weather by address
*/
get: operations["get_weather_info_v1_api_weather_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/address/cities": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Search Cities By Country
* @description Get the matching city with the query
*/
get: operations["search_cities_by_country_v1_api_address_cities_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/address/streets": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Seach Streets By City And Country
* @description Get the streets of the city
*/
get: operations["seach_streets_by_city_and_country_v1_api_address_streets_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/address/search": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Search Addresses By Country
* @description Search for an address
*/
get: operations["search_addresses_by_country_v1_api_address_search_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/address/info/premium": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Address Info
* @description Get information of the address
*/
get: operations["get_address_info_v1_api_address_info_premium_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/address/info/freemium": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Address Info Freemium
* @deprecated
* @description Get information of the address
*/
get: operations["get_address_info_freemium_v1_api_address_info_freemium_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get All Advisory Reports
* @description Get all reports overview.
*/
get: operations["get_all_advisory_reports_v1_api_advisory_reports_get"];
put?: never;
/**
* Create Advisory Report
* @description Create a new report from a party.
* When doing this, a 'NEW' report will be created and personalization is requried to complete the report.
*
* A report is always created when a conversation is completed (mark_flow_session_as_completed_by_session_id).
* If you want to create a report for an unfinished conversation, you will need to create a new report and link conversations.
*
* Best is to include a recommendation_id and a conversation if available.
*/
post: operations["create_advisory_report_v1_api_advisory_reports_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Advisory Report By Id
* @description Get a report by id, a report and report revision are in essence the same, made clear by following diagram
*
* ```
* 1. NEW report (ID=1) CREATED
* 2. REPORT CLOSED, create new revision (ID=2)
* 2. REPORT REJECTED, create new revision (ID=3)
*
* The following 'revision' ids are made:
*
* 1 -> 2 -> 3
*
* In database these are linked to a general ID so we know that they are linked revisions.
* ```
*
* > NOTE: Very important is the conversation and the recommendation_id, it can be that a report does not have a
* conversation linked and thus not a recommendation. Therefor the prefilled advice can not be rendered and you should
* start with a bare one.
*/
get: operations["get_advisory_report_by_id_v1_api_advisory_reports__report_id__get"];
put?: never;
post?: never;
/**
* Delete Advisory Report Revision
* @description Delete an advisory report revision by id
*/
delete: operations["delete_advisory_report_revision_v1_api_advisory_reports__report_id__delete"];
options?: never;
head?: never;
/**
* Update Advisory Report
* @description Update a report's metadata.
*/
patch: operations["update_advisory_report_v1_api_advisory_reports__report_id__patch"];
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/events": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Events By Advisory Report Id
* @description This route can be used to built a timeline.
* This timeline represents all events happend to a report and its revisions.
*
* The report id can be of any revision that are linked together.
* Meaning that if you use a different report id from another revision you will get the same result.
*/
get: operations["get_events_by_advisory_report_id_v1_api_advisory_reports__report_id__events_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/email-inquiries": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Send Advisory Report As Mail
* @description Send an advisory report via mail to the customer
* Can include multiple emails to send the report to.
*
* The reason why this is called /email-inquiries is because you actually ask information via email, you ask the customer to verfify and accept the doc.
*/
post: operations["send_advisory_report_as_mail_v1_api_advisory_reports__report_id__email_inquiries_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/docx": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Generate Docx Document Of Advisory Report By Id
* @description Generates a docx representation of an advisory report revision and returns a public link
* where the docx document can be retrieved from.
*
* The document is generated on each request and never persisted.
*/
post: operations["generate_docx_document_of_advisory_report_by_id_v1_api_advisory_reports__report_id__docx_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/pdf": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Pdf Of Advisory Report By Id
* @deprecated
* @description DEPRECATED Use POST /v1/api/advisory_reports
*
* Will return a link to an object store where you can find the pdf.
* This will be application/pdf content type.
*/
get: operations["get_pdf_of_advisory_report_by_id_v1_api_advisory_reports__report_id__pdf_get"];
put?: never;
/**
* Generate Pdf Of Advisory Report By Id
* @description Generates a PDF representation of an advisory report revision and returns a public link
* where the PDF document can be retrieved from.
*
* The document is generated on each request and never persisted.
*/
post: operations["generate_pdf_of_advisory_report_by_id_v1_api_advisory_reports__report_id__pdf_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-report-front-page-pdf": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Generate Standalone Front Page Pdf Of Advisory Report As Example
* @description Generate a front page PDF for advisory report as example, to showcase how it will look.
*/
post: operations["generate_standalone_front_page_pdf_of_advisory_report_as_example_v1_api_advisory_report_front_page_pdf_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/acceptances": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Accept Or Reject An Advisory Report
* @description Accept or reject a report revision.
*/
post: operations["accept_or_reject_an_advisory_report_v1_api_advisory_reports__report_id__acceptances_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/conversations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Link Conversation To Advisory Report
* @description Link an existing conversation (and recommendation if exists) to a report.
*/
post: operations["link_conversation_to_advisory_report_v1_api_advisory_reports__report_id__conversations_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/api/advisory-reports/{report_id}/revisions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Advisory Report Revision V2
* @description Create a new advisory report revision by either creating a blank report or a copy from the previous report.
*/
post: operations["create_advisory_report_revision_v2_v2_api_advisory_reports__report_id__revisions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/revisions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Advisory Report Revision
* @description A new revision can be generated from a report, meaning a new advisory report will be set as the latest revision.
*/
post: operations["create_advisory_report_revision_v1_api_advisory_reports__report_id__revisions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/api/advisory-reports/{report_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Advisory Report
* @description Delete base advisory report by report id (not report revision id).
*/
delete: operations["delete_advisory_report_v2_api_advisory_reports__report_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/clauses": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Put Clauses For Report
* @description When a report is created, the report is rather 'generic' meaning that for the same customer the same report can be generated no matter which broker.
* A broker therefor should have the possibility to customize the report with personal adivse, clauses and offers that the broker thinks is best for the customer.
*
* This method is a `PUT` which means it can be used as create and update call, but the update is a complete overwrite NOT an incremental update.
*/
put: operations["put_clauses_for_report_v1_api_advisory_reports__report_id__clauses_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/personalise-advices": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Generate Personalization Advice For Advisory Report
* @description Generate personalized advice via AI
*/
post: operations["generate_personalization_advice_for_advisory_report_v1_api_advisory_reports__report_id__personalise_advices_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/settings/steps": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Step Settings By Advisory Report Id
* @description Retrieve the settings of an advisory-report revision
*/
get: operations["get_step_settings_by_advisory_report_id_v1_api_advisory_reports__report_id__settings_steps_get"];
/**
* Create Advisory Report Step Settings
* @description Create or update the settings of an advisory-report revision
*/
put: operations["create_advisory_report_step_settings_v1_api_advisory_reports__report_id__settings_steps_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/risk-domains": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Risk Domain For Advisory Report By Id
* @description Create risk domain for an advisory-report revision
*/
post: operations["create_risk_domain_for_advisory_report_by_id_v1_api_advisory_reports__report_id__risk_domains_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/risk-domains/{risk_domain_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Risk Domain For Advisory Report By Id
* @description Deletes a risk-domain for an advisory-report revision. Will also deleted all of its attached advices and actions.
*/
delete: operations["delete_risk_domain_for_advisory_report_by_id_v1_api_advisory_reports__report_id__risk_domains__risk_domain_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/risk-domains/{risk_domain_id}/advice": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Risk Domain Advice For Advisory Report By Id
* @description Create advice for a risk domain within an advisory-report revision
*/
post: operations["create_risk_domain_advice_for_advisory_report_by_id_v1_api_advisory_reports__report_id__risk_domains__risk_domain_id__advice_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/risk-domains/{risk_domain_id}/advice/{advice_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Risk Domain Advice For Advisory Report By Id
* @description Delete advice for a risk domain within an advisory-report revision
*/
delete: operations["delete_risk_domain_advice_for_advisory_report_by_id_v1_api_advisory_reports__report_id__risk_domains__risk_domain_id__advice__advice_id__delete"];
options?: never;
head?: never;
/**
* Update Risk Domain Advice For Advisory Report By Id
* @description Update advice for a risk domain within an advisory-report revision
*/
patch: operations["update_risk_domain_advice_for_advisory_report_by_id_v1_api_advisory_reports__report_id__risk_domains__risk_domain_id__advice__advice_id__patch"];
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/risk-domains/{risk_domain_id}/advice/{advice_id}/actions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Create Risk Domain Action From Advice For Advisory Report By Id
* @description Create action from an advice for a risk domain within an advisory-report revision
*/
put: operations["create_risk_domain_action_from_advice_for_advisory_report_by_id_v1_api_advisory_reports__report_id__risk_domains__risk_domain_id__advice__advice_id__actions_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/risk-domains/{risk_domain_id}/actions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Risk Domain Action For Advisory Report By Id
* @description Create action for a risk domain within an advisory-report revision
*/
post: operations["create_risk_domain_action_for_advisory_report_by_id_v1_api_advisory_reports__report_id__risk_domains__risk_domain_id__actions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/risk-domains/{risk_domain_id}/actions/{action_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Risk Domain Action For Advisory Report By Id
* @description Delete action for a risk domain within an advisory-report revision
*/
delete: operations["delete_risk_domain_action_for_advisory_report_by_id_v1_api_advisory_reports__report_id__risk_domains__risk_domain_id__actions__action_id__delete"];
options?: never;
head?: never;
/**
* Update Risk Domain Action For Advisory Report By Id
* @description Update action for a risk domain within an advisory-report revision
*/
patch: operations["update_risk_domain_action_for_advisory_report_by_id_v1_api_advisory_reports__report_id__risk_domains__risk_domain_id__actions__action_id__patch"];
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/insurance-policies": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Create Or Replace Insurance Policy For Advisory Report By Id
* @description Creates or replaces insurance policy for an advisory report revision.
* Current insurance can be created using `active=True` in the request body while offers are created using `active=False`.
*
* Coverages and documents of an insurance policy are always either created or completed replaced with content from request payload.
*/
put: operations["create_or_replace_insurance_policy_for_advisory_report_by_id_v1_api_advisory_reports__report_id__insurance_policies_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/insurance-policies/{insurance_policy_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Insurance Policy For Advisory Report By Id
* @description Delete insurance policy for an advisory-report revision. Also deletes all coverages and documents.
*/
delete: operations["delete_insurance_policy_for_advisory_report_by_id_v1_api_advisory_reports__report_id__insurance_policies__insurance_policy_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/insurance-policies/order": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Order Insurance Polcies Of Advisory Report
* @description Order offers and current insurances
*/
put: operations["order_insurance_polcies_of_advisory_report_v1_api_advisory_reports__report_id__insurance_policies_order_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id}/policy-packages": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Create Or Replace Policy Packages For Advisory Report By Id
* @description Adds or replaces an insurance policy package to an advisory-report
*/
put: operations["create_or_replace_policy_packages_for_advisory_report_by_id_v1_api_advisory_reports__report_id__policy_packages_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/advisory-reports/{report_id_1}/diff/{report_id_2}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Advisory Report Revision Diff
* @description Get diff between advice of two reports revisions
*/
get: operations["get_advisory_report_revision_diff_v1_api_advisory_reports__report_id_1__diff__report_id_2__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/affiliations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get All Available Affiliations
* @description Get all affiliations
*/
get: operations["get_all_available_affiliations_v1_api_affiliations_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaflows/labels": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Anva Labels */
get: operations["get_anva_labels_v1_api_anvaflows_labels_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaflows/supported-insurances": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Supported Anvaflow Insurances
* @description Get a list of anvaflow supported insurances for current distribution.
*/
get: operations["get_supported_anvaflow_insurances_v1_api_anvaflows_supported_insurances_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaflows/supported-tags": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Supported Anvaflow Tags
* @description Get a list of anvaflow supported tags for current distribution.
*/
get: operations["get_supported_anvaflow_tags_v1_api_anvaflows_supported_tags_get"];
/** Create Anvaflow Tags */
put: operations["create_anvaflow_tags_v1_api_anvaflows_supported_tags_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaflows/supported-coverages": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Supported Anvaflow Coverages
* @description Get a list of anvaflow supported coverages by insurances for current distribution.
*/
get: operations["get_supported_anvaflow_coverages_v1_api_anvaflows_supported_coverages_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaflows/supported-adn-coverages": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Supported Anvaflow Coverages Grouped By Adn
* @description Get a list of anvaflow supported coverages grouped by ADN code filtered on insurances for current distribution.
*/
get: operations["get_supported_anvaflow_coverages_grouped_by_adn_v1_api_anvaflows_supported_adn_coverages_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaflows/supported-insurance-companies": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Supported Anvaflow Insurance Companies
* @description Get a list of anvaflow supported insurance companies by insurances and coverages for current distribution.
*/
get: operations["get_supported_anvaflow_insurance_companies_v1_api_anvaflows_supported_insurance_companies_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaflows/mutation-reasons": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Anva Mutation Reasons */
get: operations["get_anva_mutation_reasons_v1_api_anvaflows_mutation_reasons_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaflows/{session_id}/calculate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Calculate Anvaquotes By Session Id */
post: operations["calculate_anvaquotes_by_session_id_v1_api_anvaflows__session_id__calculate_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/api/anvaflows/{session_id}/calculate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Enqueue Calculation Anvaquotes By Session Id */
post: operations["enqueue_calculation_anvaquotes_by_session_id_v2_api_anvaflows__session_id__calculate_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaflows/{session_id}/anvaproducts/{anva_product_id}/calculate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Recalculate One Anvaquote By Anva Product Id Session Id */
post: operations["recalculate_one_anvaquote_by_anva_product_id_session_id_v1_api_anvaflows__session_id__anvaproducts__anva_product_id__calculate_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaflows/{session_id}/send-offer-to-anva": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Send Offer To Anva By Session Id */
post: operations["send_offer_to_anva_by_session_id_v1_api_anvaflows__session_id__send_offer_to_anva_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/api/anvaflows/{session_id}/send-offer-to-anva": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Enqueue Send Offer To Anva By Session Id */
post: operations["enqueue_send_offer_to_anva_by_session_id_v2_api_anvaflows__session_id__send_offer_to_anva_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaflows/{session_id}/send-offer-mail": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Send Offer Mail By Session Id */
post: operations["send_offer_mail_by_session_id_v1_api_anvaflows__session_id__send_offer_mail_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaflows/{session_id}/send-custom-quotes-to-anva": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Enqueue Send Custom Quotes To Anva By Session Id */
post: operations["enqueue_send_custom_quotes_to_anva_by_session_id_v1_api_anvaflows__session_id__send_custom_quotes_to_anva_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaflows/{session_id}/recalculate-simulation": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Recalculate Simulation By Session Id */
post: operations["recalculate_simulation_by_session_id_v1_api_anvaflows__session_id__recalculate_simulation_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaflows/{session_id}/collection-methods": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Anva Collection Methods */
get: operations["get_anva_collection_methods_v1_api_anvaflows__session_id__collection_methods_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaflows/closing-questions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Anva Closing Questions */
get: operations["get_anva_closing_questions_v1_api_anvaflows_closing_questions_get"];
/** Upsert Anva Closing Questions */
put: operations["upsert_anva_closing_questions_v1_api_anvaflows_closing_questions_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaflows/closing-questions/{closing_question_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Delete Anva Closing Questions */
delete: operations["delete_anva_closing_questions_v1_api_anvaflows_closing_questions__closing_question_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaflows/{session_id}/anva-party": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Create Anva Party */
post: operations["create_anva_party_v1_api_anvaflows__session_id__anva_party_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaproducts": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Anvaproducts
* @description Get the product catalogue for current distribution.
*/
get: operations["get_anvaproducts_v1_api_anvaproducts_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaproducts/import": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Import Anvaproduct */
post: operations["import_anvaproduct_v1_api_anvaproducts_import_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaproducts/{anva_product_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Anvaproduct By Id */
get: operations["get_anvaproduct_by_id_v1_api_anvaproducts__anva_product_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/** Patch Anvaproduct By Id */
patch: operations["patch_anvaproduct_by_id_v1_api_anvaproducts__anva_product_id__patch"];
trace?: never;
};
"/v1/api/anvaproducts/{anva_product_id}/coverages/{coverage_code}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/** Patch Anvaproduct Coverage By Id */
patch: operations["patch_anvaproduct_coverage_by_id_v1_api_anvaproducts__anva_product_id__coverages__coverage_code__patch"];
trace?: never;
};
"/v1/api/anvaproducts/{anva_product_id}/questionnaires": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieve Anvaflows Questionnaires */
get: operations["retrieve_anvaflows_questionnaires_v1_api_anvaproducts__anva_product_id__questionnaires_get"];
/** Update Anvaflows Questionnaire */
put: operations["update_anvaflows_questionnaire_v1_api_anvaproducts__anva_product_id__questionnaires_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaproducts/{anva_product_id}/questionnaires/validate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Validate Anvaflows Questionnaire */
post: operations["validate_anvaflows_questionnaire_v1_api_anvaproducts__anva_product_id__questionnaires_validate_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anvaproducts/questionnaires/update-all-questions-by-anvalabels": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Update Question For All Questionnaires By Anva Labels */
post: operations["update_question_for_all_questionnaires_by_anva_labels_v1_api_anvaproducts_questionnaires_update_all_questions_by_anvalabels_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/brokers/me": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Current Broker Of The User
* @description Get active broker information linked to the authenticated user account.
*/
get: operations["get_current_broker_of_the_user_v1_api_brokers_me_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/brokers/{broker_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get The Broker By Id
* @description Get broker information by id
*/
get: operations["get_the_broker_by_id_v1_api_brokers__broker_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Broker By Broker
* @description Update broker by broker
*/
patch: operations["update_broker_by_broker_v1_api_brokers__broker_id__patch"];
trace?: never;
};
"/v1/api/brokers/{broker_id}/integrations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Broker Integrations
* @description Get broker integrations
*/
get: operations["get_broker_integrations_v1_api_brokers__broker_id__integrations_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Broker Integrations
* @description Update broker integrations
*/
patch: operations["update_broker_integrations_v1_api_brokers__broker_id__integrations_patch"];
trace?: never;
};
"/v1/api/anva-relation-managers/{anva_relation_manager_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Broker By Anva Relation Manger Id */
get: operations["get_broker_by_anva_relation_manger_id_v1_api_anva_relation_managers__anva_relation_manager_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/anva-producers/{anva_producer_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Broker By Anva Producer Id */
get: operations["get_broker_by_anva_producer_id_v1_api_anva_producers__anva_producer_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/brokers/{broker_id}/checklists/onboarding": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Onboarding Checklist By Broker
* @description Get info on the progress of a broker for the onboarding checklist.
*
* Data should always be sorted by the `index` attribute in ascending order
*/
get: operations["get_onboarding_checklist_by_broker_v1_api_brokers__broker_id__checklists_onboarding_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/campaigns/{campaign_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Campaign By Id
* @description This will return campaign information by id, this id can be a UUID or a short id (10 characters) or dns_prefix
*/
get: operations["get_campaign_by_id_v1_api_campaigns__campaign_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Campaign
* @description Update a campaign
*/
patch: operations["update_campaign_v1_api_campaigns__campaign_id__patch"];
trace?: never;
};
"/v1/api/campaigns": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get All Campaigns By Distribution
* @description Get all campaigns of a distribution.
*/
get: operations["get_all_campaigns_by_distribution_v1_api_campaigns_get"];
put?: never;
/**
* Create Campaign
* @description Create a campaign
*/
post: operations["create_campaign_v1_api_campaigns_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/campaigns/{campaign_id}/metrics": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Metrics By Campaign
* @description Retrieve campaign metrics
*/
get: operations["get_metrics_by_campaign_v1_api_campaigns__campaign_id__metrics_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/campaigns/{campaign_id}/targets": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Targets By Campaign
* @description Update the target of a known-targets (email) campaign.
*/
patch: operations["update_targets_by_campaign_v1_api_campaigns__campaign_id__targets_patch"];
trace?: never;
};
"/v1/api/campaign-templates": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get All Campaign Templates
* @description Get all available campaign templates
*/
get: operations["get_all_campaign_templates_v1_api_campaign_templates_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/campaigns/example-mails": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Send Example Campaign Target Mail
* @description Send an example campaign target mail to a collection of recipients.
*/
post: operations["send_example_campaign_target_mail_v1_api_campaigns_example_mails_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/api/distributions/campaign-settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Campaign Settings By Distribution
* @description Get the campaign settings of a distribution.
*/
get: operations["get_campaign_settings_by_distribution_v1_api_distributions_campaign_settings_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/a