@outseta/api-client 0.3.30 → 0.3.32
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +302 -288
- package/package.json +1 -1
- package/src/generated/crm/crm.ts +41 -0
- package/src/generated/models/authMagicLinkTokenParams.ts +8 -0
- package/src/generated/models/index.ts +12 -0
- package/src/generated/models/personRequestMagicLinkBody.ts +7 -0
- package/src/generated/models/qcountConfigSettingType.ts +2 -1
- package/src/generated/models/sendTemplateEmailRequest.ts +24 -0
- package/src/generated/models/templateEmailInstance.ts +5 -0
- package/src/generated/models/templateEmailInstanceAllOf.ts +47 -0
- package/src/generated/models/templateEmailInstanceAllOfRecipient.ts +7 -0
- package/src/generated/models/templateEmailInstanceAllOfTemplate.ts +7 -0
- package/src/generated/models/templateGetAllTemplateEmails200.ts +8 -0
- package/src/generated/models/templateGetAllTemplateEmailsParams.ts +14 -0
- package/src/generated/models/templateGetTemplateEmails200.ts +8 -0
- package/src/generated/models/templateGetTemplateEmailsParams.ts +14 -0
- package/src/generated/models/templateSendTemplateEmailBody.ts +7 -0
- package/src/generated/public/public.ts +71 -0
- package/src/generated/template/template.ts +188 -0
package/dist/index.js
CHANGED
|
@@ -895,6 +895,17 @@ var personForgotPassword = async (personForgotPasswordBody, options) => {
|
|
|
895
895
|
body: JSON.stringify(personForgotPasswordBody)
|
|
896
896
|
});
|
|
897
897
|
};
|
|
898
|
+
var getPersonRequestMagicLinkUrl = () => {
|
|
899
|
+
return `/api/v1/crm/people/requestMagicLink`;
|
|
900
|
+
};
|
|
901
|
+
var personRequestMagicLink = async (personRequestMagicLinkBody, options) => {
|
|
902
|
+
return customFetch(getPersonRequestMagicLinkUrl(), {
|
|
903
|
+
...options,
|
|
904
|
+
method: "POST",
|
|
905
|
+
headers: { "Content-Type": "application/json", ...options?.headers },
|
|
906
|
+
body: JSON.stringify(personRequestMagicLinkBody)
|
|
907
|
+
});
|
|
908
|
+
};
|
|
898
909
|
// src/generated/email/email.ts
|
|
899
910
|
var getDripCampaignGetAllDripCampaignsUrl = (params) => {
|
|
900
911
|
const normalizedParams = new URLSearchParams;
|
|
@@ -1801,6 +1812,7 @@ var QcountConfigSettingType = {
|
|
|
1801
1812
|
Billing_RestrictSubscriptionActions: 131,
|
|
1802
1813
|
TwoFactorAuthenticationEnabled: 140,
|
|
1803
1814
|
ForceTwoFactorAuthentication: 142,
|
|
1815
|
+
MagicLinkLoginEnabled: 143,
|
|
1804
1816
|
Stripe_TaxEnabled: 190,
|
|
1805
1817
|
Stripe_TaxIdTypes: 192,
|
|
1806
1818
|
Stripe_ApplePayMerchantIdDomainAssociation: 193,
|
|
@@ -1915,293 +1927,295 @@ var TeamRole = {
|
|
|
1915
1927
|
Operator: 3
|
|
1916
1928
|
};
|
|
1917
1929
|
export {
|
|
1918
|
-
|
|
1919
|
-
usageAddUsage,
|
|
1920
|
-
transactionsGetAllTransactionsByAccountId,
|
|
1921
|
-
transactionsAddPaymentTransaction,
|
|
1922
|
-
subscriptionSetSubscriptionUpgradeRequired,
|
|
1923
|
-
subscriptionGetSubscription,
|
|
1924
|
-
subscriptionGetAllSubscriptions,
|
|
1925
|
-
subscriptionFirstTimeSubscriptionPreview,
|
|
1926
|
-
subscriptionFirstTimeSubscription,
|
|
1927
|
-
subscriptionExpireDiscountCouponSubscription,
|
|
1928
|
-
subscriptionDeleteSubscription,
|
|
1929
|
-
subscriptionChangeSubscriptionPreview,
|
|
1930
|
-
subscriptionChangeSubscription,
|
|
1931
|
-
subscriptionAddOnSetAddOnUpgradeRequired,
|
|
1932
|
-
subscriptionAddOnGetSubscriptionAddOn,
|
|
1933
|
-
subscriptionAddOnGetAllSubscriptionsAddOns,
|
|
1934
|
-
subscriptionAddOnExpireSubscriptionAddOn,
|
|
1935
|
-
subscriptionAddOnEndSubscriptionAddOn,
|
|
1936
|
-
subscriptionAddOnAddSubscriptionAddOnPreview,
|
|
1937
|
-
subscriptionAddOnAddSubscriptionAddOn,
|
|
1938
|
-
subscriptionAddDiscountToSubscription,
|
|
1939
|
-
registrationRegisterAccount,
|
|
1940
|
-
planUpdatePlan,
|
|
1941
|
-
planGetPlan,
|
|
1942
|
-
planGetAllPlans,
|
|
1943
|
-
planFamilyUpdatePlanFamily,
|
|
1944
|
-
planFamilyGetPlanFamily,
|
|
1945
|
-
planFamilyGetAllPlanFamilies,
|
|
1946
|
-
planFamilyDeletePlanFamily,
|
|
1947
|
-
planFamilyAddPlanFamily,
|
|
1948
|
-
planDeletePlan,
|
|
1949
|
-
planAddPlan,
|
|
1950
|
-
personUpdatePerson,
|
|
1951
|
-
personSetTemporaryPassword,
|
|
1952
|
-
personRegenerateTwoFactorRecoveryCodes,
|
|
1953
|
-
personGetPerson,
|
|
1954
|
-
personGetAllPeople,
|
|
1955
|
-
personForgotPassword,
|
|
1956
|
-
personDeletePerson,
|
|
1957
|
-
personAddPerson,
|
|
1958
|
-
paymentInformationSavePaymentInformation,
|
|
1959
|
-
invoiceUpdateInvoice,
|
|
1960
|
-
invoiceSendInvoicePaidEmail,
|
|
1961
|
-
invoiceSendInvoiceEmail,
|
|
1962
|
-
invoiceGetInvoiceAsPdf,
|
|
1963
|
-
invoiceGetInvoice,
|
|
1964
|
-
invoiceGetAllInvoices,
|
|
1965
|
-
invoiceDeleteInvoice,
|
|
1966
|
-
invoiceAddInvoice,
|
|
1967
|
-
getUsageAddUsageUrl,
|
|
1968
|
-
getTransactionsGetAllTransactionsByAccountIdUrl,
|
|
1969
|
-
getTransactionsAddPaymentTransactionUrl,
|
|
1970
|
-
getSubscriptionSetSubscriptionUpgradeRequiredUrl,
|
|
1971
|
-
getSubscriptionGetSubscriptionUrl,
|
|
1972
|
-
getSubscriptionGetAllSubscriptionsUrl,
|
|
1973
|
-
getSubscriptionFirstTimeSubscriptionUrl,
|
|
1974
|
-
getSubscriptionFirstTimeSubscriptionPreviewUrl,
|
|
1975
|
-
getSubscriptionExpireDiscountCouponSubscriptionUrl,
|
|
1976
|
-
getSubscriptionDeleteSubscriptionUrl,
|
|
1977
|
-
getSubscriptionChangeSubscriptionUrl,
|
|
1978
|
-
getSubscriptionChangeSubscriptionPreviewUrl,
|
|
1979
|
-
getSubscriptionAddOnSetAddOnUpgradeRequiredUrl,
|
|
1980
|
-
getSubscriptionAddOnGetSubscriptionAddOnUrl,
|
|
1981
|
-
getSubscriptionAddOnGetAllSubscriptionsAddOnsUrl,
|
|
1982
|
-
getSubscriptionAddOnExpireSubscriptionAddOnUrl,
|
|
1983
|
-
getSubscriptionAddOnEndSubscriptionAddOnUrl,
|
|
1984
|
-
getSubscriptionAddOnAddSubscriptionAddOnUrl,
|
|
1985
|
-
getSubscriptionAddOnAddSubscriptionAddOnPreviewUrl,
|
|
1986
|
-
getSubscriptionAddDiscountToSubscriptionUrl,
|
|
1987
|
-
getRegistrationRegisterAccountUrl,
|
|
1988
|
-
getPlanUpdatePlanUrl,
|
|
1989
|
-
getPlanGetPlanUrl,
|
|
1990
|
-
getPlanGetAllPlansUrl,
|
|
1991
|
-
getPlanFamilyUpdatePlanFamilyUrl,
|
|
1992
|
-
getPlanFamilyGetPlanFamilyUrl,
|
|
1993
|
-
getPlanFamilyGetAllPlanFamiliesUrl,
|
|
1994
|
-
getPlanFamilyDeletePlanFamilyUrl,
|
|
1995
|
-
getPlanFamilyAddPlanFamilyUrl,
|
|
1996
|
-
getPlanDeletePlanUrl,
|
|
1997
|
-
getPlanAddPlanUrl,
|
|
1998
|
-
getPersonUpdatePersonUrl,
|
|
1999
|
-
getPersonSetTemporaryPasswordUrl,
|
|
2000
|
-
getPersonRegenerateTwoFactorRecoveryCodesUrl,
|
|
2001
|
-
getPersonGetPersonUrl,
|
|
2002
|
-
getPersonGetAllPeopleUrl,
|
|
2003
|
-
getPersonForgotPasswordUrl,
|
|
2004
|
-
getPersonDeletePersonUrl,
|
|
2005
|
-
getPersonAddPersonUrl,
|
|
2006
|
-
getPaymentInformationSavePaymentInformationUrl,
|
|
2007
|
-
getInvoiceUpdateInvoiceUrl,
|
|
2008
|
-
getInvoiceSendInvoicePaidEmailUrl,
|
|
2009
|
-
getInvoiceSendInvoiceEmailUrl,
|
|
2010
|
-
getInvoiceGetInvoiceUrl,
|
|
2011
|
-
getInvoiceGetInvoiceAsPdfUrl,
|
|
2012
|
-
getInvoiceGetAllInvoicesUrl,
|
|
2013
|
-
getInvoiceDeleteInvoiceUrl,
|
|
2014
|
-
getInvoiceAddInvoiceUrl,
|
|
2015
|
-
getEmailListUpdateEmailListUrl,
|
|
2016
|
-
getEmailListGetEmailListUrl,
|
|
2017
|
-
getEmailListGetAllSubscriptionsUrl,
|
|
2018
|
-
getEmailListGetAllEmailListsUrl,
|
|
2019
|
-
getEmailListDeleteSubscriptionUrl,
|
|
2020
|
-
getEmailListDeleteEmailListUrl,
|
|
2021
|
-
getEmailListAddSubscriptionUrl,
|
|
2022
|
-
getEmailListAddEmailListUrl,
|
|
2023
|
-
getDripCampaignUpdateDripCampaignUrl,
|
|
2024
|
-
getDripCampaignUpdateDripCampaignMessageUrl,
|
|
2025
|
-
getDripCampaignSendTestCampaignEmailUrl,
|
|
2026
|
-
getDripCampaignGetDripCampaignUrl,
|
|
2027
|
-
getDripCampaignGetDripCampaignMessageUrl,
|
|
2028
|
-
getDripCampaignGetAllDripCampaignsUrl,
|
|
2029
|
-
getDripCampaignDeleteDripCampaignUrl,
|
|
2030
|
-
getDripCampaignDeleteDripCampaignMessageUrl,
|
|
2031
|
-
getDripCampaignAddDripCampaignUrl,
|
|
2032
|
-
getDripCampaignAddDripCampaignMessageUrl,
|
|
2033
|
-
getDiscountCouponUpdateDiscountCouponUrl,
|
|
2034
|
-
getDiscountCouponGetDiscountCouponUrl,
|
|
2035
|
-
getDiscountCouponGetDiscountCouponRedemptionsUrl,
|
|
2036
|
-
getDiscountCouponGetDiscountCouponByCodeUrl,
|
|
2037
|
-
getDiscountCouponGetAllDiscountCouponsUrl,
|
|
2038
|
-
getDiscountCouponDeleteDiscountCouponUrl,
|
|
2039
|
-
getDiscountCouponAddDiscountCouponUrl,
|
|
2040
|
-
getDealUpdateDealUrl,
|
|
2041
|
-
getDealGetDealUrl,
|
|
2042
|
-
getDealGetAllDealsUrl,
|
|
2043
|
-
getDealDeleteDealUrl,
|
|
2044
|
-
getDealAddDealUrl,
|
|
2045
|
-
getCategoryGetAllCategoriesUrl,
|
|
2046
|
-
getCaseGetCaseUrl,
|
|
2047
|
-
getCaseGetAllCasesUrl,
|
|
2048
|
-
getCaseAddReplyUrl,
|
|
2049
|
-
getCaseAddClientResponseUrl,
|
|
2050
|
-
getCaseAddCaseUrl,
|
|
2051
|
-
getCampaignUpdateBroadcastEmailUrl,
|
|
2052
|
-
getCampaignUnscheduleBroadcastEmailUrl,
|
|
2053
|
-
getCampaignSendTestCampaignEmailUrl,
|
|
2054
|
-
getCampaignGetBroadcastEmailUrl,
|
|
2055
|
-
getCampaignGetAllBroadcastEmailsUrl,
|
|
2056
|
-
getCampaignDeleteBroadcastCampaignUrl,
|
|
2057
|
-
getCampaignArchiveBroadcastCampaignUrl,
|
|
2058
|
-
getCampaignAddBroadcastEmailUrl,
|
|
2059
|
-
getArticleGetArticleUrl,
|
|
2060
|
-
getArticleGetAllArticlesUrl,
|
|
2061
|
-
getArticleAddArticleUrl,
|
|
2062
|
-
getActivityGetAllUrl,
|
|
2063
|
-
getActivityAddCustomActivityUrl,
|
|
2064
|
-
getAccountUpdateMembershipUrl,
|
|
2065
|
-
getAccountUpdateAccountUrl,
|
|
2066
|
-
getAccountSendConfirmationEmailUrl,
|
|
2067
|
-
getAccountRemoveCancellationUrl,
|
|
2068
|
-
getAccountGetAllAccountsUrl,
|
|
2069
|
-
getAccountGetAccountUrl,
|
|
2070
|
-
getAccountExtendTrialUrl,
|
|
2071
|
-
getAccountDeleteMembershipUrl,
|
|
2072
|
-
getAccountDeleteAccountUrl,
|
|
2073
|
-
getAccountCancelAccountUrl,
|
|
2074
|
-
getAccountAddPersonToAccountUrl,
|
|
2075
|
-
getAccountAddAccountUrl,
|
|
2076
|
-
emailListUpdateEmailList,
|
|
2077
|
-
emailListGetEmailList,
|
|
2078
|
-
emailListGetAllSubscriptions,
|
|
2079
|
-
emailListGetAllEmailLists,
|
|
2080
|
-
emailListDeleteSubscription,
|
|
2081
|
-
emailListDeleteEmailList,
|
|
2082
|
-
emailListAddSubscription,
|
|
2083
|
-
emailListAddEmailList,
|
|
2084
|
-
dripCampaignUpdateDripCampaignMessage,
|
|
2085
|
-
dripCampaignUpdateDripCampaign,
|
|
2086
|
-
dripCampaignSendTestCampaignEmail,
|
|
2087
|
-
dripCampaignGetDripCampaignMessage,
|
|
2088
|
-
dripCampaignGetDripCampaign,
|
|
2089
|
-
dripCampaignGetAllDripCampaigns,
|
|
2090
|
-
dripCampaignDeleteDripCampaignMessage,
|
|
2091
|
-
dripCampaignDeleteDripCampaign,
|
|
2092
|
-
dripCampaignAddDripCampaignMessage,
|
|
2093
|
-
dripCampaignAddDripCampaign,
|
|
2094
|
-
discountCouponUpdateDiscountCoupon,
|
|
2095
|
-
discountCouponGetDiscountCouponRedemptions,
|
|
2096
|
-
discountCouponGetDiscountCouponByCode,
|
|
2097
|
-
discountCouponGetDiscountCoupon,
|
|
2098
|
-
discountCouponGetAllDiscountCoupons,
|
|
2099
|
-
discountCouponDeleteDiscountCoupon,
|
|
2100
|
-
discountCouponAddDiscountCoupon,
|
|
2101
|
-
dealUpdateDeal,
|
|
2102
|
-
dealGetDeal,
|
|
2103
|
-
dealGetAllDeals,
|
|
2104
|
-
dealDeleteDeal,
|
|
2105
|
-
dealAddDeal,
|
|
2106
|
-
customFetch,
|
|
2107
|
-
createClient,
|
|
2108
|
-
categoryGetAllCategories,
|
|
2109
|
-
caseGetCase,
|
|
2110
|
-
caseGetAllCases,
|
|
2111
|
-
caseAddReply,
|
|
2112
|
-
caseAddClientResponse,
|
|
2113
|
-
caseAddCase,
|
|
2114
|
-
campaignUpdateBroadcastEmail,
|
|
2115
|
-
campaignUnscheduleBroadcastEmail,
|
|
2116
|
-
campaignSendTestCampaignEmail,
|
|
2117
|
-
campaignGetBroadcastEmail,
|
|
2118
|
-
campaignGetAllBroadcastEmails,
|
|
2119
|
-
campaignDeleteBroadcastCampaign,
|
|
2120
|
-
campaignArchiveBroadcastCampaign,
|
|
2121
|
-
campaignAddBroadcastEmail,
|
|
2122
|
-
articleGetArticle,
|
|
2123
|
-
articleGetAllArticles,
|
|
2124
|
-
articleAddArticle,
|
|
2125
|
-
activityGetAll,
|
|
2126
|
-
activityAddCustomActivity,
|
|
2127
|
-
accountUpdateMembership,
|
|
2128
|
-
accountUpdateAccount,
|
|
2129
|
-
accountSendConfirmationEmail,
|
|
2130
|
-
accountRemoveCancellation,
|
|
2131
|
-
accountGetAllAccounts,
|
|
2132
|
-
accountGetAccount,
|
|
2133
|
-
accountExtendTrial,
|
|
2134
|
-
accountDeleteMembership,
|
|
2135
|
-
accountDeleteAccount,
|
|
2136
|
-
accountCancelAccount,
|
|
2137
|
-
accountAddPersonToAccount,
|
|
2138
|
-
accountAddAccount,
|
|
2139
|
-
TeamRole,
|
|
2140
|
-
TaskStatus,
|
|
2141
|
-
TagColor,
|
|
2142
|
-
SupportCaseStatus,
|
|
2143
|
-
SupportCaseSource,
|
|
2144
|
-
SupportCaseHistoryType,
|
|
2145
|
-
SupportArticleStatus,
|
|
2146
|
-
SpamStatus,
|
|
2147
|
-
RegistrationField,
|
|
2148
|
-
QcountStatus,
|
|
2149
|
-
QcountConfigSettingType,
|
|
2150
|
-
PlanWebhookEntityPlanAddOnsItemAddOnBillingAddOnType,
|
|
2151
|
-
PlanWebhookEntityAccountRegistrationMode,
|
|
2152
|
-
PersonWebhookEntityPersonAccountItemRole,
|
|
2153
|
-
PersonWebhookEntityOAuthIntegrationStatus,
|
|
2154
|
-
PersonWebhookEntityEmailListPersonItemEmailListSubscriberStatus,
|
|
2155
|
-
PersonWebhookEntityAccountAccountStage,
|
|
2156
|
-
PaymentsMode,
|
|
2157
|
-
PaymentsGatewayActivationStatus,
|
|
2158
|
-
OAuthService,
|
|
2159
|
-
LineItemType,
|
|
2160
|
-
EntityType,
|
|
2161
|
-
EmailListSubscriberStatus,
|
|
2162
|
-
DeserializationStatus,
|
|
2163
|
-
DealWebhookEntityOwnerOAuthIntegrationStatus,
|
|
2164
|
-
DealWebhookEntityAccountAccountStage,
|
|
2165
|
-
DatabaseType,
|
|
2166
|
-
ContentGroupItemMatchMode,
|
|
2167
|
-
CancelationStatus,
|
|
2168
|
-
CampaignType,
|
|
2169
|
-
BroadcastCampaignStatus,
|
|
2170
|
-
BillingTransactionType,
|
|
2171
|
-
BillingSystem,
|
|
2172
|
-
BillingRenewalTerm,
|
|
2173
|
-
BillingInvoiceStatus,
|
|
2174
|
-
BillingDiscountDuration,
|
|
2175
|
-
BillingAddOnType,
|
|
2176
|
-
BackGroundTaskType,
|
|
2177
|
-
ApiKeyType,
|
|
2178
|
-
AddOnWebhookEntityBillingAddOnType,
|
|
2179
|
-
AddOnChangeType,
|
|
2180
|
-
ActivityType,
|
|
2181
|
-
AccountWebhookEntitySubscriptionsItemSubscriptionAddOnsItemBillingRenewalTerm,
|
|
2182
|
-
AccountWebhookEntitySubscriptionsItemSubscriptionAddOnsItemAddOnBillingAddOnType,
|
|
2183
|
-
AccountWebhookEntitySubscriptionsItemPlanAccountRegistrationMode,
|
|
2184
|
-
AccountWebhookEntitySubscriptionsItemLatestInvoiceBillingInvoiceStatus,
|
|
2185
|
-
AccountWebhookEntitySubscriptionsItemDiscountCouponSubscriptionsItemDiscountCouponDuration,
|
|
2186
|
-
AccountWebhookEntitySubscriptionsItemBillingRenewalTerm,
|
|
2187
|
-
AccountWebhookEntityPrimarySubscriptionBillingRenewalTerm,
|
|
2188
|
-
AccountWebhookEntityPrimaryContactOAuthIntegrationStatus,
|
|
2189
|
-
AccountWebhookEntityPersonAccountItemRole,
|
|
2190
|
-
AccountWebhookEntityPersonAccountItemPersonOAuthIntegrationStatus,
|
|
2191
|
-
AccountWebhookEntityLatestSubscriptionSubscriptionAddOnsItemBillingRenewalTerm,
|
|
2192
|
-
AccountWebhookEntityLatestSubscriptionSubscriptionAddOnsItemAddOnBillingAddOnType,
|
|
2193
|
-
AccountWebhookEntityLatestSubscriptionPlanAccountRegistrationMode,
|
|
2194
|
-
AccountWebhookEntityLatestSubscriptionLatestInvoiceBillingInvoiceStatus,
|
|
2195
|
-
AccountWebhookEntityLatestSubscriptionDiscountCouponSubscriptionsItemDiscountCouponDuration,
|
|
2196
|
-
AccountWebhookEntityLatestSubscriptionBillingRenewalTerm,
|
|
2197
|
-
AccountWebhookEntityCurrentSubscriptionSubscriptionAddOnsItemBillingRenewalTerm,
|
|
2198
|
-
AccountWebhookEntityCurrentSubscriptionSubscriptionAddOnsItemAddOnBillingAddOnType,
|
|
2199
|
-
AccountWebhookEntityCurrentSubscriptionPlanAccountRegistrationMode,
|
|
2200
|
-
AccountWebhookEntityCurrentSubscriptionLatestInvoiceBillingInvoiceStatus,
|
|
2201
|
-
AccountWebhookEntityCurrentSubscriptionDiscountCouponSubscriptionsItemDiscountCouponDuration,
|
|
2202
|
-
AccountWebhookEntityCurrentSubscriptionBillingRenewalTerm,
|
|
2203
|
-
AccountWebhookEntityAccountStage,
|
|
2204
|
-
AccountStage,
|
|
1930
|
+
AcceptTermsAndConditionsLocations,
|
|
2205
1931
|
AccountRegistrationMode,
|
|
2206
|
-
|
|
1932
|
+
AccountStage,
|
|
1933
|
+
AccountWebhookEntityAccountStage,
|
|
1934
|
+
AccountWebhookEntityCurrentSubscriptionBillingRenewalTerm,
|
|
1935
|
+
AccountWebhookEntityCurrentSubscriptionDiscountCouponSubscriptionsItemDiscountCouponDuration,
|
|
1936
|
+
AccountWebhookEntityCurrentSubscriptionLatestInvoiceBillingInvoiceStatus,
|
|
1937
|
+
AccountWebhookEntityCurrentSubscriptionPlanAccountRegistrationMode,
|
|
1938
|
+
AccountWebhookEntityCurrentSubscriptionSubscriptionAddOnsItemAddOnBillingAddOnType,
|
|
1939
|
+
AccountWebhookEntityCurrentSubscriptionSubscriptionAddOnsItemBillingRenewalTerm,
|
|
1940
|
+
AccountWebhookEntityLatestSubscriptionBillingRenewalTerm,
|
|
1941
|
+
AccountWebhookEntityLatestSubscriptionDiscountCouponSubscriptionsItemDiscountCouponDuration,
|
|
1942
|
+
AccountWebhookEntityLatestSubscriptionLatestInvoiceBillingInvoiceStatus,
|
|
1943
|
+
AccountWebhookEntityLatestSubscriptionPlanAccountRegistrationMode,
|
|
1944
|
+
AccountWebhookEntityLatestSubscriptionSubscriptionAddOnsItemAddOnBillingAddOnType,
|
|
1945
|
+
AccountWebhookEntityLatestSubscriptionSubscriptionAddOnsItemBillingRenewalTerm,
|
|
1946
|
+
AccountWebhookEntityPersonAccountItemPersonOAuthIntegrationStatus,
|
|
1947
|
+
AccountWebhookEntityPersonAccountItemRole,
|
|
1948
|
+
AccountWebhookEntityPrimaryContactOAuthIntegrationStatus,
|
|
1949
|
+
AccountWebhookEntityPrimarySubscriptionBillingRenewalTerm,
|
|
1950
|
+
AccountWebhookEntitySubscriptionsItemBillingRenewalTerm,
|
|
1951
|
+
AccountWebhookEntitySubscriptionsItemDiscountCouponSubscriptionsItemDiscountCouponDuration,
|
|
1952
|
+
AccountWebhookEntitySubscriptionsItemLatestInvoiceBillingInvoiceStatus,
|
|
1953
|
+
AccountWebhookEntitySubscriptionsItemPlanAccountRegistrationMode,
|
|
1954
|
+
AccountWebhookEntitySubscriptionsItemSubscriptionAddOnsItemAddOnBillingAddOnType,
|
|
1955
|
+
AccountWebhookEntitySubscriptionsItemSubscriptionAddOnsItemBillingRenewalTerm,
|
|
1956
|
+
ActivityType,
|
|
1957
|
+
AddOnChangeType,
|
|
1958
|
+
AddOnWebhookEntityBillingAddOnType,
|
|
1959
|
+
ApiKeyType,
|
|
1960
|
+
BackGroundTaskType,
|
|
1961
|
+
BillingAddOnType,
|
|
1962
|
+
BillingDiscountDuration,
|
|
1963
|
+
BillingInvoiceStatus,
|
|
1964
|
+
BillingRenewalTerm,
|
|
1965
|
+
BillingSystem,
|
|
1966
|
+
BillingTransactionType,
|
|
1967
|
+
BroadcastCampaignStatus,
|
|
1968
|
+
CampaignType,
|
|
1969
|
+
CancelationStatus,
|
|
1970
|
+
ContentGroupItemMatchMode,
|
|
1971
|
+
DatabaseType,
|
|
1972
|
+
DealWebhookEntityAccountAccountStage,
|
|
1973
|
+
DealWebhookEntityOwnerOAuthIntegrationStatus,
|
|
1974
|
+
DeserializationStatus,
|
|
1975
|
+
EmailListSubscriberStatus,
|
|
1976
|
+
EntityType,
|
|
1977
|
+
LineItemType,
|
|
1978
|
+
OAuthService,
|
|
1979
|
+
PaymentsGatewayActivationStatus,
|
|
1980
|
+
PaymentsMode,
|
|
1981
|
+
PersonWebhookEntityAccountAccountStage,
|
|
1982
|
+
PersonWebhookEntityEmailListPersonItemEmailListSubscriberStatus,
|
|
1983
|
+
PersonWebhookEntityOAuthIntegrationStatus,
|
|
1984
|
+
PersonWebhookEntityPersonAccountItemRole,
|
|
1985
|
+
PlanWebhookEntityAccountRegistrationMode,
|
|
1986
|
+
PlanWebhookEntityPlanAddOnsItemAddOnBillingAddOnType,
|
|
1987
|
+
QcountConfigSettingType,
|
|
1988
|
+
QcountStatus,
|
|
1989
|
+
RegistrationField,
|
|
1990
|
+
SpamStatus,
|
|
1991
|
+
SupportArticleStatus,
|
|
1992
|
+
SupportCaseHistoryType,
|
|
1993
|
+
SupportCaseSource,
|
|
1994
|
+
SupportCaseStatus,
|
|
1995
|
+
TagColor,
|
|
1996
|
+
TaskStatus,
|
|
1997
|
+
TeamRole,
|
|
1998
|
+
accountAddAccount,
|
|
1999
|
+
accountAddPersonToAccount,
|
|
2000
|
+
accountCancelAccount,
|
|
2001
|
+
accountDeleteAccount,
|
|
2002
|
+
accountDeleteMembership,
|
|
2003
|
+
accountExtendTrial,
|
|
2004
|
+
accountGetAccount,
|
|
2005
|
+
accountGetAllAccounts,
|
|
2006
|
+
accountRemoveCancellation,
|
|
2007
|
+
accountSendConfirmationEmail,
|
|
2008
|
+
accountUpdateAccount,
|
|
2009
|
+
accountUpdateMembership,
|
|
2010
|
+
activityAddCustomActivity,
|
|
2011
|
+
activityGetAll,
|
|
2012
|
+
articleAddArticle,
|
|
2013
|
+
articleGetAllArticles,
|
|
2014
|
+
articleGetArticle,
|
|
2015
|
+
campaignAddBroadcastEmail,
|
|
2016
|
+
campaignArchiveBroadcastCampaign,
|
|
2017
|
+
campaignDeleteBroadcastCampaign,
|
|
2018
|
+
campaignGetAllBroadcastEmails,
|
|
2019
|
+
campaignGetBroadcastEmail,
|
|
2020
|
+
campaignSendTestCampaignEmail,
|
|
2021
|
+
campaignUnscheduleBroadcastEmail,
|
|
2022
|
+
campaignUpdateBroadcastEmail,
|
|
2023
|
+
caseAddCase,
|
|
2024
|
+
caseAddClientResponse,
|
|
2025
|
+
caseAddReply,
|
|
2026
|
+
caseGetAllCases,
|
|
2027
|
+
caseGetCase,
|
|
2028
|
+
categoryGetAllCategories,
|
|
2029
|
+
createClient,
|
|
2030
|
+
customFetch,
|
|
2031
|
+
dealAddDeal,
|
|
2032
|
+
dealDeleteDeal,
|
|
2033
|
+
dealGetAllDeals,
|
|
2034
|
+
dealGetDeal,
|
|
2035
|
+
dealUpdateDeal,
|
|
2036
|
+
discountCouponAddDiscountCoupon,
|
|
2037
|
+
discountCouponDeleteDiscountCoupon,
|
|
2038
|
+
discountCouponGetAllDiscountCoupons,
|
|
2039
|
+
discountCouponGetDiscountCoupon,
|
|
2040
|
+
discountCouponGetDiscountCouponByCode,
|
|
2041
|
+
discountCouponGetDiscountCouponRedemptions,
|
|
2042
|
+
discountCouponUpdateDiscountCoupon,
|
|
2043
|
+
dripCampaignAddDripCampaign,
|
|
2044
|
+
dripCampaignAddDripCampaignMessage,
|
|
2045
|
+
dripCampaignDeleteDripCampaign,
|
|
2046
|
+
dripCampaignDeleteDripCampaignMessage,
|
|
2047
|
+
dripCampaignGetAllDripCampaigns,
|
|
2048
|
+
dripCampaignGetDripCampaign,
|
|
2049
|
+
dripCampaignGetDripCampaignMessage,
|
|
2050
|
+
dripCampaignSendTestCampaignEmail,
|
|
2051
|
+
dripCampaignUpdateDripCampaign,
|
|
2052
|
+
dripCampaignUpdateDripCampaignMessage,
|
|
2053
|
+
emailListAddEmailList,
|
|
2054
|
+
emailListAddSubscription,
|
|
2055
|
+
emailListDeleteEmailList,
|
|
2056
|
+
emailListDeleteSubscription,
|
|
2057
|
+
emailListGetAllEmailLists,
|
|
2058
|
+
emailListGetAllSubscriptions,
|
|
2059
|
+
emailListGetEmailList,
|
|
2060
|
+
emailListUpdateEmailList,
|
|
2061
|
+
getAccountAddAccountUrl,
|
|
2062
|
+
getAccountAddPersonToAccountUrl,
|
|
2063
|
+
getAccountCancelAccountUrl,
|
|
2064
|
+
getAccountDeleteAccountUrl,
|
|
2065
|
+
getAccountDeleteMembershipUrl,
|
|
2066
|
+
getAccountExtendTrialUrl,
|
|
2067
|
+
getAccountGetAccountUrl,
|
|
2068
|
+
getAccountGetAllAccountsUrl,
|
|
2069
|
+
getAccountRemoveCancellationUrl,
|
|
2070
|
+
getAccountSendConfirmationEmailUrl,
|
|
2071
|
+
getAccountUpdateAccountUrl,
|
|
2072
|
+
getAccountUpdateMembershipUrl,
|
|
2073
|
+
getActivityAddCustomActivityUrl,
|
|
2074
|
+
getActivityGetAllUrl,
|
|
2075
|
+
getArticleAddArticleUrl,
|
|
2076
|
+
getArticleGetAllArticlesUrl,
|
|
2077
|
+
getArticleGetArticleUrl,
|
|
2078
|
+
getCampaignAddBroadcastEmailUrl,
|
|
2079
|
+
getCampaignArchiveBroadcastCampaignUrl,
|
|
2080
|
+
getCampaignDeleteBroadcastCampaignUrl,
|
|
2081
|
+
getCampaignGetAllBroadcastEmailsUrl,
|
|
2082
|
+
getCampaignGetBroadcastEmailUrl,
|
|
2083
|
+
getCampaignSendTestCampaignEmailUrl,
|
|
2084
|
+
getCampaignUnscheduleBroadcastEmailUrl,
|
|
2085
|
+
getCampaignUpdateBroadcastEmailUrl,
|
|
2086
|
+
getCaseAddCaseUrl,
|
|
2087
|
+
getCaseAddClientResponseUrl,
|
|
2088
|
+
getCaseAddReplyUrl,
|
|
2089
|
+
getCaseGetAllCasesUrl,
|
|
2090
|
+
getCaseGetCaseUrl,
|
|
2091
|
+
getCategoryGetAllCategoriesUrl,
|
|
2092
|
+
getDealAddDealUrl,
|
|
2093
|
+
getDealDeleteDealUrl,
|
|
2094
|
+
getDealGetAllDealsUrl,
|
|
2095
|
+
getDealGetDealUrl,
|
|
2096
|
+
getDealUpdateDealUrl,
|
|
2097
|
+
getDiscountCouponAddDiscountCouponUrl,
|
|
2098
|
+
getDiscountCouponDeleteDiscountCouponUrl,
|
|
2099
|
+
getDiscountCouponGetAllDiscountCouponsUrl,
|
|
2100
|
+
getDiscountCouponGetDiscountCouponByCodeUrl,
|
|
2101
|
+
getDiscountCouponGetDiscountCouponRedemptionsUrl,
|
|
2102
|
+
getDiscountCouponGetDiscountCouponUrl,
|
|
2103
|
+
getDiscountCouponUpdateDiscountCouponUrl,
|
|
2104
|
+
getDripCampaignAddDripCampaignMessageUrl,
|
|
2105
|
+
getDripCampaignAddDripCampaignUrl,
|
|
2106
|
+
getDripCampaignDeleteDripCampaignMessageUrl,
|
|
2107
|
+
getDripCampaignDeleteDripCampaignUrl,
|
|
2108
|
+
getDripCampaignGetAllDripCampaignsUrl,
|
|
2109
|
+
getDripCampaignGetDripCampaignMessageUrl,
|
|
2110
|
+
getDripCampaignGetDripCampaignUrl,
|
|
2111
|
+
getDripCampaignSendTestCampaignEmailUrl,
|
|
2112
|
+
getDripCampaignUpdateDripCampaignMessageUrl,
|
|
2113
|
+
getDripCampaignUpdateDripCampaignUrl,
|
|
2114
|
+
getEmailListAddEmailListUrl,
|
|
2115
|
+
getEmailListAddSubscriptionUrl,
|
|
2116
|
+
getEmailListDeleteEmailListUrl,
|
|
2117
|
+
getEmailListDeleteSubscriptionUrl,
|
|
2118
|
+
getEmailListGetAllEmailListsUrl,
|
|
2119
|
+
getEmailListGetAllSubscriptionsUrl,
|
|
2120
|
+
getEmailListGetEmailListUrl,
|
|
2121
|
+
getEmailListUpdateEmailListUrl,
|
|
2122
|
+
getInvoiceAddInvoiceUrl,
|
|
2123
|
+
getInvoiceDeleteInvoiceUrl,
|
|
2124
|
+
getInvoiceGetAllInvoicesUrl,
|
|
2125
|
+
getInvoiceGetInvoiceAsPdfUrl,
|
|
2126
|
+
getInvoiceGetInvoiceUrl,
|
|
2127
|
+
getInvoiceSendInvoiceEmailUrl,
|
|
2128
|
+
getInvoiceSendInvoicePaidEmailUrl,
|
|
2129
|
+
getInvoiceUpdateInvoiceUrl,
|
|
2130
|
+
getPaymentInformationSavePaymentInformationUrl,
|
|
2131
|
+
getPersonAddPersonUrl,
|
|
2132
|
+
getPersonDeletePersonUrl,
|
|
2133
|
+
getPersonForgotPasswordUrl,
|
|
2134
|
+
getPersonGetAllPeopleUrl,
|
|
2135
|
+
getPersonGetPersonUrl,
|
|
2136
|
+
getPersonRegenerateTwoFactorRecoveryCodesUrl,
|
|
2137
|
+
getPersonRequestMagicLinkUrl,
|
|
2138
|
+
getPersonSetTemporaryPasswordUrl,
|
|
2139
|
+
getPersonUpdatePersonUrl,
|
|
2140
|
+
getPlanAddPlanUrl,
|
|
2141
|
+
getPlanDeletePlanUrl,
|
|
2142
|
+
getPlanFamilyAddPlanFamilyUrl,
|
|
2143
|
+
getPlanFamilyDeletePlanFamilyUrl,
|
|
2144
|
+
getPlanFamilyGetAllPlanFamiliesUrl,
|
|
2145
|
+
getPlanFamilyGetPlanFamilyUrl,
|
|
2146
|
+
getPlanFamilyUpdatePlanFamilyUrl,
|
|
2147
|
+
getPlanGetAllPlansUrl,
|
|
2148
|
+
getPlanGetPlanUrl,
|
|
2149
|
+
getPlanUpdatePlanUrl,
|
|
2150
|
+
getRegistrationRegisterAccountUrl,
|
|
2151
|
+
getSubscriptionAddDiscountToSubscriptionUrl,
|
|
2152
|
+
getSubscriptionAddOnAddSubscriptionAddOnPreviewUrl,
|
|
2153
|
+
getSubscriptionAddOnAddSubscriptionAddOnUrl,
|
|
2154
|
+
getSubscriptionAddOnEndSubscriptionAddOnUrl,
|
|
2155
|
+
getSubscriptionAddOnExpireSubscriptionAddOnUrl,
|
|
2156
|
+
getSubscriptionAddOnGetAllSubscriptionsAddOnsUrl,
|
|
2157
|
+
getSubscriptionAddOnGetSubscriptionAddOnUrl,
|
|
2158
|
+
getSubscriptionAddOnSetAddOnUpgradeRequiredUrl,
|
|
2159
|
+
getSubscriptionChangeSubscriptionPreviewUrl,
|
|
2160
|
+
getSubscriptionChangeSubscriptionUrl,
|
|
2161
|
+
getSubscriptionDeleteSubscriptionUrl,
|
|
2162
|
+
getSubscriptionExpireDiscountCouponSubscriptionUrl,
|
|
2163
|
+
getSubscriptionFirstTimeSubscriptionPreviewUrl,
|
|
2164
|
+
getSubscriptionFirstTimeSubscriptionUrl,
|
|
2165
|
+
getSubscriptionGetAllSubscriptionsUrl,
|
|
2166
|
+
getSubscriptionGetSubscriptionUrl,
|
|
2167
|
+
getSubscriptionSetSubscriptionUpgradeRequiredUrl,
|
|
2168
|
+
getTransactionsAddPaymentTransactionUrl,
|
|
2169
|
+
getTransactionsGetAllTransactionsByAccountIdUrl,
|
|
2170
|
+
getUsageAddUsageUrl,
|
|
2171
|
+
invoiceAddInvoice,
|
|
2172
|
+
invoiceDeleteInvoice,
|
|
2173
|
+
invoiceGetAllInvoices,
|
|
2174
|
+
invoiceGetInvoice,
|
|
2175
|
+
invoiceGetInvoiceAsPdf,
|
|
2176
|
+
invoiceSendInvoiceEmail,
|
|
2177
|
+
invoiceSendInvoicePaidEmail,
|
|
2178
|
+
invoiceUpdateInvoice,
|
|
2179
|
+
paymentInformationSavePaymentInformation,
|
|
2180
|
+
personAddPerson,
|
|
2181
|
+
personDeletePerson,
|
|
2182
|
+
personForgotPassword,
|
|
2183
|
+
personGetAllPeople,
|
|
2184
|
+
personGetPerson,
|
|
2185
|
+
personRegenerateTwoFactorRecoveryCodes,
|
|
2186
|
+
personRequestMagicLink,
|
|
2187
|
+
personSetTemporaryPassword,
|
|
2188
|
+
personUpdatePerson,
|
|
2189
|
+
planAddPlan,
|
|
2190
|
+
planDeletePlan,
|
|
2191
|
+
planFamilyAddPlanFamily,
|
|
2192
|
+
planFamilyDeletePlanFamily,
|
|
2193
|
+
planFamilyGetAllPlanFamilies,
|
|
2194
|
+
planFamilyGetPlanFamily,
|
|
2195
|
+
planFamilyUpdatePlanFamily,
|
|
2196
|
+
planGetAllPlans,
|
|
2197
|
+
planGetPlan,
|
|
2198
|
+
planUpdatePlan,
|
|
2199
|
+
registrationRegisterAccount,
|
|
2200
|
+
subscriptionAddDiscountToSubscription,
|
|
2201
|
+
subscriptionAddOnAddSubscriptionAddOn,
|
|
2202
|
+
subscriptionAddOnAddSubscriptionAddOnPreview,
|
|
2203
|
+
subscriptionAddOnEndSubscriptionAddOn,
|
|
2204
|
+
subscriptionAddOnExpireSubscriptionAddOn,
|
|
2205
|
+
subscriptionAddOnGetAllSubscriptionsAddOns,
|
|
2206
|
+
subscriptionAddOnGetSubscriptionAddOn,
|
|
2207
|
+
subscriptionAddOnSetAddOnUpgradeRequired,
|
|
2208
|
+
subscriptionChangeSubscription,
|
|
2209
|
+
subscriptionChangeSubscriptionPreview,
|
|
2210
|
+
subscriptionDeleteSubscription,
|
|
2211
|
+
subscriptionExpireDiscountCouponSubscription,
|
|
2212
|
+
subscriptionFirstTimeSubscription,
|
|
2213
|
+
subscriptionFirstTimeSubscriptionPreview,
|
|
2214
|
+
subscriptionGetAllSubscriptions,
|
|
2215
|
+
subscriptionGetSubscription,
|
|
2216
|
+
subscriptionSetSubscriptionUpgradeRequired,
|
|
2217
|
+
transactionsAddPaymentTransaction,
|
|
2218
|
+
transactionsGetAllTransactionsByAccountId,
|
|
2219
|
+
usageAddUsage,
|
|
2220
|
+
withClient
|
|
2207
2221
|
};
|
package/package.json
CHANGED
package/src/generated/crm/crm.ts
CHANGED
|
@@ -21,6 +21,7 @@ import type {
|
|
|
21
21
|
PersonForgotPasswordBody,
|
|
22
22
|
PersonGetAllPeople200,
|
|
23
23
|
PersonGetAllPeopleParams,
|
|
24
|
+
PersonRequestMagicLinkBody,
|
|
24
25
|
PersonSetTemporaryPasswordBody,
|
|
25
26
|
PersonUpdatePersonBody
|
|
26
27
|
} from '.././models';
|
|
@@ -1417,3 +1418,43 @@ export const personForgotPassword = async (personForgotPasswordBody: NonReadonly
|
|
|
1417
1418
|
);}
|
|
1418
1419
|
|
|
1419
1420
|
|
|
1421
|
+
/**
|
|
1422
|
+
* Sends an email containing a single-use, time-limited link that signs
|
|
1423
|
+
the recipient in without a password. Always responds 200 regardless
|
|
1424
|
+
of whether the email matches a known user or whether the feature is
|
|
1425
|
+
enabled, so the endpoint cannot be used to enumerate accounts.
|
|
1426
|
+
* @summary Request a passwordless magic link to sign in.
|
|
1427
|
+
*/
|
|
1428
|
+
export type personRequestMagicLinkResponse200 = {
|
|
1429
|
+
data: Blob
|
|
1430
|
+
status: 200
|
|
1431
|
+
}
|
|
1432
|
+
|
|
1433
|
+
export type personRequestMagicLinkResponseSuccess = (personRequestMagicLinkResponse200) & {
|
|
1434
|
+
headers: Headers;
|
|
1435
|
+
};
|
|
1436
|
+
;
|
|
1437
|
+
|
|
1438
|
+
export type personRequestMagicLinkResponse = (personRequestMagicLinkResponseSuccess)
|
|
1439
|
+
|
|
1440
|
+
export const getPersonRequestMagicLinkUrl = () => {
|
|
1441
|
+
|
|
1442
|
+
|
|
1443
|
+
|
|
1444
|
+
|
|
1445
|
+
return `/api/v1/crm/people/requestMagicLink`
|
|
1446
|
+
}
|
|
1447
|
+
|
|
1448
|
+
export const personRequestMagicLink = async (personRequestMagicLinkBody: NonReadonly<PersonRequestMagicLinkBody>, options?: RequestInit): Promise<personRequestMagicLinkResponse> => {
|
|
1449
|
+
|
|
1450
|
+
return customFetch<personRequestMagicLinkResponse>(getPersonRequestMagicLinkUrl(),
|
|
1451
|
+
{
|
|
1452
|
+
...options,
|
|
1453
|
+
method: 'POST',
|
|
1454
|
+
headers: { 'Content-Type': 'application/json', ...options?.headers },
|
|
1455
|
+
body: JSON.stringify(
|
|
1456
|
+
personRequestMagicLinkBody,)
|
|
1457
|
+
}
|
|
1458
|
+
);}
|
|
1459
|
+
|
|
1460
|
+
|
|
@@ -229,6 +229,7 @@ export * from './articleAllOfCategory';
|
|
|
229
229
|
export * from './articleGetAllArticles200';
|
|
230
230
|
export * from './articleGetAllArticlesParams';
|
|
231
231
|
export * from './authGetTokenParams';
|
|
232
|
+
export * from './authMagicLinkTokenParams';
|
|
232
233
|
export * from './authResendTwoFactorParams';
|
|
233
234
|
export * from './authSwitchTwoFactorMechanismParams';
|
|
234
235
|
export * from './authVerifyTwoFactorRecoveryParams';
|
|
@@ -476,6 +477,7 @@ export * from './personListUnsubscribedWebhookPayloadAllOf';
|
|
|
476
477
|
export * from './personLoginActivityData';
|
|
477
478
|
export * from './personLoginWebhookPayload';
|
|
478
479
|
export * from './personLoginWebhookPayloadAllOf';
|
|
480
|
+
export * from './personRequestMagicLinkBody';
|
|
479
481
|
export * from './personSegmentAddedActivityData';
|
|
480
482
|
export * from './personSegmentAddedWebhookPayload';
|
|
481
483
|
export * from './personSegmentAddedWebhookPayloadAllOf';
|
|
@@ -557,6 +559,7 @@ export * from './segmentPersonAllOfPerson';
|
|
|
557
559
|
export * from './segmentPersonAllOfSegment';
|
|
558
560
|
export * from './sendGridDomainAuthentication';
|
|
559
561
|
export * from './sendGridDomainAuthenticationAllOf';
|
|
562
|
+
export * from './sendTemplateEmailRequest';
|
|
560
563
|
export * from './sendTestEmailRequest';
|
|
561
564
|
export * from './sendTestEmailRequest2';
|
|
562
565
|
export * from './sendTestEmailRequest2BroadcastCampaign';
|
|
@@ -715,6 +718,15 @@ export * from './taxRateAllOf';
|
|
|
715
718
|
export * from './teamRole';
|
|
716
719
|
export * from './template';
|
|
717
720
|
export * from './templateAllOf';
|
|
721
|
+
export * from './templateEmailInstance';
|
|
722
|
+
export * from './templateEmailInstanceAllOf';
|
|
723
|
+
export * from './templateEmailInstanceAllOfRecipient';
|
|
724
|
+
export * from './templateEmailInstanceAllOfTemplate';
|
|
725
|
+
export * from './templateGetAllTemplateEmails200';
|
|
726
|
+
export * from './templateGetAllTemplateEmailsParams';
|
|
727
|
+
export * from './templateGetTemplateEmails200';
|
|
728
|
+
export * from './templateGetTemplateEmailsParams';
|
|
729
|
+
export * from './templateSendTemplateEmailBody';
|
|
718
730
|
export * from './temporaryPasswordModel';
|
|
719
731
|
export * from './tokenPayload';
|
|
720
732
|
export * from './tokenTwoFactorEnrollmentBeginEmailParams';
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// @ts-nocheck
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* `100` - Slack, `102` - MagicLinkApiKey, `103` - MagicLinkApiKeySecret, `104` - OAuth_HideCreateAccountLink, `105` - Chat_IsOffline, `106` - HostedPageCustomCode, `107` - RegistrationConfirmationEmailDelaySeconds, `108` - AccountCancellationReasons, `110` - WebhookSignatureKey, `111` - HostedProfileBackLink, `112` - AccountCancellationReasonRequired, `114` - Email_OutsetaBrandingDisabled, `119` - Email_BlacklistedInboundEmails, `121` - PasswordPolicy, `123` - CRM_FieldSortingEnabled, `124` - CRM_RegistrationCallbackLocations, `125` - KnowledgeBaseVersion, `126` - Support_SpamThreshold, `127` - Email_RestrictedPhrases, `128` - KnowledgeBaseLanguage, `130` - Billing_System, `131` - Billing_RestrictSubscriptionActions, `140` - TwoFactorAuthenticationEnabled, `142` - ForceTwoFactorAuthentication, `190` - Stripe_TaxEnabled, `192` - Stripe_TaxIdTypes, `193` - Stripe_ApplePayMerchantIdDomainAssociation, `194` - Stripe_WebhookSecret, `195` - Stripe_OnlySyncOutsetaCustomers, `196` - Stripe_Checkout_RequireBillingAddress, `197` - Stripe_Checkout_RequireConsentTermsOfService, `200` - Webflow_AccessToken, `201` - Webflow_SyncEnabled, `202` - Webflow_SyncConfiguration, `203` - Webflow_ApiVersion, `550` - CopyQcount_AddOnMap, `551` - CopyQcount_AccountMap, `552` - CopyQcount_DiscountCouponMap, `553` - CopyQcount_InvoiceMap, `554` - CopyQcount_PersonMap, `555` - CopyQcount_PlanMap, `556` - CopyQcount_PlanFamilyMap, `557` - CopyQcount_SubscriptionMap, `558` - CopyQcount_TransactionMap, `570` - StripeMigration_LastAccountId, `571` - StripeMigration_LastInvoiceId, `572` - StripeMigration_LastExpiredSubscriptionId, `573` - StripeMigration_LastPostExportSubscriptionId, `574` - StripeMigration_LastUsageId, `575` - StripeMigration_SubscriptionExportDate, `576` - StripeMigration_SubscriptionExportIds, `577` - StripeMigration_SubscriptionAddOnExportIds, `578` - StripeMigration_SubscriptionCutoverDate, `579` - StripeMigration_LastPreCutoverExportSubscriptionId
|
|
4
|
+
* `100` - Slack, `102` - MagicLinkApiKey, `103` - MagicLinkApiKeySecret, `104` - OAuth_HideCreateAccountLink, `105` - Chat_IsOffline, `106` - HostedPageCustomCode, `107` - RegistrationConfirmationEmailDelaySeconds, `108` - AccountCancellationReasons, `110` - WebhookSignatureKey, `111` - HostedProfileBackLink, `112` - AccountCancellationReasonRequired, `114` - Email_OutsetaBrandingDisabled, `119` - Email_BlacklistedInboundEmails, `121` - PasswordPolicy, `123` - CRM_FieldSortingEnabled, `124` - CRM_RegistrationCallbackLocations, `125` - KnowledgeBaseVersion, `126` - Support_SpamThreshold, `127` - Email_RestrictedPhrases, `128` - KnowledgeBaseLanguage, `130` - Billing_System, `131` - Billing_RestrictSubscriptionActions, `140` - TwoFactorAuthenticationEnabled, `142` - ForceTwoFactorAuthentication, `143` - MagicLinkLoginEnabled, `190` - Stripe_TaxEnabled, `192` - Stripe_TaxIdTypes, `193` - Stripe_ApplePayMerchantIdDomainAssociation, `194` - Stripe_WebhookSecret, `195` - Stripe_OnlySyncOutsetaCustomers, `196` - Stripe_Checkout_RequireBillingAddress, `197` - Stripe_Checkout_RequireConsentTermsOfService, `200` - Webflow_AccessToken, `201` - Webflow_SyncEnabled, `202` - Webflow_SyncConfiguration, `203` - Webflow_ApiVersion, `550` - CopyQcount_AddOnMap, `551` - CopyQcount_AccountMap, `552` - CopyQcount_DiscountCouponMap, `553` - CopyQcount_InvoiceMap, `554` - CopyQcount_PersonMap, `555` - CopyQcount_PlanMap, `556` - CopyQcount_PlanFamilyMap, `557` - CopyQcount_SubscriptionMap, `558` - CopyQcount_TransactionMap, `570` - StripeMigration_LastAccountId, `571` - StripeMigration_LastInvoiceId, `572` - StripeMigration_LastExpiredSubscriptionId, `573` - StripeMigration_LastPostExportSubscriptionId, `574` - StripeMigration_LastUsageId, `575` - StripeMigration_SubscriptionExportDate, `576` - StripeMigration_SubscriptionExportIds, `577` - StripeMigration_SubscriptionAddOnExportIds, `578` - StripeMigration_SubscriptionCutoverDate, `579` - StripeMigration_LastPreCutoverExportSubscriptionId
|
|
5
5
|
*/
|
|
6
6
|
export type QcountConfigSettingType = typeof QcountConfigSettingType[keyof typeof QcountConfigSettingType];
|
|
7
7
|
|
|
@@ -32,6 +32,7 @@ export const QcountConfigSettingType = {
|
|
|
32
32
|
Billing_RestrictSubscriptionActions: 131,
|
|
33
33
|
TwoFactorAuthenticationEnabled: 140,
|
|
34
34
|
ForceTwoFactorAuthentication: 142,
|
|
35
|
+
MagicLinkLoginEnabled: 143,
|
|
35
36
|
Stripe_TaxEnabled: 190,
|
|
36
37
|
Stripe_TaxIdTypes: 192,
|
|
37
38
|
Stripe_ApplePayMerchantIdDomainAssociation: 193,
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
// @ts-nocheck
|
|
2
|
+
|
|
3
|
+
export interface SendTemplateEmailRequest {
|
|
4
|
+
/**
|
|
5
|
+
* The Uid of the person to send the email to. Required.
|
|
6
|
+
* @nullable
|
|
7
|
+
*/
|
|
8
|
+
PersonUid?: string | null;
|
|
9
|
+
/**
|
|
10
|
+
* The from address. Defaults to the support email address for the account.
|
|
11
|
+
* @nullable
|
|
12
|
+
*/
|
|
13
|
+
FromEmail?: string | null;
|
|
14
|
+
/**
|
|
15
|
+
* The from name. Defaults to the company name.
|
|
16
|
+
* @nullable
|
|
17
|
+
*/
|
|
18
|
+
FromName?: string | null;
|
|
19
|
+
/**
|
|
20
|
+
* Overrides the subject of the template.
|
|
21
|
+
* @nullable
|
|
22
|
+
*/
|
|
23
|
+
Subject?: string | null;
|
|
24
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
// @ts-nocheck
|
|
2
|
+
import type { TemplateEmailInstanceAllOfTemplate } from './templateEmailInstanceAllOfTemplate';
|
|
3
|
+
import type { TemplateEmailInstanceAllOfRecipient } from './templateEmailInstanceAllOfRecipient';
|
|
4
|
+
|
|
5
|
+
export type TemplateEmailInstanceAllOf = {
|
|
6
|
+
/** @nullable */
|
|
7
|
+
Template?: TemplateEmailInstanceAllOfTemplate;
|
|
8
|
+
/** @nullable */
|
|
9
|
+
Recipient?: TemplateEmailInstanceAllOfRecipient;
|
|
10
|
+
/**
|
|
11
|
+
* @maxLength 50
|
|
12
|
+
* @nullable
|
|
13
|
+
*/
|
|
14
|
+
UniqueMessageId?: string | null;
|
|
15
|
+
/**
|
|
16
|
+
* @maxLength 1000
|
|
17
|
+
* @nullable
|
|
18
|
+
*/
|
|
19
|
+
Subject?: string | null;
|
|
20
|
+
/**
|
|
21
|
+
* @maxLength 250
|
|
22
|
+
* @nullable
|
|
23
|
+
*/
|
|
24
|
+
FromEmail?: string | null;
|
|
25
|
+
/**
|
|
26
|
+
* @maxLength 250
|
|
27
|
+
* @nullable
|
|
28
|
+
*/
|
|
29
|
+
FromName?: string | null;
|
|
30
|
+
SendDateTime?: string;
|
|
31
|
+
/** @nullable */
|
|
32
|
+
ProcessDateTime?: string | null;
|
|
33
|
+
/** @nullable */
|
|
34
|
+
DeliverDateTime?: string | null;
|
|
35
|
+
/** @nullable */
|
|
36
|
+
BounceDateTime?: string | null;
|
|
37
|
+
/** @nullable */
|
|
38
|
+
SpamDateTime?: string | null;
|
|
39
|
+
/** @nullable */
|
|
40
|
+
OpenDateTime?: string | null;
|
|
41
|
+
/** @nullable */
|
|
42
|
+
ClickDateTime?: string | null;
|
|
43
|
+
/** @nullable */
|
|
44
|
+
UnsubscribeDateTime?: string | null;
|
|
45
|
+
/** @nullable */
|
|
46
|
+
SendError?: string | null;
|
|
47
|
+
};
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
// @ts-nocheck
|
|
2
|
+
import type { CollectionMetadata } from './collectionMetadata';
|
|
3
|
+
import type { TemplateEmailInstance } from './templateEmailInstance';
|
|
4
|
+
|
|
5
|
+
export type TemplateGetAllTemplateEmails200 = {
|
|
6
|
+
metadata?: CollectionMetadata;
|
|
7
|
+
items?: TemplateEmailInstance[];
|
|
8
|
+
};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
// @ts-nocheck
|
|
2
|
+
import type { LimitParameter } from './limitParameter';
|
|
3
|
+
import type { OffsetParameter } from './offsetParameter';
|
|
4
|
+
|
|
5
|
+
export type TemplateGetAllTemplateEmailsParams = {
|
|
6
|
+
/**
|
|
7
|
+
* Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
|
|
8
|
+
*/
|
|
9
|
+
limit?: LimitParameter;
|
|
10
|
+
/**
|
|
11
|
+
* Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
|
|
12
|
+
*/
|
|
13
|
+
offset?: OffsetParameter;
|
|
14
|
+
};
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
// @ts-nocheck
|
|
2
|
+
import type { CollectionMetadata } from './collectionMetadata';
|
|
3
|
+
import type { TemplateEmailInstance } from './templateEmailInstance';
|
|
4
|
+
|
|
5
|
+
export type TemplateGetTemplateEmails200 = {
|
|
6
|
+
metadata?: CollectionMetadata;
|
|
7
|
+
items?: TemplateEmailInstance[];
|
|
8
|
+
};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
// @ts-nocheck
|
|
2
|
+
import type { LimitParameter } from './limitParameter';
|
|
3
|
+
import type { OffsetParameter } from './offsetParameter';
|
|
4
|
+
|
|
5
|
+
export type TemplateGetTemplateEmailsParams = {
|
|
6
|
+
/**
|
|
7
|
+
* Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
|
|
8
|
+
*/
|
|
9
|
+
limit?: LimitParameter;
|
|
10
|
+
/**
|
|
11
|
+
* Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
|
|
12
|
+
*/
|
|
13
|
+
offset?: OffsetParameter;
|
|
14
|
+
};
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
// @ts-nocheck
|
|
2
2
|
import type {
|
|
3
3
|
AuthGetTokenParams,
|
|
4
|
+
AuthMagicLinkTokenParams,
|
|
4
5
|
AuthResendTwoFactorParams,
|
|
5
6
|
AuthSwitchTwoFactorMechanismParams,
|
|
6
7
|
AuthVerifyTwoFactorRecoveryParams,
|
|
@@ -187,6 +188,76 @@ export const authGetToken = async (params: AuthGetTokenParams, options?: Request
|
|
|
187
188
|
);}
|
|
188
189
|
|
|
189
190
|
|
|
191
|
+
/**
|
|
192
|
+
* Call this with the magicToken carried by the link from a
|
|
193
|
+
"magic link" email (requested via POST /api/v1/crm/people/requestMagicLink):
|
|
194
|
+
|
|
195
|
+
{ "magic_token": "eyJ..." }
|
|
196
|
+
|
|
197
|
+
The link proves control of the email inbox, which satisfies the first
|
|
198
|
+
factor. The response then matches POST /api/v1/tokens:
|
|
199
|
+
|
|
200
|
+
- 200 with an access token when no further factor is required;
|
|
201
|
+
- 202 with a two_factor_required challenge when the user
|
|
202
|
+
has a non-email second factor (e.g. an authenticator app) that must
|
|
203
|
+
still be cleared via POST /api/v1/tokens/two-factor. Email is
|
|
204
|
+
never offered as that second factor — it was already the first.
|
|
205
|
+
|
|
206
|
+
An invalid, expired, already-used token (or a tenant without magic-link
|
|
207
|
+
login enabled) returns 400 (invalid_grant).
|
|
208
|
+
* @summary Exchange a magic-link token for an access token (passwordless login).
|
|
209
|
+
*/
|
|
210
|
+
export type authMagicLinkTokenResponse200 = {
|
|
211
|
+
data: TokenPayload
|
|
212
|
+
status: 200
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
export type authMagicLinkTokenResponse202 = {
|
|
216
|
+
data: TwoFactorChallengePayload
|
|
217
|
+
status: 202
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
export type authMagicLinkTokenResponse400 = {
|
|
221
|
+
data: string
|
|
222
|
+
status: 400
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
export type authMagicLinkTokenResponseSuccess = (authMagicLinkTokenResponse200 | authMagicLinkTokenResponse202) & {
|
|
226
|
+
headers: Headers;
|
|
227
|
+
};
|
|
228
|
+
export type authMagicLinkTokenResponseError = (authMagicLinkTokenResponse400) & {
|
|
229
|
+
headers: Headers;
|
|
230
|
+
};
|
|
231
|
+
|
|
232
|
+
export type authMagicLinkTokenResponse = (authMagicLinkTokenResponseSuccess | authMagicLinkTokenResponseError)
|
|
233
|
+
|
|
234
|
+
export const getAuthMagicLinkTokenUrl = (params: AuthMagicLinkTokenParams,) => {
|
|
235
|
+
const normalizedParams = new URLSearchParams();
|
|
236
|
+
|
|
237
|
+
Object.entries(params || {}).forEach(([key, value]) => {
|
|
238
|
+
|
|
239
|
+
if (value !== undefined) {
|
|
240
|
+
normalizedParams.append(key, value === null ? 'null' : value.toString())
|
|
241
|
+
}
|
|
242
|
+
});
|
|
243
|
+
|
|
244
|
+
const stringifiedParams = normalizedParams.toString();
|
|
245
|
+
|
|
246
|
+
return stringifiedParams.length > 0 ? `/api/v1/tokens/magic-link?${stringifiedParams}` : `/api/v1/tokens/magic-link`
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
export const authMagicLinkToken = async (params: AuthMagicLinkTokenParams, options?: RequestInit): Promise<authMagicLinkTokenResponse> => {
|
|
250
|
+
|
|
251
|
+
return customFetch<authMagicLinkTokenResponse>(getAuthMagicLinkTokenUrl(params),
|
|
252
|
+
{
|
|
253
|
+
...options,
|
|
254
|
+
method: 'POST'
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
}
|
|
258
|
+
);}
|
|
259
|
+
|
|
260
|
+
|
|
190
261
|
/**
|
|
191
262
|
* Call this after `POST /api/v1/tokens` returns `two_factor_required`.
|
|
192
263
|
Post the challenge token from that response together with the user's
|
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
// @ts-nocheck
|
|
2
|
+
import type {
|
|
3
|
+
TemplateEmailInstance,
|
|
4
|
+
TemplateGetAllTemplateEmails200,
|
|
5
|
+
TemplateGetAllTemplateEmailsParams,
|
|
6
|
+
TemplateGetTemplateEmails200,
|
|
7
|
+
TemplateGetTemplateEmailsParams,
|
|
8
|
+
TemplateSendTemplateEmailBody
|
|
9
|
+
} from '.././models';
|
|
10
|
+
|
|
11
|
+
import { customFetch } from '../../client';
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Filter with personUid to see what one person was sent, or with templateUid to
|
|
15
|
+
restrict the results to a single template.
|
|
16
|
+
* @summary The one-off emails that were sent from any email template.
|
|
17
|
+
*/
|
|
18
|
+
export type templateGetAllTemplateEmailsResponse200 = {
|
|
19
|
+
data: TemplateGetAllTemplateEmails200
|
|
20
|
+
status: 200
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
export type templateGetAllTemplateEmailsResponse401 = {
|
|
24
|
+
data: void
|
|
25
|
+
status: 401
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
export type templateGetAllTemplateEmailsResponseSuccess = (templateGetAllTemplateEmailsResponse200) & {
|
|
29
|
+
headers: Headers;
|
|
30
|
+
};
|
|
31
|
+
export type templateGetAllTemplateEmailsResponseError = (templateGetAllTemplateEmailsResponse401) & {
|
|
32
|
+
headers: Headers;
|
|
33
|
+
};
|
|
34
|
+
|
|
35
|
+
export type templateGetAllTemplateEmailsResponse = (templateGetAllTemplateEmailsResponseSuccess | templateGetAllTemplateEmailsResponseError)
|
|
36
|
+
|
|
37
|
+
export const getTemplateGetAllTemplateEmailsUrl = (params?: TemplateGetAllTemplateEmailsParams,) => {
|
|
38
|
+
const normalizedParams = new URLSearchParams();
|
|
39
|
+
|
|
40
|
+
Object.entries(params || {}).forEach(([key, value]) => {
|
|
41
|
+
|
|
42
|
+
if (value !== undefined) {
|
|
43
|
+
normalizedParams.append(key, value === null ? 'null' : value.toString())
|
|
44
|
+
}
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
const stringifiedParams = normalizedParams.toString();
|
|
48
|
+
|
|
49
|
+
return stringifiedParams.length > 0 ? `/api/v1/templates/emails?${stringifiedParams}` : `/api/v1/templates/emails`
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
export const templateGetAllTemplateEmails = async (params?: TemplateGetAllTemplateEmailsParams, options?: RequestInit): Promise<templateGetAllTemplateEmailsResponse> => {
|
|
53
|
+
|
|
54
|
+
return customFetch<templateGetAllTemplateEmailsResponse>(getTemplateGetAllTemplateEmailsUrl(params),
|
|
55
|
+
{
|
|
56
|
+
...options,
|
|
57
|
+
method: 'GET'
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
}
|
|
61
|
+
);}
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* Add personUid to the query string to see what one person was sent from this
|
|
66
|
+
template.
|
|
67
|
+
* @summary The one-off emails that were sent from this email template.
|
|
68
|
+
*/
|
|
69
|
+
export type templateGetTemplateEmailsResponse200 = {
|
|
70
|
+
data: TemplateGetTemplateEmails200
|
|
71
|
+
status: 200
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export type templateGetTemplateEmailsResponse400 = {
|
|
75
|
+
data: void
|
|
76
|
+
status: 400
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export type templateGetTemplateEmailsResponse401 = {
|
|
80
|
+
data: void
|
|
81
|
+
status: 401
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
export type templateGetTemplateEmailsResponse404 = {
|
|
85
|
+
data: void
|
|
86
|
+
status: 404
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
export type templateGetTemplateEmailsResponseSuccess = (templateGetTemplateEmailsResponse200) & {
|
|
90
|
+
headers: Headers;
|
|
91
|
+
};
|
|
92
|
+
export type templateGetTemplateEmailsResponseError = (templateGetTemplateEmailsResponse400 | templateGetTemplateEmailsResponse401 | templateGetTemplateEmailsResponse404) & {
|
|
93
|
+
headers: Headers;
|
|
94
|
+
};
|
|
95
|
+
|
|
96
|
+
export type templateGetTemplateEmailsResponse = (templateGetTemplateEmailsResponseSuccess | templateGetTemplateEmailsResponseError)
|
|
97
|
+
|
|
98
|
+
export const getTemplateGetTemplateEmailsUrl = (templateUid: string | null,
|
|
99
|
+
params?: TemplateGetTemplateEmailsParams,) => {
|
|
100
|
+
const normalizedParams = new URLSearchParams();
|
|
101
|
+
|
|
102
|
+
Object.entries(params || {}).forEach(([key, value]) => {
|
|
103
|
+
|
|
104
|
+
if (value !== undefined) {
|
|
105
|
+
normalizedParams.append(key, value === null ? 'null' : value.toString())
|
|
106
|
+
}
|
|
107
|
+
});
|
|
108
|
+
|
|
109
|
+
const stringifiedParams = normalizedParams.toString();
|
|
110
|
+
|
|
111
|
+
return stringifiedParams.length > 0 ? `/api/v1/templates/${templateUid}/emails?${stringifiedParams}` : `/api/v1/templates/${templateUid}/emails`
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
export const templateGetTemplateEmails = async (templateUid: string | null,
|
|
115
|
+
params?: TemplateGetTemplateEmailsParams, options?: RequestInit): Promise<templateGetTemplateEmailsResponse> => {
|
|
116
|
+
|
|
117
|
+
return customFetch<templateGetTemplateEmailsResponse>(getTemplateGetTemplateEmailsUrl(templateUid,params),
|
|
118
|
+
{
|
|
119
|
+
...options,
|
|
120
|
+
method: 'GET'
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
}
|
|
124
|
+
);}
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* The email is merge-rendered for the person and sent immediately. No broadcast
|
|
129
|
+
is created. People who have bounced, unsubscribed or reported spam are not sent
|
|
130
|
+
the email. Only templates from Email > Email templates can be sent.
|
|
131
|
+
|
|
132
|
+
The response holds the record of the send. Read the open and click analytics
|
|
133
|
+
for it later from the emails endpoint for the template. The template and the
|
|
134
|
+
recipient are left out of the response unless they are asked for, for example
|
|
135
|
+
fields=*,Template.Uid,Recipient.Uid.
|
|
136
|
+
* @summary Send an email template to a single person as a one-off email.
|
|
137
|
+
*/
|
|
138
|
+
export type templateSendTemplateEmailResponse200 = {
|
|
139
|
+
data: TemplateEmailInstance
|
|
140
|
+
status: 200
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
export type templateSendTemplateEmailResponse400 = {
|
|
144
|
+
data: void
|
|
145
|
+
status: 400
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
export type templateSendTemplateEmailResponse401 = {
|
|
149
|
+
data: void
|
|
150
|
+
status: 401
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
export type templateSendTemplateEmailResponse404 = {
|
|
154
|
+
data: void
|
|
155
|
+
status: 404
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
export type templateSendTemplateEmailResponseSuccess = (templateSendTemplateEmailResponse200) & {
|
|
159
|
+
headers: Headers;
|
|
160
|
+
};
|
|
161
|
+
export type templateSendTemplateEmailResponseError = (templateSendTemplateEmailResponse400 | templateSendTemplateEmailResponse401 | templateSendTemplateEmailResponse404) & {
|
|
162
|
+
headers: Headers;
|
|
163
|
+
};
|
|
164
|
+
|
|
165
|
+
export type templateSendTemplateEmailResponse = (templateSendTemplateEmailResponseSuccess | templateSendTemplateEmailResponseError)
|
|
166
|
+
|
|
167
|
+
export const getTemplateSendTemplateEmailUrl = (templateUid: string | null,) => {
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
return `/api/v1/templates/${templateUid}/send`
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
export const templateSendTemplateEmail = async (templateUid: string | null,
|
|
176
|
+
templateSendTemplateEmailBody: TemplateSendTemplateEmailBody, options?: RequestInit): Promise<templateSendTemplateEmailResponse> => {
|
|
177
|
+
|
|
178
|
+
return customFetch<templateSendTemplateEmailResponse>(getTemplateSendTemplateEmailUrl(templateUid),
|
|
179
|
+
{
|
|
180
|
+
...options,
|
|
181
|
+
method: 'POST',
|
|
182
|
+
headers: { 'Content-Type': 'application/json', ...options?.headers },
|
|
183
|
+
body: JSON.stringify(
|
|
184
|
+
templateSendTemplateEmailBody,)
|
|
185
|
+
}
|
|
186
|
+
);}
|
|
187
|
+
|
|
188
|
+
|