@wix/auto_sdk_email-marketing_account-details 1.0.26 → 1.0.27
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/build/cjs/index.d.ts +1 -1
- package/build/cjs/index.js +8 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +11 -1
- package/build/cjs/index.typings.js +8 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +11 -1
- package/build/cjs/meta.js +8 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +1 -1
- package/build/es/index.mjs +7 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +11 -1
- package/build/es/index.typings.mjs +7 -0
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +11 -1
- package/build/es/meta.mjs +7 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +1 -1
- package/build/internal/cjs/index.js +8 -0
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +11 -1
- package/build/internal/cjs/index.typings.js +8 -0
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +11 -1
- package/build/internal/cjs/meta.js +8 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +1 -1
- package/build/internal/es/index.mjs +7 -0
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +11 -1
- package/build/internal/es/index.typings.mjs +7 -0
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +11 -1
- package/build/internal/es/meta.mjs +7 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
2
|
import { GetAccountDetailsResponse } from './index.typings.js';
|
|
3
|
-
export { AccountDetails, Action, ActionWithLiterals, BillingCycle, BillingCycleWithLiterals, ComplianceDetails, Enum, EnumWithLiterals, Features, GetAccountDetailsRequest, GetComplianceDetailsRequest, GetComplianceDetailsResponse, Package, Quota, QuotaPeriod, RespondRequest, RespondResponse, SupportTicketData } from './index.typings.js';
|
|
3
|
+
export { AccountDetails, Action, ActionWithLiterals, BillingCycle, BillingCycleWithLiterals, ComplianceDetails, Enum, EnumWithLiterals, Features, GetAccountDetailsRequest, GetComplianceDetailsRequest, GetComplianceDetailsResponse, Package, Quota, QuotaPeriod, Rank, RankWithLiterals, RespondRequest, RespondResponse, SupportTicketData } from './index.typings.js';
|
|
4
4
|
|
|
5
5
|
declare function getAccountDetails$1(httpClient: HttpClient): GetAccountDetailsSignature;
|
|
6
6
|
interface GetAccountDetailsSignature {
|
package/build/cjs/index.js
CHANGED
|
@@ -23,6 +23,7 @@ __export(index_exports, {
|
|
|
23
23
|
Action: () => Action,
|
|
24
24
|
BillingCycle: () => BillingCycle,
|
|
25
25
|
Enum: () => Enum,
|
|
26
|
+
Rank: () => Rank,
|
|
26
27
|
getAccountDetails: () => getAccountDetails3
|
|
27
28
|
});
|
|
28
29
|
module.exports = __toCommonJS(index_exports);
|
|
@@ -114,6 +115,12 @@ var BillingCycle = /* @__PURE__ */ ((BillingCycle2) => {
|
|
|
114
115
|
BillingCycle2["MONTHLY"] = "MONTHLY";
|
|
115
116
|
return BillingCycle2;
|
|
116
117
|
})(BillingCycle || {});
|
|
118
|
+
var Rank = /* @__PURE__ */ ((Rank2) => {
|
|
119
|
+
Rank2["NEW"] = "NEW";
|
|
120
|
+
Rank2["GOOD"] = "GOOD";
|
|
121
|
+
Rank2["BAD"] = "BAD";
|
|
122
|
+
return Rank2;
|
|
123
|
+
})(Rank || {});
|
|
117
124
|
var Action = /* @__PURE__ */ ((Action2) => {
|
|
118
125
|
Action2["UNKNOWN_ACTION"] = "UNKNOWN_ACTION";
|
|
119
126
|
Action2["AGREE_TO_TERMS"] = "AGREE_TO_TERMS";
|
|
@@ -163,6 +170,7 @@ var getAccountDetails3 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModu
|
|
|
163
170
|
Action,
|
|
164
171
|
BillingCycle,
|
|
165
172
|
Enum,
|
|
173
|
+
Rank,
|
|
166
174
|
getAccountDetails
|
|
167
175
|
});
|
|
168
176
|
//# sourceMappingURL=index.js.map
|
package/build/cjs/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../index.ts","../../src/email-marketing-v1-account-details-account-details.universal.ts","../../src/email-marketing-v1-account-details-account-details.http.ts","../../src/email-marketing-v1-account-details-account-details.public.ts","../../src/email-marketing-v1-account-details-account-details.context.ts"],"sourcesContent":["export * from './src/email-marketing-v1-account-details-account-details.context.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n renameKeysFromSDKRequestToRESTRequest,\n renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixEmailMarketingV1AccountDetails from './email-marketing-v1-account-details-account-details.http.js';\n\n/**\n * An account can be active or in some state of suspension (warned/suspended/banned).\n * If a user is in a state of suspension they must visit their email marketing account in the dashboard and follow the instructions.\n */\nexport interface AccountDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /** Current premium package information. */\n package?: Package;\n /** Quota period and usage. */\n quotaPeriod?: QuotaPeriod;\n /** Max number of recipients for an email marketing campaign. Exceeding this limit may lead to campaigns being rejected. */\n maxCampaignAudienceSize?: number;\n}\n\nexport enum Enum {\n UNKNOWN = 'UNKNOWN',\n /** Able to use email marketing normally. */\n ACTIVE = 'ACTIVE',\n /** Must explicitly agree to terms of use to activate the account. */\n WARNED = 'WARNED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n SUSPENDED = 'SUSPENDED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n BANNED = 'BANNED',\n /** Must fill out compliance questionnaire to activate the account. */\n SUSPENDED_AUTOLIFT = 'SUSPENDED_AUTOLIFT',\n}\n\n/** @enumType */\nexport type EnumWithLiterals =\n | Enum\n | 'UNKNOWN'\n | 'ACTIVE'\n | 'WARNED'\n | 'SUSPENDED'\n | 'BANNED'\n | 'SUSPENDED_AUTOLIFT';\n\nexport interface Package {\n /** Package ID. */\n _id?: string;\n /** Package group. */\n group?: string;\n /** Allocated quota per month. */\n monthlyQuotaAllocation?: Quota;\n}\n\nexport interface Quota {\n /** Number of allocated marketing campaigns per month (-1 means unlimited). */\n campaigns?: number;\n /** Number of allocated individual emails per month. */\n emails?: number;\n}\n\nexport enum BillingCycle {\n UNKNOWN = 'UNKNOWN',\n TWO_YEARS = 'TWO_YEARS',\n YEARLY = 'YEARLY',\n MONTHLY = 'MONTHLY',\n}\n\n/** @enumType */\nexport type BillingCycleWithLiterals =\n | BillingCycle\n | 'UNKNOWN'\n | 'TWO_YEARS'\n | 'YEARLY'\n | 'MONTHLY';\n\nexport interface QuotaPeriod {\n /** Current quota period start date. */\n dateFrom?: Date | null;\n /** Current quota period end date - after which quota will roll over. */\n dateTo?: Date | null;\n /** Information about allocated quota already used in this period. */\n quotaUsage?: Quota;\n}\n\nexport interface Features {\n multipleSenderDetails?: boolean;\n removeWixBranding?: boolean;\n scheduling?: boolean;\n}\n\nexport interface GetAccountDetailsRequest {}\n\nexport interface GetAccountDetailsResponse {\n /** Current account details. */\n accountDetails?: AccountDetails;\n}\n\nexport interface GetComplianceDetailsRequest {}\n\nexport interface GetComplianceDetailsResponse {\n /** Current compliance details. */\n complianceDetails?: ComplianceDetails;\n}\n\nexport interface ComplianceDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /**\n * Suspension reasons.\n * @maxSize 10\n * @maxLength 100\n */\n suspensionReasons?: string[];\n /**\n * Suspension description.\n * @maxLength 1000\n */\n note?: string | null;\n /**\n * Support ticket id.\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\nexport interface RespondRequest {\n action?: ActionWithLiterals;\n supportTicketData?: SupportTicketData;\n}\n\nexport enum Action {\n UNKNOWN_ACTION = 'UNKNOWN_ACTION',\n AGREE_TO_TERMS = 'AGREE_TO_TERMS',\n OPEN_TICKET = 'OPEN_TICKET',\n FILL_FORM = 'FILL_FORM',\n ANSWER_QUESTIONS = 'ANSWER_QUESTIONS',\n FILL_AUTOLIFT_FORM = 'FILL_AUTOLIFT_FORM',\n}\n\n/** @enumType */\nexport type ActionWithLiterals =\n | Action\n | 'UNKNOWN_ACTION'\n | 'AGREE_TO_TERMS'\n | 'OPEN_TICKET'\n | 'FILL_FORM'\n | 'ANSWER_QUESTIONS'\n | 'FILL_AUTOLIFT_FORM';\n\nexport interface SupportTicketData {\n /** @maxLength 200 */\n subject?: string;\n /** @maxLength 20000 */\n body?: string;\n /** @maxLength 20000 */\n agentReplyBody?: string | null;\n}\n\nexport interface RespondResponse {\n /**\n * ID of the support ticket created (optional).\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\n/**\n * Retrieves email marketing account details.\n * @public\n * @permissionId Shoutout.Manage\n * @applicableIdentity APP\n * @fqn wix.emailmarketing.api.v1.AccountDetailsService.Get\n */\nexport async function getAccountDetails(): Promise<\n NonNullablePaths<\n GetAccountDetailsResponse,\n | `accountDetails.status`\n | `accountDetails.package._id`\n | `accountDetails.package.group`\n | `accountDetails.package.monthlyQuotaAllocation.campaigns`\n | `accountDetails.package.monthlyQuotaAllocation.emails`\n | `accountDetails.maxCampaignAudienceSize`,\n 5\n >\n> {\n // @ts-ignore\n const { httpClient, sideEffects } = arguments[0] as {\n httpClient: HttpClient;\n sideEffects?: any;\n };\n\n const payload = renameKeysFromSDKRequestToRESTRequest({});\n\n const reqOpts = ambassadorWixEmailMarketingV1AccountDetails.get(payload);\n\n sideEffects?.onSiteCall?.();\n try {\n const result = await httpClient.request(reqOpts);\n sideEffects?.onSuccess?.(result);\n\n return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n } catch (err: any) {\n const transformedError = sdkTransformError(\n err,\n {\n spreadPathsToArguments: {},\n explicitPathsToArguments: {},\n singleArgumentUnchanged: false,\n },\n []\n );\n sideEffects?.onError?.(err);\n\n throw transformedError;\n }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixEmailmarketingApiV1AccountDetailsServiceUrl(\n opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n const domainToMappings = {\n 'manage._base_domain_': [\n {\n srcPath: '/_api/shoutout/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n 'www.wixapis.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n '*.dev.wix-code.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n _: [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n };\n\n return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_email-marketing_account-details';\n\n/** Retrieves email marketing account details. */\nexport function get(payload: object): RequestOptionsFactory<any> {\n function __get({ host }: any) {\n const metadata = {\n entityFqdn: 'wix.email_marketing.v1.account_details',\n method: 'GET' as any,\n methodFqn: 'wix.emailmarketing.api.v1.AccountDetailsService.Get',\n packageName: PACKAGE_NAME,\n migrationOptions: {\n optInTransformResponse: true,\n },\n url: resolveWixEmailmarketingApiV1AccountDetailsServiceUrl({\n protoPath: '/v1/account-details',\n data: payload,\n host,\n }),\n params: toURLSearchParams(payload),\n transformResponse: (payload: any) =>\n transformPaths(payload, [\n {\n transformFn: transformRESTTimestampToSDKTimestamp,\n paths: [\n { path: 'accountDetails.quotaPeriod.dateFrom' },\n { path: 'accountDetails.quotaPeriod.dateTo' },\n ],\n },\n ]),\n };\n\n return metadata;\n }\n\n return __get;\n}\n","import { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport {\n GetAccountDetailsResponse,\n getAccountDetails as universalGetAccountDetails,\n} from './email-marketing-v1-account-details-account-details.universal.js';\n\nexport const __metadata = { PACKAGE_NAME: '@wix/email-marketing' };\n\nexport function getAccountDetails(\n httpClient: HttpClient\n): GetAccountDetailsSignature {\n return () =>\n universalGetAccountDetails(\n // @ts-ignore\n { httpClient }\n );\n}\n\ninterface GetAccountDetailsSignature {\n /**\n * Retrieves email marketing account details.\n */\n (): Promise<\n NonNullablePaths<\n GetAccountDetailsResponse,\n | `accountDetails.status`\n | `accountDetails.package._id`\n | `accountDetails.package.group`\n | `accountDetails.package.monthlyQuotaAllocation.campaigns`\n | `accountDetails.package.monthlyQuotaAllocation.emails`\n | `accountDetails.maxCampaignAudienceSize`,\n 5\n >\n >;\n}\n\nexport {\n AccountDetails,\n Action,\n BillingCycle,\n ComplianceDetails,\n Enum,\n Features,\n GetAccountDetailsRequest,\n GetAccountDetailsResponse,\n GetComplianceDetailsRequest,\n GetComplianceDetailsResponse,\n Package,\n Quota,\n QuotaPeriod,\n RespondRequest,\n RespondResponse,\n SupportTicketData,\n} from './email-marketing-v1-account-details-account-details.universal.js';\n","import { getAccountDetails as publicGetAccountDetails } from './email-marketing-v1-account-details-account-details.public.js';\nimport { createRESTModule } from '@wix/sdk-runtime/rest-modules';\nimport { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';\n\nexport const getAccountDetails: MaybeContext<\n BuildRESTFunction<typeof publicGetAccountDetails> &\n typeof publicGetAccountDetails\n> = /*#__PURE__*/ createRESTModule(publicGetAccountDetails);\n\nexport {\n Enum,\n BillingCycle,\n Action,\n} from './email-marketing-v1-account-details-account-details.universal.js';\nexport {\n AccountDetails,\n Package,\n Quota,\n QuotaPeriod,\n Features,\n GetAccountDetailsRequest,\n GetAccountDetailsResponse,\n GetComplianceDetailsRequest,\n GetComplianceDetailsResponse,\n ComplianceDetails,\n RespondRequest,\n SupportTicketData,\n RespondResponse,\n} from './email-marketing-v1-account-details-account-details.universal.js';\nexport {\n EnumWithLiterals,\n BillingCycleWithLiterals,\n ActionWithLiterals,\n} from './email-marketing-v1-account-details-account-details.universal.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,2BAAAA;AAAA;AAAA;;;ACAA,6BAAoD;AACpD,oCAGO;;;ACJP,0BAAkC;AAClC,uBAAqD;AACrD,6BAA+B;AAC/B,IAAAC,uBAA2B;AAI3B,SAAS,sDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAGd,SAAS,IAAI,SAA6C;AAC/D,WAAS,MAAM,EAAE,KAAK,GAAQ;AAC5B,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,sCAAsC;AAAA,YAC9C,EAAE,MAAM,oCAAoC;AAAA,UAC9C;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADpDO,IAAK,OAAL,kBAAKC,UAAL;AACL,EAAAA,MAAA,aAAU;AAEV,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,eAAY;AAEZ,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,wBAAqB;AAXX,SAAAA;AAAA,GAAA;AAwCL,IAAK,eAAL,kBAAKC,kBAAL;AACL,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,eAAY;AACZ,EAAAA,cAAA,YAAS;AACT,EAAAA,cAAA,aAAU;AAJA,SAAAA;AAAA,GAAA;AAsEL,IAAK,SAAL,kBAAKC,YAAL;AACL,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,iBAAc;AACd,EAAAA,QAAA,eAAY;AACZ,EAAAA,QAAA,sBAAmB;AACnB,EAAAA,QAAA,wBAAqB;AANX,SAAAA;AAAA,GAAA;AA2CZ,eAAsB,oBAWpB;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC,CAAC,CAAC;AAExD,QAAM,UAAsD,IAAI,OAAO;AAEvE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAC;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,CAAC;AAAA,QAC3B,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC;AAAA,IACH;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;;;AElNO,SAASC,mBACd,YAC4B;AAC5B,SAAO,MACL;AAAA;AAAA,IAEE,EAAE,WAAW;AAAA,EACf;AACJ;;;ACfA,IAAAC,uBAAiC;AAG1B,IAAMC,qBAGK,2DAAiBA,kBAAuB;","names":["getAccountDetails","import_rest_modules","payload","Enum","BillingCycle","Action","sdkTransformError","getAccountDetails","import_rest_modules","getAccountDetails"]}
|
|
1
|
+
{"version":3,"sources":["../../index.ts","../../src/email-marketing-v1-account-details-account-details.universal.ts","../../src/email-marketing-v1-account-details-account-details.http.ts","../../src/email-marketing-v1-account-details-account-details.public.ts","../../src/email-marketing-v1-account-details-account-details.context.ts"],"sourcesContent":["export * from './src/email-marketing-v1-account-details-account-details.context.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n renameKeysFromSDKRequestToRESTRequest,\n renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixEmailMarketingV1AccountDetails from './email-marketing-v1-account-details-account-details.http.js';\n\n/**\n * An account can be active or in some state of suspension (warned/suspended/banned).\n * If a user is in a state of suspension they must visit their email marketing account in the dashboard and follow the instructions.\n */\nexport interface AccountDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /** Current premium package information. */\n package?: Package;\n /** Quota period and usage. */\n quotaPeriod?: QuotaPeriod;\n /** Max number of recipients for an email marketing campaign. Exceeding this limit may lead to campaigns being rejected. */\n maxCampaignAudienceSize?: number;\n}\n\nexport enum Enum {\n UNKNOWN = 'UNKNOWN',\n /** Able to use email marketing normally. */\n ACTIVE = 'ACTIVE',\n /** Must explicitly agree to terms of use to activate the account. */\n WARNED = 'WARNED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n SUSPENDED = 'SUSPENDED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n BANNED = 'BANNED',\n /** Must fill out compliance questionnaire to activate the account. */\n SUSPENDED_AUTOLIFT = 'SUSPENDED_AUTOLIFT',\n}\n\n/** @enumType */\nexport type EnumWithLiterals =\n | Enum\n | 'UNKNOWN'\n | 'ACTIVE'\n | 'WARNED'\n | 'SUSPENDED'\n | 'BANNED'\n | 'SUSPENDED_AUTOLIFT';\n\nexport interface Package {\n /** Package ID. */\n _id?: string;\n /** Package group. */\n group?: string;\n /** Allocated quota per month. */\n monthlyQuotaAllocation?: Quota;\n}\n\nexport interface Quota {\n /** Number of allocated marketing campaigns per month (-1 means unlimited). */\n campaigns?: number;\n /** Number of allocated individual emails per month. */\n emails?: number;\n}\n\nexport enum BillingCycle {\n UNKNOWN = 'UNKNOWN',\n TWO_YEARS = 'TWO_YEARS',\n YEARLY = 'YEARLY',\n MONTHLY = 'MONTHLY',\n}\n\n/** @enumType */\nexport type BillingCycleWithLiterals =\n | BillingCycle\n | 'UNKNOWN'\n | 'TWO_YEARS'\n | 'YEARLY'\n | 'MONTHLY';\n\nexport interface QuotaPeriod {\n /** Current quota period start date. */\n dateFrom?: Date | null;\n /** Current quota period end date - after which quota will roll over. */\n dateTo?: Date | null;\n /** Information about allocated quota already used in this period. */\n quotaUsage?: Quota;\n}\n\nexport interface Features {\n multipleSenderDetails?: boolean;\n removeWixBranding?: boolean;\n scheduling?: boolean;\n}\n\nexport enum Rank {\n /** No reputation has been established (new site or didn't have enough traffic in the recent time period). */\n NEW = 'NEW',\n /** Has traffic and it's quality is good. */\n GOOD = 'GOOD',\n /** Has traffic but it's quality is bad. */\n BAD = 'BAD',\n}\n\n/** @enumType */\nexport type RankWithLiterals = Rank | 'NEW' | 'GOOD' | 'BAD';\n\nexport interface GetAccountDetailsRequest {}\n\nexport interface GetAccountDetailsResponse {\n /** Current account details. */\n accountDetails?: AccountDetails;\n}\n\nexport interface GetComplianceDetailsRequest {}\n\nexport interface GetComplianceDetailsResponse {\n /** Current compliance details. */\n complianceDetails?: ComplianceDetails;\n}\n\nexport interface ComplianceDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /**\n * Suspension reasons.\n * @maxSize 10\n * @maxLength 100\n */\n suspensionReasons?: string[];\n /**\n * Suspension description.\n * @maxLength 1000\n */\n note?: string | null;\n /**\n * Support ticket id.\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\nexport interface RespondRequest {\n action?: ActionWithLiterals;\n supportTicketData?: SupportTicketData;\n}\n\nexport enum Action {\n UNKNOWN_ACTION = 'UNKNOWN_ACTION',\n AGREE_TO_TERMS = 'AGREE_TO_TERMS',\n OPEN_TICKET = 'OPEN_TICKET',\n FILL_FORM = 'FILL_FORM',\n ANSWER_QUESTIONS = 'ANSWER_QUESTIONS',\n FILL_AUTOLIFT_FORM = 'FILL_AUTOLIFT_FORM',\n}\n\n/** @enumType */\nexport type ActionWithLiterals =\n | Action\n | 'UNKNOWN_ACTION'\n | 'AGREE_TO_TERMS'\n | 'OPEN_TICKET'\n | 'FILL_FORM'\n | 'ANSWER_QUESTIONS'\n | 'FILL_AUTOLIFT_FORM';\n\nexport interface SupportTicketData {\n /** @maxLength 200 */\n subject?: string;\n /** @maxLength 20000 */\n body?: string;\n /** @maxLength 20000 */\n agentReplyBody?: string | null;\n}\n\nexport interface RespondResponse {\n /**\n * ID of the support ticket created (optional).\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\n/**\n * Retrieves email marketing account details.\n * @public\n * @permissionId Shoutout.Manage\n * @applicableIdentity APP\n * @fqn wix.emailmarketing.api.v1.AccountDetailsService.Get\n */\nexport async function getAccountDetails(): Promise<\n NonNullablePaths<\n GetAccountDetailsResponse,\n | `accountDetails.status`\n | `accountDetails.package._id`\n | `accountDetails.package.group`\n | `accountDetails.package.monthlyQuotaAllocation.campaigns`\n | `accountDetails.package.monthlyQuotaAllocation.emails`\n | `accountDetails.maxCampaignAudienceSize`,\n 5\n >\n> {\n // @ts-ignore\n const { httpClient, sideEffects } = arguments[0] as {\n httpClient: HttpClient;\n sideEffects?: any;\n };\n\n const payload = renameKeysFromSDKRequestToRESTRequest({});\n\n const reqOpts = ambassadorWixEmailMarketingV1AccountDetails.get(payload);\n\n sideEffects?.onSiteCall?.();\n try {\n const result = await httpClient.request(reqOpts);\n sideEffects?.onSuccess?.(result);\n\n return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n } catch (err: any) {\n const transformedError = sdkTransformError(\n err,\n {\n spreadPathsToArguments: {},\n explicitPathsToArguments: {},\n singleArgumentUnchanged: false,\n },\n []\n );\n sideEffects?.onError?.(err);\n\n throw transformedError;\n }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixEmailmarketingApiV1AccountDetailsServiceUrl(\n opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n const domainToMappings = {\n 'manage._base_domain_': [\n {\n srcPath: '/_api/shoutout/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n 'www.wixapis.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n '*.dev.wix-code.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n _: [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n };\n\n return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_email-marketing_account-details';\n\n/** Retrieves email marketing account details. */\nexport function get(payload: object): RequestOptionsFactory<any> {\n function __get({ host }: any) {\n const metadata = {\n entityFqdn: 'wix.email_marketing.v1.account_details',\n method: 'GET' as any,\n methodFqn: 'wix.emailmarketing.api.v1.AccountDetailsService.Get',\n packageName: PACKAGE_NAME,\n migrationOptions: {\n optInTransformResponse: true,\n },\n url: resolveWixEmailmarketingApiV1AccountDetailsServiceUrl({\n protoPath: '/v1/account-details',\n data: payload,\n host,\n }),\n params: toURLSearchParams(payload),\n transformResponse: (payload: any) =>\n transformPaths(payload, [\n {\n transformFn: transformRESTTimestampToSDKTimestamp,\n paths: [\n { path: 'accountDetails.quotaPeriod.dateFrom' },\n { path: 'accountDetails.quotaPeriod.dateTo' },\n ],\n },\n ]),\n };\n\n return metadata;\n }\n\n return __get;\n}\n","import { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport {\n GetAccountDetailsResponse,\n getAccountDetails as universalGetAccountDetails,\n} from './email-marketing-v1-account-details-account-details.universal.js';\n\nexport const __metadata = { PACKAGE_NAME: '@wix/email-marketing' };\n\nexport function getAccountDetails(\n httpClient: HttpClient\n): GetAccountDetailsSignature {\n return () =>\n universalGetAccountDetails(\n // @ts-ignore\n { httpClient }\n );\n}\n\ninterface GetAccountDetailsSignature {\n /**\n * Retrieves email marketing account details.\n */\n (): Promise<\n NonNullablePaths<\n GetAccountDetailsResponse,\n | `accountDetails.status`\n | `accountDetails.package._id`\n | `accountDetails.package.group`\n | `accountDetails.package.monthlyQuotaAllocation.campaigns`\n | `accountDetails.package.monthlyQuotaAllocation.emails`\n | `accountDetails.maxCampaignAudienceSize`,\n 5\n >\n >;\n}\n\nexport {\n AccountDetails,\n Action,\n BillingCycle,\n ComplianceDetails,\n Enum,\n Features,\n GetAccountDetailsRequest,\n GetAccountDetailsResponse,\n GetComplianceDetailsRequest,\n GetComplianceDetailsResponse,\n Package,\n Quota,\n QuotaPeriod,\n Rank,\n RespondRequest,\n RespondResponse,\n SupportTicketData,\n} from './email-marketing-v1-account-details-account-details.universal.js';\n","import { getAccountDetails as publicGetAccountDetails } from './email-marketing-v1-account-details-account-details.public.js';\nimport { createRESTModule } from '@wix/sdk-runtime/rest-modules';\nimport { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';\n\nexport const getAccountDetails: MaybeContext<\n BuildRESTFunction<typeof publicGetAccountDetails> &\n typeof publicGetAccountDetails\n> = /*#__PURE__*/ createRESTModule(publicGetAccountDetails);\n\nexport {\n Enum,\n BillingCycle,\n Rank,\n Action,\n} from './email-marketing-v1-account-details-account-details.universal.js';\nexport {\n AccountDetails,\n Package,\n Quota,\n QuotaPeriod,\n Features,\n GetAccountDetailsRequest,\n GetAccountDetailsResponse,\n GetComplianceDetailsRequest,\n GetComplianceDetailsResponse,\n ComplianceDetails,\n RespondRequest,\n SupportTicketData,\n RespondResponse,\n} from './email-marketing-v1-account-details-account-details.universal.js';\nexport {\n EnumWithLiterals,\n BillingCycleWithLiterals,\n RankWithLiterals,\n ActionWithLiterals,\n} from './email-marketing-v1-account-details-account-details.universal.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,2BAAAA;AAAA;AAAA;;;ACAA,6BAAoD;AACpD,oCAGO;;;ACJP,0BAAkC;AAClC,uBAAqD;AACrD,6BAA+B;AAC/B,IAAAC,uBAA2B;AAI3B,SAAS,sDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAGd,SAAS,IAAI,SAA6C;AAC/D,WAAS,MAAM,EAAE,KAAK,GAAQ;AAC5B,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,sCAAsC;AAAA,YAC9C,EAAE,MAAM,oCAAoC;AAAA,UAC9C;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADpDO,IAAK,OAAL,kBAAKC,UAAL;AACL,EAAAA,MAAA,aAAU;AAEV,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,eAAY;AAEZ,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,wBAAqB;AAXX,SAAAA;AAAA,GAAA;AAwCL,IAAK,eAAL,kBAAKC,kBAAL;AACL,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,eAAY;AACZ,EAAAA,cAAA,YAAS;AACT,EAAAA,cAAA,aAAU;AAJA,SAAAA;AAAA,GAAA;AA8BL,IAAK,OAAL,kBAAKC,UAAL;AAEL,EAAAA,MAAA,SAAM;AAEN,EAAAA,MAAA,UAAO;AAEP,EAAAA,MAAA,SAAM;AANI,SAAAA;AAAA,GAAA;AAoDL,IAAK,SAAL,kBAAKC,YAAL;AACL,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,iBAAc;AACd,EAAAA,QAAA,eAAY;AACZ,EAAAA,QAAA,sBAAmB;AACnB,EAAAA,QAAA,wBAAqB;AANX,SAAAA;AAAA,GAAA;AA2CZ,eAAsB,oBAWpB;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC,CAAC,CAAC;AAExD,QAAM,UAAsD,IAAI,OAAO;AAEvE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAC;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,CAAC;AAAA,QAC3B,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC;AAAA,IACH;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;;;AE9NO,SAASC,mBACd,YAC4B;AAC5B,SAAO,MACL;AAAA;AAAA,IAEE,EAAE,WAAW;AAAA,EACf;AACJ;;;ACfA,IAAAC,uBAAiC;AAG1B,IAAMC,qBAGK,2DAAiBA,kBAAuB;","names":["getAccountDetails","import_rest_modules","payload","Enum","BillingCycle","Rank","Action","sdkTransformError","getAccountDetails","import_rest_modules","getAccountDetails"]}
|
|
@@ -64,6 +64,16 @@ interface Features {
|
|
|
64
64
|
removeWixBranding?: boolean;
|
|
65
65
|
scheduling?: boolean;
|
|
66
66
|
}
|
|
67
|
+
declare enum Rank {
|
|
68
|
+
/** No reputation has been established (new site or didn't have enough traffic in the recent time period). */
|
|
69
|
+
NEW = "NEW",
|
|
70
|
+
/** Has traffic and it's quality is good. */
|
|
71
|
+
GOOD = "GOOD",
|
|
72
|
+
/** Has traffic but it's quality is bad. */
|
|
73
|
+
BAD = "BAD"
|
|
74
|
+
}
|
|
75
|
+
/** @enumType */
|
|
76
|
+
type RankWithLiterals = Rank | 'NEW' | 'GOOD' | 'BAD';
|
|
67
77
|
interface GetAccountDetailsRequest {
|
|
68
78
|
}
|
|
69
79
|
interface GetAccountDetailsResponse {
|
|
@@ -134,4 +144,4 @@ interface RespondResponse {
|
|
|
134
144
|
*/
|
|
135
145
|
declare function getAccountDetails(): Promise<NonNullablePaths<GetAccountDetailsResponse, `accountDetails.status` | `accountDetails.package._id` | `accountDetails.package.group` | `accountDetails.package.monthlyQuotaAllocation.campaigns` | `accountDetails.package.monthlyQuotaAllocation.emails` | `accountDetails.maxCampaignAudienceSize`, 5>>;
|
|
136
146
|
|
|
137
|
-
export { type AccountDetails, Action, type ActionWithLiterals, BillingCycle, type BillingCycleWithLiterals, type ComplianceDetails, Enum, type EnumWithLiterals, type Features, type GetAccountDetailsRequest, type GetAccountDetailsResponse, type GetComplianceDetailsRequest, type GetComplianceDetailsResponse, type Package, type Quota, type QuotaPeriod, type RespondRequest, type RespondResponse, type SupportTicketData, getAccountDetails };
|
|
147
|
+
export { type AccountDetails, Action, type ActionWithLiterals, BillingCycle, type BillingCycleWithLiterals, type ComplianceDetails, Enum, type EnumWithLiterals, type Features, type GetAccountDetailsRequest, type GetAccountDetailsResponse, type GetComplianceDetailsRequest, type GetComplianceDetailsResponse, type Package, type Quota, type QuotaPeriod, Rank, type RankWithLiterals, type RespondRequest, type RespondResponse, type SupportTicketData, getAccountDetails };
|
|
@@ -23,6 +23,7 @@ __export(index_typings_exports, {
|
|
|
23
23
|
Action: () => Action,
|
|
24
24
|
BillingCycle: () => BillingCycle,
|
|
25
25
|
Enum: () => Enum,
|
|
26
|
+
Rank: () => Rank,
|
|
26
27
|
getAccountDetails: () => getAccountDetails
|
|
27
28
|
});
|
|
28
29
|
module.exports = __toCommonJS(index_typings_exports);
|
|
@@ -114,6 +115,12 @@ var BillingCycle = /* @__PURE__ */ ((BillingCycle2) => {
|
|
|
114
115
|
BillingCycle2["MONTHLY"] = "MONTHLY";
|
|
115
116
|
return BillingCycle2;
|
|
116
117
|
})(BillingCycle || {});
|
|
118
|
+
var Rank = /* @__PURE__ */ ((Rank2) => {
|
|
119
|
+
Rank2["NEW"] = "NEW";
|
|
120
|
+
Rank2["GOOD"] = "GOOD";
|
|
121
|
+
Rank2["BAD"] = "BAD";
|
|
122
|
+
return Rank2;
|
|
123
|
+
})(Rank || {});
|
|
117
124
|
var Action = /* @__PURE__ */ ((Action2) => {
|
|
118
125
|
Action2["UNKNOWN_ACTION"] = "UNKNOWN_ACTION";
|
|
119
126
|
Action2["AGREE_TO_TERMS"] = "AGREE_TO_TERMS";
|
|
@@ -151,6 +158,7 @@ async function getAccountDetails() {
|
|
|
151
158
|
Action,
|
|
152
159
|
BillingCycle,
|
|
153
160
|
Enum,
|
|
161
|
+
Rank,
|
|
154
162
|
getAccountDetails
|
|
155
163
|
});
|
|
156
164
|
//# sourceMappingURL=index.typings.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../index.typings.ts","../../src/email-marketing-v1-account-details-account-details.universal.ts","../../src/email-marketing-v1-account-details-account-details.http.ts"],"sourcesContent":["export * from './src/email-marketing-v1-account-details-account-details.universal.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n renameKeysFromSDKRequestToRESTRequest,\n renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixEmailMarketingV1AccountDetails from './email-marketing-v1-account-details-account-details.http.js';\n\n/**\n * An account can be active or in some state of suspension (warned/suspended/banned).\n * If a user is in a state of suspension they must visit their email marketing account in the dashboard and follow the instructions.\n */\nexport interface AccountDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /** Current premium package information. */\n package?: Package;\n /** Quota period and usage. */\n quotaPeriod?: QuotaPeriod;\n /** Max number of recipients for an email marketing campaign. Exceeding this limit may lead to campaigns being rejected. */\n maxCampaignAudienceSize?: number;\n}\n\nexport enum Enum {\n UNKNOWN = 'UNKNOWN',\n /** Able to use email marketing normally. */\n ACTIVE = 'ACTIVE',\n /** Must explicitly agree to terms of use to activate the account. */\n WARNED = 'WARNED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n SUSPENDED = 'SUSPENDED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n BANNED = 'BANNED',\n /** Must fill out compliance questionnaire to activate the account. */\n SUSPENDED_AUTOLIFT = 'SUSPENDED_AUTOLIFT',\n}\n\n/** @enumType */\nexport type EnumWithLiterals =\n | Enum\n | 'UNKNOWN'\n | 'ACTIVE'\n | 'WARNED'\n | 'SUSPENDED'\n | 'BANNED'\n | 'SUSPENDED_AUTOLIFT';\n\nexport interface Package {\n /** Package ID. */\n _id?: string;\n /** Package group. */\n group?: string;\n /** Allocated quota per month. */\n monthlyQuotaAllocation?: Quota;\n}\n\nexport interface Quota {\n /** Number of allocated marketing campaigns per month (-1 means unlimited). */\n campaigns?: number;\n /** Number of allocated individual emails per month. */\n emails?: number;\n}\n\nexport enum BillingCycle {\n UNKNOWN = 'UNKNOWN',\n TWO_YEARS = 'TWO_YEARS',\n YEARLY = 'YEARLY',\n MONTHLY = 'MONTHLY',\n}\n\n/** @enumType */\nexport type BillingCycleWithLiterals =\n | BillingCycle\n | 'UNKNOWN'\n | 'TWO_YEARS'\n | 'YEARLY'\n | 'MONTHLY';\n\nexport interface QuotaPeriod {\n /** Current quota period start date. */\n dateFrom?: Date | null;\n /** Current quota period end date - after which quota will roll over. */\n dateTo?: Date | null;\n /** Information about allocated quota already used in this period. */\n quotaUsage?: Quota;\n}\n\nexport interface Features {\n multipleSenderDetails?: boolean;\n removeWixBranding?: boolean;\n scheduling?: boolean;\n}\n\nexport interface GetAccountDetailsRequest {}\n\nexport interface GetAccountDetailsResponse {\n /** Current account details. */\n accountDetails?: AccountDetails;\n}\n\nexport interface GetComplianceDetailsRequest {}\n\nexport interface GetComplianceDetailsResponse {\n /** Current compliance details. */\n complianceDetails?: ComplianceDetails;\n}\n\nexport interface ComplianceDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /**\n * Suspension reasons.\n * @maxSize 10\n * @maxLength 100\n */\n suspensionReasons?: string[];\n /**\n * Suspension description.\n * @maxLength 1000\n */\n note?: string | null;\n /**\n * Support ticket id.\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\nexport interface RespondRequest {\n action?: ActionWithLiterals;\n supportTicketData?: SupportTicketData;\n}\n\nexport enum Action {\n UNKNOWN_ACTION = 'UNKNOWN_ACTION',\n AGREE_TO_TERMS = 'AGREE_TO_TERMS',\n OPEN_TICKET = 'OPEN_TICKET',\n FILL_FORM = 'FILL_FORM',\n ANSWER_QUESTIONS = 'ANSWER_QUESTIONS',\n FILL_AUTOLIFT_FORM = 'FILL_AUTOLIFT_FORM',\n}\n\n/** @enumType */\nexport type ActionWithLiterals =\n | Action\n | 'UNKNOWN_ACTION'\n | 'AGREE_TO_TERMS'\n | 'OPEN_TICKET'\n | 'FILL_FORM'\n | 'ANSWER_QUESTIONS'\n | 'FILL_AUTOLIFT_FORM';\n\nexport interface SupportTicketData {\n /** @maxLength 200 */\n subject?: string;\n /** @maxLength 20000 */\n body?: string;\n /** @maxLength 20000 */\n agentReplyBody?: string | null;\n}\n\nexport interface RespondResponse {\n /**\n * ID of the support ticket created (optional).\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\n/**\n * Retrieves email marketing account details.\n * @public\n * @permissionId Shoutout.Manage\n * @applicableIdentity APP\n * @fqn wix.emailmarketing.api.v1.AccountDetailsService.Get\n */\nexport async function getAccountDetails(): Promise<\n NonNullablePaths<\n GetAccountDetailsResponse,\n | `accountDetails.status`\n | `accountDetails.package._id`\n | `accountDetails.package.group`\n | `accountDetails.package.monthlyQuotaAllocation.campaigns`\n | `accountDetails.package.monthlyQuotaAllocation.emails`\n | `accountDetails.maxCampaignAudienceSize`,\n 5\n >\n> {\n // @ts-ignore\n const { httpClient, sideEffects } = arguments[0] as {\n httpClient: HttpClient;\n sideEffects?: any;\n };\n\n const payload = renameKeysFromSDKRequestToRESTRequest({});\n\n const reqOpts = ambassadorWixEmailMarketingV1AccountDetails.get(payload);\n\n sideEffects?.onSiteCall?.();\n try {\n const result = await httpClient.request(reqOpts);\n sideEffects?.onSuccess?.(result);\n\n return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n } catch (err: any) {\n const transformedError = sdkTransformError(\n err,\n {\n spreadPathsToArguments: {},\n explicitPathsToArguments: {},\n singleArgumentUnchanged: false,\n },\n []\n );\n sideEffects?.onError?.(err);\n\n throw transformedError;\n }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixEmailmarketingApiV1AccountDetailsServiceUrl(\n opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n const domainToMappings = {\n 'manage._base_domain_': [\n {\n srcPath: '/_api/shoutout/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n 'www.wixapis.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n '*.dev.wix-code.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n _: [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n };\n\n return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_email-marketing_account-details';\n\n/** Retrieves email marketing account details. */\nexport function get(payload: object): RequestOptionsFactory<any> {\n function __get({ host }: any) {\n const metadata = {\n entityFqdn: 'wix.email_marketing.v1.account_details',\n method: 'GET' as any,\n methodFqn: 'wix.emailmarketing.api.v1.AccountDetailsService.Get',\n packageName: PACKAGE_NAME,\n migrationOptions: {\n optInTransformResponse: true,\n },\n url: resolveWixEmailmarketingApiV1AccountDetailsServiceUrl({\n protoPath: '/v1/account-details',\n data: payload,\n host,\n }),\n params: toURLSearchParams(payload),\n transformResponse: (payload: any) =>\n transformPaths(payload, [\n {\n transformFn: transformRESTTimestampToSDKTimestamp,\n paths: [\n { path: 'accountDetails.quotaPeriod.dateFrom' },\n { path: 'accountDetails.quotaPeriod.dateTo' },\n ],\n },\n ]),\n };\n\n return metadata;\n }\n\n return __get;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,6BAAoD;AACpD,oCAGO;;;ACJP,0BAAkC;AAClC,uBAAqD;AACrD,6BAA+B;AAC/B,IAAAA,uBAA2B;AAI3B,SAAS,sDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAGd,SAAS,IAAI,SAA6C;AAC/D,WAAS,MAAM,EAAE,KAAK,GAAQ;AAC5B,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,sCAAsC;AAAA,YAC9C,EAAE,MAAM,oCAAoC;AAAA,UAC9C;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADpDO,IAAK,OAAL,kBAAKC,UAAL;AACL,EAAAA,MAAA,aAAU;AAEV,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,eAAY;AAEZ,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,wBAAqB;AAXX,SAAAA;AAAA,GAAA;AAwCL,IAAK,eAAL,kBAAKC,kBAAL;AACL,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,eAAY;AACZ,EAAAA,cAAA,YAAS;AACT,EAAAA,cAAA,aAAU;AAJA,SAAAA;AAAA,GAAA;AAsEL,IAAK,SAAL,kBAAKC,YAAL;AACL,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,iBAAc;AACd,EAAAA,QAAA,eAAY;AACZ,EAAAA,QAAA,sBAAmB;AACnB,EAAAA,QAAA,wBAAqB;AANX,SAAAA;AAAA,GAAA;AA2CZ,eAAsB,oBAWpB;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC,CAAC,CAAC;AAExD,QAAM,UAAsD,IAAI,OAAO;AAEvE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAC;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,CAAC;AAAA,QAC3B,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC;AAAA,IACH;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;","names":["import_rest_modules","payload","Enum","BillingCycle","Action","sdkTransformError"]}
|
|
1
|
+
{"version":3,"sources":["../../index.typings.ts","../../src/email-marketing-v1-account-details-account-details.universal.ts","../../src/email-marketing-v1-account-details-account-details.http.ts"],"sourcesContent":["export * from './src/email-marketing-v1-account-details-account-details.universal.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n renameKeysFromSDKRequestToRESTRequest,\n renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixEmailMarketingV1AccountDetails from './email-marketing-v1-account-details-account-details.http.js';\n\n/**\n * An account can be active or in some state of suspension (warned/suspended/banned).\n * If a user is in a state of suspension they must visit their email marketing account in the dashboard and follow the instructions.\n */\nexport interface AccountDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /** Current premium package information. */\n package?: Package;\n /** Quota period and usage. */\n quotaPeriod?: QuotaPeriod;\n /** Max number of recipients for an email marketing campaign. Exceeding this limit may lead to campaigns being rejected. */\n maxCampaignAudienceSize?: number;\n}\n\nexport enum Enum {\n UNKNOWN = 'UNKNOWN',\n /** Able to use email marketing normally. */\n ACTIVE = 'ACTIVE',\n /** Must explicitly agree to terms of use to activate the account. */\n WARNED = 'WARNED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n SUSPENDED = 'SUSPENDED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n BANNED = 'BANNED',\n /** Must fill out compliance questionnaire to activate the account. */\n SUSPENDED_AUTOLIFT = 'SUSPENDED_AUTOLIFT',\n}\n\n/** @enumType */\nexport type EnumWithLiterals =\n | Enum\n | 'UNKNOWN'\n | 'ACTIVE'\n | 'WARNED'\n | 'SUSPENDED'\n | 'BANNED'\n | 'SUSPENDED_AUTOLIFT';\n\nexport interface Package {\n /** Package ID. */\n _id?: string;\n /** Package group. */\n group?: string;\n /** Allocated quota per month. */\n monthlyQuotaAllocation?: Quota;\n}\n\nexport interface Quota {\n /** Number of allocated marketing campaigns per month (-1 means unlimited). */\n campaigns?: number;\n /** Number of allocated individual emails per month. */\n emails?: number;\n}\n\nexport enum BillingCycle {\n UNKNOWN = 'UNKNOWN',\n TWO_YEARS = 'TWO_YEARS',\n YEARLY = 'YEARLY',\n MONTHLY = 'MONTHLY',\n}\n\n/** @enumType */\nexport type BillingCycleWithLiterals =\n | BillingCycle\n | 'UNKNOWN'\n | 'TWO_YEARS'\n | 'YEARLY'\n | 'MONTHLY';\n\nexport interface QuotaPeriod {\n /** Current quota period start date. */\n dateFrom?: Date | null;\n /** Current quota period end date - after which quota will roll over. */\n dateTo?: Date | null;\n /** Information about allocated quota already used in this period. */\n quotaUsage?: Quota;\n}\n\nexport interface Features {\n multipleSenderDetails?: boolean;\n removeWixBranding?: boolean;\n scheduling?: boolean;\n}\n\nexport enum Rank {\n /** No reputation has been established (new site or didn't have enough traffic in the recent time period). */\n NEW = 'NEW',\n /** Has traffic and it's quality is good. */\n GOOD = 'GOOD',\n /** Has traffic but it's quality is bad. */\n BAD = 'BAD',\n}\n\n/** @enumType */\nexport type RankWithLiterals = Rank | 'NEW' | 'GOOD' | 'BAD';\n\nexport interface GetAccountDetailsRequest {}\n\nexport interface GetAccountDetailsResponse {\n /** Current account details. */\n accountDetails?: AccountDetails;\n}\n\nexport interface GetComplianceDetailsRequest {}\n\nexport interface GetComplianceDetailsResponse {\n /** Current compliance details. */\n complianceDetails?: ComplianceDetails;\n}\n\nexport interface ComplianceDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /**\n * Suspension reasons.\n * @maxSize 10\n * @maxLength 100\n */\n suspensionReasons?: string[];\n /**\n * Suspension description.\n * @maxLength 1000\n */\n note?: string | null;\n /**\n * Support ticket id.\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\nexport interface RespondRequest {\n action?: ActionWithLiterals;\n supportTicketData?: SupportTicketData;\n}\n\nexport enum Action {\n UNKNOWN_ACTION = 'UNKNOWN_ACTION',\n AGREE_TO_TERMS = 'AGREE_TO_TERMS',\n OPEN_TICKET = 'OPEN_TICKET',\n FILL_FORM = 'FILL_FORM',\n ANSWER_QUESTIONS = 'ANSWER_QUESTIONS',\n FILL_AUTOLIFT_FORM = 'FILL_AUTOLIFT_FORM',\n}\n\n/** @enumType */\nexport type ActionWithLiterals =\n | Action\n | 'UNKNOWN_ACTION'\n | 'AGREE_TO_TERMS'\n | 'OPEN_TICKET'\n | 'FILL_FORM'\n | 'ANSWER_QUESTIONS'\n | 'FILL_AUTOLIFT_FORM';\n\nexport interface SupportTicketData {\n /** @maxLength 200 */\n subject?: string;\n /** @maxLength 20000 */\n body?: string;\n /** @maxLength 20000 */\n agentReplyBody?: string | null;\n}\n\nexport interface RespondResponse {\n /**\n * ID of the support ticket created (optional).\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\n/**\n * Retrieves email marketing account details.\n * @public\n * @permissionId Shoutout.Manage\n * @applicableIdentity APP\n * @fqn wix.emailmarketing.api.v1.AccountDetailsService.Get\n */\nexport async function getAccountDetails(): Promise<\n NonNullablePaths<\n GetAccountDetailsResponse,\n | `accountDetails.status`\n | `accountDetails.package._id`\n | `accountDetails.package.group`\n | `accountDetails.package.monthlyQuotaAllocation.campaigns`\n | `accountDetails.package.monthlyQuotaAllocation.emails`\n | `accountDetails.maxCampaignAudienceSize`,\n 5\n >\n> {\n // @ts-ignore\n const { httpClient, sideEffects } = arguments[0] as {\n httpClient: HttpClient;\n sideEffects?: any;\n };\n\n const payload = renameKeysFromSDKRequestToRESTRequest({});\n\n const reqOpts = ambassadorWixEmailMarketingV1AccountDetails.get(payload);\n\n sideEffects?.onSiteCall?.();\n try {\n const result = await httpClient.request(reqOpts);\n sideEffects?.onSuccess?.(result);\n\n return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n } catch (err: any) {\n const transformedError = sdkTransformError(\n err,\n {\n spreadPathsToArguments: {},\n explicitPathsToArguments: {},\n singleArgumentUnchanged: false,\n },\n []\n );\n sideEffects?.onError?.(err);\n\n throw transformedError;\n }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixEmailmarketingApiV1AccountDetailsServiceUrl(\n opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n const domainToMappings = {\n 'manage._base_domain_': [\n {\n srcPath: '/_api/shoutout/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n 'www.wixapis.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n '*.dev.wix-code.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n _: [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n };\n\n return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_email-marketing_account-details';\n\n/** Retrieves email marketing account details. */\nexport function get(payload: object): RequestOptionsFactory<any> {\n function __get({ host }: any) {\n const metadata = {\n entityFqdn: 'wix.email_marketing.v1.account_details',\n method: 'GET' as any,\n methodFqn: 'wix.emailmarketing.api.v1.AccountDetailsService.Get',\n packageName: PACKAGE_NAME,\n migrationOptions: {\n optInTransformResponse: true,\n },\n url: resolveWixEmailmarketingApiV1AccountDetailsServiceUrl({\n protoPath: '/v1/account-details',\n data: payload,\n host,\n }),\n params: toURLSearchParams(payload),\n transformResponse: (payload: any) =>\n transformPaths(payload, [\n {\n transformFn: transformRESTTimestampToSDKTimestamp,\n paths: [\n { path: 'accountDetails.quotaPeriod.dateFrom' },\n { path: 'accountDetails.quotaPeriod.dateTo' },\n ],\n },\n ]),\n };\n\n return metadata;\n }\n\n return __get;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,6BAAoD;AACpD,oCAGO;;;ACJP,0BAAkC;AAClC,uBAAqD;AACrD,6BAA+B;AAC/B,IAAAA,uBAA2B;AAI3B,SAAS,sDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAGd,SAAS,IAAI,SAA6C;AAC/D,WAAS,MAAM,EAAE,KAAK,GAAQ;AAC5B,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,sCAAsC;AAAA,YAC9C,EAAE,MAAM,oCAAoC;AAAA,UAC9C;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADpDO,IAAK,OAAL,kBAAKC,UAAL;AACL,EAAAA,MAAA,aAAU;AAEV,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,eAAY;AAEZ,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,wBAAqB;AAXX,SAAAA;AAAA,GAAA;AAwCL,IAAK,eAAL,kBAAKC,kBAAL;AACL,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,eAAY;AACZ,EAAAA,cAAA,YAAS;AACT,EAAAA,cAAA,aAAU;AAJA,SAAAA;AAAA,GAAA;AA8BL,IAAK,OAAL,kBAAKC,UAAL;AAEL,EAAAA,MAAA,SAAM;AAEN,EAAAA,MAAA,UAAO;AAEP,EAAAA,MAAA,SAAM;AANI,SAAAA;AAAA,GAAA;AAoDL,IAAK,SAAL,kBAAKC,YAAL;AACL,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,iBAAc;AACd,EAAAA,QAAA,eAAY;AACZ,EAAAA,QAAA,sBAAmB;AACnB,EAAAA,QAAA,wBAAqB;AANX,SAAAA;AAAA,GAAA;AA2CZ,eAAsB,oBAWpB;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC,CAAC,CAAC;AAExD,QAAM,UAAsD,IAAI,OAAO;AAEvE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAC;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,CAAC;AAAA,QAC3B,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC;AAAA,IACH;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;","names":["import_rest_modules","payload","Enum","BillingCycle","Rank","Action","sdkTransformError"]}
|
package/build/cjs/meta.d.ts
CHANGED
|
@@ -65,6 +65,16 @@ interface Features {
|
|
|
65
65
|
removeWixBranding?: boolean;
|
|
66
66
|
scheduling?: boolean;
|
|
67
67
|
}
|
|
68
|
+
declare enum Rank {
|
|
69
|
+
/** No reputation has been established (new site or didn't have enough traffic in the recent time period). */
|
|
70
|
+
NEW = "NEW",
|
|
71
|
+
/** Has traffic and it's quality is good. */
|
|
72
|
+
GOOD = "GOOD",
|
|
73
|
+
/** Has traffic but it's quality is bad. */
|
|
74
|
+
BAD = "BAD"
|
|
75
|
+
}
|
|
76
|
+
/** @enumType */
|
|
77
|
+
type RankWithLiterals = Rank | 'NEW' | 'GOOD' | 'BAD';
|
|
68
78
|
interface GetAccountDetailsRequest {
|
|
69
79
|
}
|
|
70
80
|
interface GetAccountDetailsResponse {
|
|
@@ -139,4 +149,4 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
139
149
|
};
|
|
140
150
|
declare function getAccountDetails(): __PublicMethodMetaInfo<'GET', {}, GetAccountDetailsRequest$1, GetAccountDetailsRequest, GetAccountDetailsResponse$1, GetAccountDetailsResponse>;
|
|
141
151
|
|
|
142
|
-
export { type AccountDetails as AccountDetailsOriginal, Action as ActionOriginal, type ActionWithLiterals as ActionWithLiteralsOriginal, BillingCycle as BillingCycleOriginal, type BillingCycleWithLiterals as BillingCycleWithLiteralsOriginal, type ComplianceDetails as ComplianceDetailsOriginal, Enum as EnumOriginal, type EnumWithLiterals as EnumWithLiteralsOriginal, type Features as FeaturesOriginal, type GetAccountDetailsRequest as GetAccountDetailsRequestOriginal, type GetAccountDetailsResponse as GetAccountDetailsResponseOriginal, type GetComplianceDetailsRequest as GetComplianceDetailsRequestOriginal, type GetComplianceDetailsResponse as GetComplianceDetailsResponseOriginal, type Package as PackageOriginal, type Quota as QuotaOriginal, type QuotaPeriod as QuotaPeriodOriginal, type RespondRequest as RespondRequestOriginal, type RespondResponse as RespondResponseOriginal, type SupportTicketData as SupportTicketDataOriginal, type __PublicMethodMetaInfo, getAccountDetails };
|
|
152
|
+
export { type AccountDetails as AccountDetailsOriginal, Action as ActionOriginal, type ActionWithLiterals as ActionWithLiteralsOriginal, BillingCycle as BillingCycleOriginal, type BillingCycleWithLiterals as BillingCycleWithLiteralsOriginal, type ComplianceDetails as ComplianceDetailsOriginal, Enum as EnumOriginal, type EnumWithLiterals as EnumWithLiteralsOriginal, type Features as FeaturesOriginal, type GetAccountDetailsRequest as GetAccountDetailsRequestOriginal, type GetAccountDetailsResponse as GetAccountDetailsResponseOriginal, type GetComplianceDetailsRequest as GetComplianceDetailsRequestOriginal, type GetComplianceDetailsResponse as GetComplianceDetailsResponseOriginal, type Package as PackageOriginal, type Quota as QuotaOriginal, type QuotaPeriod as QuotaPeriodOriginal, Rank as RankOriginal, type RankWithLiterals as RankWithLiteralsOriginal, type RespondRequest as RespondRequestOriginal, type RespondResponse as RespondResponseOriginal, type SupportTicketData as SupportTicketDataOriginal, type __PublicMethodMetaInfo, getAccountDetails };
|
package/build/cjs/meta.js
CHANGED
|
@@ -23,6 +23,7 @@ __export(meta_exports, {
|
|
|
23
23
|
ActionOriginal: () => Action,
|
|
24
24
|
BillingCycleOriginal: () => BillingCycle,
|
|
25
25
|
EnumOriginal: () => Enum,
|
|
26
|
+
RankOriginal: () => Rank,
|
|
26
27
|
getAccountDetails: () => getAccountDetails
|
|
27
28
|
});
|
|
28
29
|
module.exports = __toCommonJS(meta_exports);
|
|
@@ -110,6 +111,12 @@ var BillingCycle = /* @__PURE__ */ ((BillingCycle2) => {
|
|
|
110
111
|
BillingCycle2["MONTHLY"] = "MONTHLY";
|
|
111
112
|
return BillingCycle2;
|
|
112
113
|
})(BillingCycle || {});
|
|
114
|
+
var Rank = /* @__PURE__ */ ((Rank2) => {
|
|
115
|
+
Rank2["NEW"] = "NEW";
|
|
116
|
+
Rank2["GOOD"] = "GOOD";
|
|
117
|
+
Rank2["BAD"] = "BAD";
|
|
118
|
+
return Rank2;
|
|
119
|
+
})(Rank || {});
|
|
113
120
|
var Action = /* @__PURE__ */ ((Action2) => {
|
|
114
121
|
Action2["UNKNOWN_ACTION"] = "UNKNOWN_ACTION";
|
|
115
122
|
Action2["AGREE_TO_TERMS"] = "AGREE_TO_TERMS";
|
|
@@ -144,6 +151,7 @@ function getAccountDetails() {
|
|
|
144
151
|
ActionOriginal,
|
|
145
152
|
BillingCycleOriginal,
|
|
146
153
|
EnumOriginal,
|
|
154
|
+
RankOriginal,
|
|
147
155
|
getAccountDetails
|
|
148
156
|
});
|
|
149
157
|
//# sourceMappingURL=meta.js.map
|
package/build/cjs/meta.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../meta.ts","../../src/email-marketing-v1-account-details-account-details.http.ts","../../src/email-marketing-v1-account-details-account-details.types.ts","../../src/email-marketing-v1-account-details-account-details.meta.ts"],"sourcesContent":["export * from './src/email-marketing-v1-account-details-account-details.meta.js';\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixEmailmarketingApiV1AccountDetailsServiceUrl(\n opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n const domainToMappings = {\n 'manage._base_domain_': [\n {\n srcPath: '/_api/shoutout/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n 'www.wixapis.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n '*.dev.wix-code.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n _: [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n };\n\n return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_email-marketing_account-details';\n\n/** Retrieves email marketing account details. */\nexport function get(payload: object): RequestOptionsFactory<any> {\n function __get({ host }: any) {\n const metadata = {\n entityFqdn: 'wix.email_marketing.v1.account_details',\n method: 'GET' as any,\n methodFqn: 'wix.emailmarketing.api.v1.AccountDetailsService.Get',\n packageName: PACKAGE_NAME,\n migrationOptions: {\n optInTransformResponse: true,\n },\n url: resolveWixEmailmarketingApiV1AccountDetailsServiceUrl({\n protoPath: '/v1/account-details',\n data: payload,\n host,\n }),\n params: toURLSearchParams(payload),\n transformResponse: (payload: any) =>\n transformPaths(payload, [\n {\n transformFn: transformRESTTimestampToSDKTimestamp,\n paths: [\n { path: 'accountDetails.quotaPeriod.dateFrom' },\n { path: 'accountDetails.quotaPeriod.dateTo' },\n ],\n },\n ]),\n };\n\n return metadata;\n }\n\n return __get;\n}\n","/**\n * An account can be active or in some state of suspension (warned/suspended/banned).\n * If a user is in a state of suspension they must visit their email marketing account in the dashboard and follow the instructions.\n */\nexport interface AccountDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /** Current premium package information. */\n package?: Package;\n /** Quota period and usage. */\n quotaPeriod?: QuotaPeriod;\n /** Max number of recipients for an email marketing campaign. Exceeding this limit may lead to campaigns being rejected. */\n maxCampaignAudienceSize?: number;\n}\n\nexport enum Enum {\n UNKNOWN = 'UNKNOWN',\n /** Able to use email marketing normally. */\n ACTIVE = 'ACTIVE',\n /** Must explicitly agree to terms of use to activate the account. */\n WARNED = 'WARNED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n SUSPENDED = 'SUSPENDED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n BANNED = 'BANNED',\n /** Must fill out compliance questionnaire to activate the account. */\n SUSPENDED_AUTOLIFT = 'SUSPENDED_AUTOLIFT',\n}\n\n/** @enumType */\nexport type EnumWithLiterals =\n | Enum\n | 'UNKNOWN'\n | 'ACTIVE'\n | 'WARNED'\n | 'SUSPENDED'\n | 'BANNED'\n | 'SUSPENDED_AUTOLIFT';\n\nexport interface Package {\n /** Package ID. */\n id?: string;\n /** Package group. */\n group?: string;\n /** Allocated quota per month. */\n monthlyQuotaAllocation?: Quota;\n}\n\nexport interface Quota {\n /** Number of allocated marketing campaigns per month (-1 means unlimited). */\n campaigns?: number;\n /** Number of allocated individual emails per month. */\n emails?: number;\n}\n\nexport enum BillingCycle {\n UNKNOWN = 'UNKNOWN',\n TWO_YEARS = 'TWO_YEARS',\n YEARLY = 'YEARLY',\n MONTHLY = 'MONTHLY',\n}\n\n/** @enumType */\nexport type BillingCycleWithLiterals =\n | BillingCycle\n | 'UNKNOWN'\n | 'TWO_YEARS'\n | 'YEARLY'\n | 'MONTHLY';\n\nexport interface QuotaPeriod {\n /** Current quota period start date. */\n dateFrom?: Date | null;\n /** Current quota period end date - after which quota will roll over. */\n dateTo?: Date | null;\n /** Information about allocated quota already used in this period. */\n quotaUsage?: Quota;\n}\n\nexport interface Features {\n multipleSenderDetails?: boolean;\n removeWixBranding?: boolean;\n scheduling?: boolean;\n}\n\nexport interface GetAccountDetailsRequest {}\n\nexport interface GetAccountDetailsResponse {\n /** Current account details. */\n accountDetails?: AccountDetails;\n}\n\nexport interface GetComplianceDetailsRequest {}\n\nexport interface GetComplianceDetailsResponse {\n /** Current compliance details. */\n complianceDetails?: ComplianceDetails;\n}\n\nexport interface ComplianceDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /**\n * Suspension reasons.\n * @maxSize 10\n * @maxLength 100\n */\n suspensionReasons?: string[];\n /**\n * Suspension description.\n * @maxLength 1000\n */\n note?: string | null;\n /**\n * Support ticket id.\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\nexport interface RespondRequest {\n action?: ActionWithLiterals;\n supportTicketData?: SupportTicketData;\n}\n\nexport enum Action {\n UNKNOWN_ACTION = 'UNKNOWN_ACTION',\n AGREE_TO_TERMS = 'AGREE_TO_TERMS',\n OPEN_TICKET = 'OPEN_TICKET',\n FILL_FORM = 'FILL_FORM',\n ANSWER_QUESTIONS = 'ANSWER_QUESTIONS',\n FILL_AUTOLIFT_FORM = 'FILL_AUTOLIFT_FORM',\n}\n\n/** @enumType */\nexport type ActionWithLiterals =\n | Action\n | 'UNKNOWN_ACTION'\n | 'AGREE_TO_TERMS'\n | 'OPEN_TICKET'\n | 'FILL_FORM'\n | 'ANSWER_QUESTIONS'\n | 'FILL_AUTOLIFT_FORM';\n\nexport interface SupportTicketData {\n /** @maxLength 200 */\n subject?: string;\n /** @maxLength 20000 */\n body?: string;\n /** @maxLength 20000 */\n agentReplyBody?: string | null;\n}\n\nexport interface RespondResponse {\n /**\n * ID of the support ticket created (optional).\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n","import * as ambassadorWixEmailMarketingV1AccountDetails from './email-marketing-v1-account-details-account-details.http.js';\nimport * as ambassadorWixEmailMarketingV1AccountDetailsTypes from './email-marketing-v1-account-details-account-details.types.js';\nimport * as ambassadorWixEmailMarketingV1AccountDetailsUniversalTypes from './email-marketing-v1-account-details-account-details.universal.js';\n\nexport type __PublicMethodMetaInfo<\n K = string,\n M = unknown,\n T = unknown,\n S = unknown,\n Q = unknown,\n R = unknown\n> = {\n getUrl: (context: any) => string;\n httpMethod: K;\n path: string;\n pathParams: M;\n __requestType: T;\n __originalRequestType: S;\n __responseType: Q;\n __originalResponseType: R;\n};\n\nexport function getAccountDetails(): __PublicMethodMetaInfo<\n 'GET',\n {},\n ambassadorWixEmailMarketingV1AccountDetailsUniversalTypes.GetAccountDetailsRequest,\n ambassadorWixEmailMarketingV1AccountDetailsTypes.GetAccountDetailsRequest,\n ambassadorWixEmailMarketingV1AccountDetailsUniversalTypes.GetAccountDetailsResponse,\n ambassadorWixEmailMarketingV1AccountDetailsTypes.GetAccountDetailsResponse\n> {\n const payload = {} as any;\n\n const getRequestOptions =\n ambassadorWixEmailMarketingV1AccountDetails.get(payload);\n\n const getUrl = (context: any): string => {\n const { url } = getRequestOptions(context);\n return url!;\n };\n\n return {\n getUrl,\n httpMethod: 'GET',\n path: '/v1/account-details',\n pathParams: {},\n __requestType: null as any,\n __originalRequestType: null as any,\n __responseType: null as any,\n __originalResponseType: null as any,\n };\n}\n\nexport {\n AccountDetails as AccountDetailsOriginal,\n Enum as EnumOriginal,\n EnumWithLiterals as EnumWithLiteralsOriginal,\n Package as PackageOriginal,\n Quota as QuotaOriginal,\n BillingCycle as BillingCycleOriginal,\n BillingCycleWithLiterals as BillingCycleWithLiteralsOriginal,\n QuotaPeriod as QuotaPeriodOriginal,\n Features as FeaturesOriginal,\n GetAccountDetailsRequest as GetAccountDetailsRequestOriginal,\n GetAccountDetailsResponse as GetAccountDetailsResponseOriginal,\n GetComplianceDetailsRequest as GetComplianceDetailsRequestOriginal,\n GetComplianceDetailsResponse as GetComplianceDetailsResponseOriginal,\n ComplianceDetails as ComplianceDetailsOriginal,\n RespondRequest as RespondRequestOriginal,\n Action as ActionOriginal,\n ActionWithLiterals as ActionWithLiteralsOriginal,\n SupportTicketData as SupportTicketDataOriginal,\n RespondResponse as RespondResponseOriginal,\n} from './email-marketing-v1-account-details-account-details.types.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,0BAAkC;AAClC,uBAAqD;AACrD,6BAA+B;AAC/B,IAAAA,uBAA2B;AAI3B,SAAS,sDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAGd,SAAS,IAAI,SAA6C;AAC/D,WAAS,MAAM,EAAE,KAAK,GAAQ;AAC5B,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,sCAAsC;AAAA,YAC9C,EAAE,MAAM,oCAAoC;AAAA,UAC9C;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;AC5DO,IAAK,OAAL,kBAAKC,UAAL;AACL,EAAAA,MAAA,aAAU;AAEV,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,eAAY;AAEZ,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,wBAAqB;AAXX,SAAAA;AAAA,GAAA;AAwCL,IAAK,eAAL,kBAAKC,kBAAL;AACL,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,eAAY;AACZ,EAAAA,cAAA,YAAS;AACT,EAAAA,cAAA,aAAU;AAJA,SAAAA;AAAA,GAAA;AAsEL,IAAK,SAAL,kBAAKC,YAAL;AACL,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,iBAAc;AACd,EAAAA,QAAA,eAAY;AACZ,EAAAA,QAAA,sBAAmB;AACnB,EAAAA,QAAA,wBAAqB;AANX,SAAAA;AAAA,GAAA;;;ACvGL,SAAS,oBAOd;AACA,QAAM,UAAU,CAAC;AAEjB,QAAM,oBACwC,IAAI,OAAO;AAEzD,QAAM,SAAS,CAAC,YAAyB;AACvC,UAAM,EAAE,IAAI,IAAI,kBAAkB,OAAO;AACzC,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,YAAY,CAAC;AAAA,IACb,eAAe;AAAA,IACf,uBAAuB;AAAA,IACvB,gBAAgB;AAAA,IAChB,wBAAwB;AAAA,EAC1B;AACF;","names":["import_rest_modules","payload","Enum","BillingCycle","Action"]}
|
|
1
|
+
{"version":3,"sources":["../../meta.ts","../../src/email-marketing-v1-account-details-account-details.http.ts","../../src/email-marketing-v1-account-details-account-details.types.ts","../../src/email-marketing-v1-account-details-account-details.meta.ts"],"sourcesContent":["export * from './src/email-marketing-v1-account-details-account-details.meta.js';\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixEmailmarketingApiV1AccountDetailsServiceUrl(\n opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n const domainToMappings = {\n 'manage._base_domain_': [\n {\n srcPath: '/_api/shoutout/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n 'www.wixapis.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n '*.dev.wix-code.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n _: [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n };\n\n return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_email-marketing_account-details';\n\n/** Retrieves email marketing account details. */\nexport function get(payload: object): RequestOptionsFactory<any> {\n function __get({ host }: any) {\n const metadata = {\n entityFqdn: 'wix.email_marketing.v1.account_details',\n method: 'GET' as any,\n methodFqn: 'wix.emailmarketing.api.v1.AccountDetailsService.Get',\n packageName: PACKAGE_NAME,\n migrationOptions: {\n optInTransformResponse: true,\n },\n url: resolveWixEmailmarketingApiV1AccountDetailsServiceUrl({\n protoPath: '/v1/account-details',\n data: payload,\n host,\n }),\n params: toURLSearchParams(payload),\n transformResponse: (payload: any) =>\n transformPaths(payload, [\n {\n transformFn: transformRESTTimestampToSDKTimestamp,\n paths: [\n { path: 'accountDetails.quotaPeriod.dateFrom' },\n { path: 'accountDetails.quotaPeriod.dateTo' },\n ],\n },\n ]),\n };\n\n return metadata;\n }\n\n return __get;\n}\n","/**\n * An account can be active or in some state of suspension (warned/suspended/banned).\n * If a user is in a state of suspension they must visit their email marketing account in the dashboard and follow the instructions.\n */\nexport interface AccountDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /** Current premium package information. */\n package?: Package;\n /** Quota period and usage. */\n quotaPeriod?: QuotaPeriod;\n /** Max number of recipients for an email marketing campaign. Exceeding this limit may lead to campaigns being rejected. */\n maxCampaignAudienceSize?: number;\n}\n\nexport enum Enum {\n UNKNOWN = 'UNKNOWN',\n /** Able to use email marketing normally. */\n ACTIVE = 'ACTIVE',\n /** Must explicitly agree to terms of use to activate the account. */\n WARNED = 'WARNED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n SUSPENDED = 'SUSPENDED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n BANNED = 'BANNED',\n /** Must fill out compliance questionnaire to activate the account. */\n SUSPENDED_AUTOLIFT = 'SUSPENDED_AUTOLIFT',\n}\n\n/** @enumType */\nexport type EnumWithLiterals =\n | Enum\n | 'UNKNOWN'\n | 'ACTIVE'\n | 'WARNED'\n | 'SUSPENDED'\n | 'BANNED'\n | 'SUSPENDED_AUTOLIFT';\n\nexport interface Package {\n /** Package ID. */\n id?: string;\n /** Package group. */\n group?: string;\n /** Allocated quota per month. */\n monthlyQuotaAllocation?: Quota;\n}\n\nexport interface Quota {\n /** Number of allocated marketing campaigns per month (-1 means unlimited). */\n campaigns?: number;\n /** Number of allocated individual emails per month. */\n emails?: number;\n}\n\nexport enum BillingCycle {\n UNKNOWN = 'UNKNOWN',\n TWO_YEARS = 'TWO_YEARS',\n YEARLY = 'YEARLY',\n MONTHLY = 'MONTHLY',\n}\n\n/** @enumType */\nexport type BillingCycleWithLiterals =\n | BillingCycle\n | 'UNKNOWN'\n | 'TWO_YEARS'\n | 'YEARLY'\n | 'MONTHLY';\n\nexport interface QuotaPeriod {\n /** Current quota period start date. */\n dateFrom?: Date | null;\n /** Current quota period end date - after which quota will roll over. */\n dateTo?: Date | null;\n /** Information about allocated quota already used in this period. */\n quotaUsage?: Quota;\n}\n\nexport interface Features {\n multipleSenderDetails?: boolean;\n removeWixBranding?: boolean;\n scheduling?: boolean;\n}\n\nexport enum Rank {\n /** No reputation has been established (new site or didn't have enough traffic in the recent time period). */\n NEW = 'NEW',\n /** Has traffic and it's quality is good. */\n GOOD = 'GOOD',\n /** Has traffic but it's quality is bad. */\n BAD = 'BAD',\n}\n\n/** @enumType */\nexport type RankWithLiterals = Rank | 'NEW' | 'GOOD' | 'BAD';\n\nexport interface GetAccountDetailsRequest {}\n\nexport interface GetAccountDetailsResponse {\n /** Current account details. */\n accountDetails?: AccountDetails;\n}\n\nexport interface GetComplianceDetailsRequest {}\n\nexport interface GetComplianceDetailsResponse {\n /** Current compliance details. */\n complianceDetails?: ComplianceDetails;\n}\n\nexport interface ComplianceDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /**\n * Suspension reasons.\n * @maxSize 10\n * @maxLength 100\n */\n suspensionReasons?: string[];\n /**\n * Suspension description.\n * @maxLength 1000\n */\n note?: string | null;\n /**\n * Support ticket id.\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\nexport interface RespondRequest {\n action?: ActionWithLiterals;\n supportTicketData?: SupportTicketData;\n}\n\nexport enum Action {\n UNKNOWN_ACTION = 'UNKNOWN_ACTION',\n AGREE_TO_TERMS = 'AGREE_TO_TERMS',\n OPEN_TICKET = 'OPEN_TICKET',\n FILL_FORM = 'FILL_FORM',\n ANSWER_QUESTIONS = 'ANSWER_QUESTIONS',\n FILL_AUTOLIFT_FORM = 'FILL_AUTOLIFT_FORM',\n}\n\n/** @enumType */\nexport type ActionWithLiterals =\n | Action\n | 'UNKNOWN_ACTION'\n | 'AGREE_TO_TERMS'\n | 'OPEN_TICKET'\n | 'FILL_FORM'\n | 'ANSWER_QUESTIONS'\n | 'FILL_AUTOLIFT_FORM';\n\nexport interface SupportTicketData {\n /** @maxLength 200 */\n subject?: string;\n /** @maxLength 20000 */\n body?: string;\n /** @maxLength 20000 */\n agentReplyBody?: string | null;\n}\n\nexport interface RespondResponse {\n /**\n * ID of the support ticket created (optional).\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n","import * as ambassadorWixEmailMarketingV1AccountDetails from './email-marketing-v1-account-details-account-details.http.js';\nimport * as ambassadorWixEmailMarketingV1AccountDetailsTypes from './email-marketing-v1-account-details-account-details.types.js';\nimport * as ambassadorWixEmailMarketingV1AccountDetailsUniversalTypes from './email-marketing-v1-account-details-account-details.universal.js';\n\nexport type __PublicMethodMetaInfo<\n K = string,\n M = unknown,\n T = unknown,\n S = unknown,\n Q = unknown,\n R = unknown\n> = {\n getUrl: (context: any) => string;\n httpMethod: K;\n path: string;\n pathParams: M;\n __requestType: T;\n __originalRequestType: S;\n __responseType: Q;\n __originalResponseType: R;\n};\n\nexport function getAccountDetails(): __PublicMethodMetaInfo<\n 'GET',\n {},\n ambassadorWixEmailMarketingV1AccountDetailsUniversalTypes.GetAccountDetailsRequest,\n ambassadorWixEmailMarketingV1AccountDetailsTypes.GetAccountDetailsRequest,\n ambassadorWixEmailMarketingV1AccountDetailsUniversalTypes.GetAccountDetailsResponse,\n ambassadorWixEmailMarketingV1AccountDetailsTypes.GetAccountDetailsResponse\n> {\n const payload = {} as any;\n\n const getRequestOptions =\n ambassadorWixEmailMarketingV1AccountDetails.get(payload);\n\n const getUrl = (context: any): string => {\n const { url } = getRequestOptions(context);\n return url!;\n };\n\n return {\n getUrl,\n httpMethod: 'GET',\n path: '/v1/account-details',\n pathParams: {},\n __requestType: null as any,\n __originalRequestType: null as any,\n __responseType: null as any,\n __originalResponseType: null as any,\n };\n}\n\nexport {\n AccountDetails as AccountDetailsOriginal,\n Enum as EnumOriginal,\n EnumWithLiterals as EnumWithLiteralsOriginal,\n Package as PackageOriginal,\n Quota as QuotaOriginal,\n BillingCycle as BillingCycleOriginal,\n BillingCycleWithLiterals as BillingCycleWithLiteralsOriginal,\n QuotaPeriod as QuotaPeriodOriginal,\n Features as FeaturesOriginal,\n Rank as RankOriginal,\n RankWithLiterals as RankWithLiteralsOriginal,\n GetAccountDetailsRequest as GetAccountDetailsRequestOriginal,\n GetAccountDetailsResponse as GetAccountDetailsResponseOriginal,\n GetComplianceDetailsRequest as GetComplianceDetailsRequestOriginal,\n GetComplianceDetailsResponse as GetComplianceDetailsResponseOriginal,\n ComplianceDetails as ComplianceDetailsOriginal,\n RespondRequest as RespondRequestOriginal,\n Action as ActionOriginal,\n ActionWithLiterals as ActionWithLiteralsOriginal,\n SupportTicketData as SupportTicketDataOriginal,\n RespondResponse as RespondResponseOriginal,\n} from './email-marketing-v1-account-details-account-details.types.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,0BAAkC;AAClC,uBAAqD;AACrD,6BAA+B;AAC/B,IAAAA,uBAA2B;AAI3B,SAAS,sDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAGd,SAAS,IAAI,SAA6C;AAC/D,WAAS,MAAM,EAAE,KAAK,GAAQ;AAC5B,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,sCAAsC;AAAA,YAC9C,EAAE,MAAM,oCAAoC;AAAA,UAC9C;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;AC5DO,IAAK,OAAL,kBAAKC,UAAL;AACL,EAAAA,MAAA,aAAU;AAEV,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,eAAY;AAEZ,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,wBAAqB;AAXX,SAAAA;AAAA,GAAA;AAwCL,IAAK,eAAL,kBAAKC,kBAAL;AACL,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,eAAY;AACZ,EAAAA,cAAA,YAAS;AACT,EAAAA,cAAA,aAAU;AAJA,SAAAA;AAAA,GAAA;AA8BL,IAAK,OAAL,kBAAKC,UAAL;AAEL,EAAAA,MAAA,SAAM;AAEN,EAAAA,MAAA,UAAO;AAEP,EAAAA,MAAA,SAAM;AANI,SAAAA;AAAA,GAAA;AAoDL,IAAK,SAAL,kBAAKC,YAAL;AACL,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,iBAAc;AACd,EAAAA,QAAA,eAAY;AACZ,EAAAA,QAAA,sBAAmB;AACnB,EAAAA,QAAA,wBAAqB;AANX,SAAAA;AAAA,GAAA;;;ACnHL,SAAS,oBAOd;AACA,QAAM,UAAU,CAAC;AAEjB,QAAM,oBACwC,IAAI,OAAO;AAEzD,QAAM,SAAS,CAAC,YAAyB;AACvC,UAAM,EAAE,IAAI,IAAI,kBAAkB,OAAO;AACzC,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,YAAY,CAAC;AAAA,IACb,eAAe;AAAA,IACf,uBAAuB;AAAA,IACvB,gBAAgB;AAAA,IAChB,wBAAwB;AAAA,EAC1B;AACF;","names":["import_rest_modules","payload","Enum","BillingCycle","Rank","Action"]}
|
package/build/es/index.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
2
|
import { GetAccountDetailsResponse } from './index.typings.mjs';
|
|
3
|
-
export { AccountDetails, Action, ActionWithLiterals, BillingCycle, BillingCycleWithLiterals, ComplianceDetails, Enum, EnumWithLiterals, Features, GetAccountDetailsRequest, GetComplianceDetailsRequest, GetComplianceDetailsResponse, Package, Quota, QuotaPeriod, RespondRequest, RespondResponse, SupportTicketData } from './index.typings.mjs';
|
|
3
|
+
export { AccountDetails, Action, ActionWithLiterals, BillingCycle, BillingCycleWithLiterals, ComplianceDetails, Enum, EnumWithLiterals, Features, GetAccountDetailsRequest, GetComplianceDetailsRequest, GetComplianceDetailsResponse, Package, Quota, QuotaPeriod, Rank, RankWithLiterals, RespondRequest, RespondResponse, SupportTicketData } from './index.typings.mjs';
|
|
4
4
|
|
|
5
5
|
declare function getAccountDetails$1(httpClient: HttpClient): GetAccountDetailsSignature;
|
|
6
6
|
interface GetAccountDetailsSignature {
|
package/build/es/index.mjs
CHANGED
|
@@ -88,6 +88,12 @@ var BillingCycle = /* @__PURE__ */ ((BillingCycle2) => {
|
|
|
88
88
|
BillingCycle2["MONTHLY"] = "MONTHLY";
|
|
89
89
|
return BillingCycle2;
|
|
90
90
|
})(BillingCycle || {});
|
|
91
|
+
var Rank = /* @__PURE__ */ ((Rank2) => {
|
|
92
|
+
Rank2["NEW"] = "NEW";
|
|
93
|
+
Rank2["GOOD"] = "GOOD";
|
|
94
|
+
Rank2["BAD"] = "BAD";
|
|
95
|
+
return Rank2;
|
|
96
|
+
})(Rank || {});
|
|
91
97
|
var Action = /* @__PURE__ */ ((Action2) => {
|
|
92
98
|
Action2["UNKNOWN_ACTION"] = "UNKNOWN_ACTION";
|
|
93
99
|
Action2["AGREE_TO_TERMS"] = "AGREE_TO_TERMS";
|
|
@@ -136,6 +142,7 @@ export {
|
|
|
136
142
|
Action,
|
|
137
143
|
BillingCycle,
|
|
138
144
|
Enum,
|
|
145
|
+
Rank,
|
|
139
146
|
getAccountDetails3 as getAccountDetails
|
|
140
147
|
};
|
|
141
148
|
//# sourceMappingURL=index.mjs.map
|
package/build/es/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/email-marketing-v1-account-details-account-details.universal.ts","../../src/email-marketing-v1-account-details-account-details.http.ts","../../src/email-marketing-v1-account-details-account-details.public.ts","../../src/email-marketing-v1-account-details-account-details.context.ts"],"sourcesContent":["import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n renameKeysFromSDKRequestToRESTRequest,\n renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixEmailMarketingV1AccountDetails from './email-marketing-v1-account-details-account-details.http.js';\n\n/**\n * An account can be active or in some state of suspension (warned/suspended/banned).\n * If a user is in a state of suspension they must visit their email marketing account in the dashboard and follow the instructions.\n */\nexport interface AccountDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /** Current premium package information. */\n package?: Package;\n /** Quota period and usage. */\n quotaPeriod?: QuotaPeriod;\n /** Max number of recipients for an email marketing campaign. Exceeding this limit may lead to campaigns being rejected. */\n maxCampaignAudienceSize?: number;\n}\n\nexport enum Enum {\n UNKNOWN = 'UNKNOWN',\n /** Able to use email marketing normally. */\n ACTIVE = 'ACTIVE',\n /** Must explicitly agree to terms of use to activate the account. */\n WARNED = 'WARNED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n SUSPENDED = 'SUSPENDED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n BANNED = 'BANNED',\n /** Must fill out compliance questionnaire to activate the account. */\n SUSPENDED_AUTOLIFT = 'SUSPENDED_AUTOLIFT',\n}\n\n/** @enumType */\nexport type EnumWithLiterals =\n | Enum\n | 'UNKNOWN'\n | 'ACTIVE'\n | 'WARNED'\n | 'SUSPENDED'\n | 'BANNED'\n | 'SUSPENDED_AUTOLIFT';\n\nexport interface Package {\n /** Package ID. */\n _id?: string;\n /** Package group. */\n group?: string;\n /** Allocated quota per month. */\n monthlyQuotaAllocation?: Quota;\n}\n\nexport interface Quota {\n /** Number of allocated marketing campaigns per month (-1 means unlimited). */\n campaigns?: number;\n /** Number of allocated individual emails per month. */\n emails?: number;\n}\n\nexport enum BillingCycle {\n UNKNOWN = 'UNKNOWN',\n TWO_YEARS = 'TWO_YEARS',\n YEARLY = 'YEARLY',\n MONTHLY = 'MONTHLY',\n}\n\n/** @enumType */\nexport type BillingCycleWithLiterals =\n | BillingCycle\n | 'UNKNOWN'\n | 'TWO_YEARS'\n | 'YEARLY'\n | 'MONTHLY';\n\nexport interface QuotaPeriod {\n /** Current quota period start date. */\n dateFrom?: Date | null;\n /** Current quota period end date - after which quota will roll over. */\n dateTo?: Date | null;\n /** Information about allocated quota already used in this period. */\n quotaUsage?: Quota;\n}\n\nexport interface Features {\n multipleSenderDetails?: boolean;\n removeWixBranding?: boolean;\n scheduling?: boolean;\n}\n\nexport interface GetAccountDetailsRequest {}\n\nexport interface GetAccountDetailsResponse {\n /** Current account details. */\n accountDetails?: AccountDetails;\n}\n\nexport interface GetComplianceDetailsRequest {}\n\nexport interface GetComplianceDetailsResponse {\n /** Current compliance details. */\n complianceDetails?: ComplianceDetails;\n}\n\nexport interface ComplianceDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /**\n * Suspension reasons.\n * @maxSize 10\n * @maxLength 100\n */\n suspensionReasons?: string[];\n /**\n * Suspension description.\n * @maxLength 1000\n */\n note?: string | null;\n /**\n * Support ticket id.\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\nexport interface RespondRequest {\n action?: ActionWithLiterals;\n supportTicketData?: SupportTicketData;\n}\n\nexport enum Action {\n UNKNOWN_ACTION = 'UNKNOWN_ACTION',\n AGREE_TO_TERMS = 'AGREE_TO_TERMS',\n OPEN_TICKET = 'OPEN_TICKET',\n FILL_FORM = 'FILL_FORM',\n ANSWER_QUESTIONS = 'ANSWER_QUESTIONS',\n FILL_AUTOLIFT_FORM = 'FILL_AUTOLIFT_FORM',\n}\n\n/** @enumType */\nexport type ActionWithLiterals =\n | Action\n | 'UNKNOWN_ACTION'\n | 'AGREE_TO_TERMS'\n | 'OPEN_TICKET'\n | 'FILL_FORM'\n | 'ANSWER_QUESTIONS'\n | 'FILL_AUTOLIFT_FORM';\n\nexport interface SupportTicketData {\n /** @maxLength 200 */\n subject?: string;\n /** @maxLength 20000 */\n body?: string;\n /** @maxLength 20000 */\n agentReplyBody?: string | null;\n}\n\nexport interface RespondResponse {\n /**\n * ID of the support ticket created (optional).\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\n/**\n * Retrieves email marketing account details.\n * @public\n * @permissionId Shoutout.Manage\n * @applicableIdentity APP\n * @fqn wix.emailmarketing.api.v1.AccountDetailsService.Get\n */\nexport async function getAccountDetails(): Promise<\n NonNullablePaths<\n GetAccountDetailsResponse,\n | `accountDetails.status`\n | `accountDetails.package._id`\n | `accountDetails.package.group`\n | `accountDetails.package.monthlyQuotaAllocation.campaigns`\n | `accountDetails.package.monthlyQuotaAllocation.emails`\n | `accountDetails.maxCampaignAudienceSize`,\n 5\n >\n> {\n // @ts-ignore\n const { httpClient, sideEffects } = arguments[0] as {\n httpClient: HttpClient;\n sideEffects?: any;\n };\n\n const payload = renameKeysFromSDKRequestToRESTRequest({});\n\n const reqOpts = ambassadorWixEmailMarketingV1AccountDetails.get(payload);\n\n sideEffects?.onSiteCall?.();\n try {\n const result = await httpClient.request(reqOpts);\n sideEffects?.onSuccess?.(result);\n\n return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n } catch (err: any) {\n const transformedError = sdkTransformError(\n err,\n {\n spreadPathsToArguments: {},\n explicitPathsToArguments: {},\n singleArgumentUnchanged: false,\n },\n []\n );\n sideEffects?.onError?.(err);\n\n throw transformedError;\n }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixEmailmarketingApiV1AccountDetailsServiceUrl(\n opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n const domainToMappings = {\n 'manage._base_domain_': [\n {\n srcPath: '/_api/shoutout/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n 'www.wixapis.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n '*.dev.wix-code.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n _: [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n };\n\n return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_email-marketing_account-details';\n\n/** Retrieves email marketing account details. */\nexport function get(payload: object): RequestOptionsFactory<any> {\n function __get({ host }: any) {\n const metadata = {\n entityFqdn: 'wix.email_marketing.v1.account_details',\n method: 'GET' as any,\n methodFqn: 'wix.emailmarketing.api.v1.AccountDetailsService.Get',\n packageName: PACKAGE_NAME,\n migrationOptions: {\n optInTransformResponse: true,\n },\n url: resolveWixEmailmarketingApiV1AccountDetailsServiceUrl({\n protoPath: '/v1/account-details',\n data: payload,\n host,\n }),\n params: toURLSearchParams(payload),\n transformResponse: (payload: any) =>\n transformPaths(payload, [\n {\n transformFn: transformRESTTimestampToSDKTimestamp,\n paths: [\n { path: 'accountDetails.quotaPeriod.dateFrom' },\n { path: 'accountDetails.quotaPeriod.dateTo' },\n ],\n },\n ]),\n };\n\n return metadata;\n }\n\n return __get;\n}\n","import { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport {\n GetAccountDetailsResponse,\n getAccountDetails as universalGetAccountDetails,\n} from './email-marketing-v1-account-details-account-details.universal.js';\n\nexport const __metadata = { PACKAGE_NAME: '@wix/email-marketing' };\n\nexport function getAccountDetails(\n httpClient: HttpClient\n): GetAccountDetailsSignature {\n return () =>\n universalGetAccountDetails(\n // @ts-ignore\n { httpClient }\n );\n}\n\ninterface GetAccountDetailsSignature {\n /**\n * Retrieves email marketing account details.\n */\n (): Promise<\n NonNullablePaths<\n GetAccountDetailsResponse,\n | `accountDetails.status`\n | `accountDetails.package._id`\n | `accountDetails.package.group`\n | `accountDetails.package.monthlyQuotaAllocation.campaigns`\n | `accountDetails.package.monthlyQuotaAllocation.emails`\n | `accountDetails.maxCampaignAudienceSize`,\n 5\n >\n >;\n}\n\nexport {\n AccountDetails,\n Action,\n BillingCycle,\n ComplianceDetails,\n Enum,\n Features,\n GetAccountDetailsRequest,\n GetAccountDetailsResponse,\n GetComplianceDetailsRequest,\n GetComplianceDetailsResponse,\n Package,\n Quota,\n QuotaPeriod,\n RespondRequest,\n RespondResponse,\n SupportTicketData,\n} from './email-marketing-v1-account-details-account-details.universal.js';\n","import { getAccountDetails as publicGetAccountDetails } from './email-marketing-v1-account-details-account-details.public.js';\nimport { createRESTModule } from '@wix/sdk-runtime/rest-modules';\nimport { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';\n\nexport const getAccountDetails: MaybeContext<\n BuildRESTFunction<typeof publicGetAccountDetails> &\n typeof publicGetAccountDetails\n> = /*#__PURE__*/ createRESTModule(publicGetAccountDetails);\n\nexport {\n Enum,\n BillingCycle,\n Action,\n} from './email-marketing-v1-account-details-account-details.universal.js';\nexport {\n AccountDetails,\n Package,\n Quota,\n QuotaPeriod,\n Features,\n GetAccountDetailsRequest,\n GetAccountDetailsResponse,\n GetComplianceDetailsRequest,\n GetComplianceDetailsResponse,\n ComplianceDetails,\n RespondRequest,\n SupportTicketData,\n RespondResponse,\n} from './email-marketing-v1-account-details-account-details.universal.js';\nexport {\n EnumWithLiterals,\n BillingCycleWithLiterals,\n ActionWithLiterals,\n} from './email-marketing-v1-account-details-account-details.universal.js';\n"],"mappings":";AAAA,SAAS,kBAAkB,yBAAyB;AACpD;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACJP,SAAS,yBAAyB;AAClC,SAAS,4CAA4C;AACrD,SAAS,sBAAsB;AAC/B,SAAS,kBAAkB;AAI3B,SAAS,sDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,SAAO,WAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAGd,SAAS,IAAI,SAA6C;AAC/D,WAAS,MAAM,EAAE,KAAK,GAAQ;AAC5B,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,QAAQ,kBAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACA,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,sCAAsC;AAAA,YAC9C,EAAE,MAAM,oCAAoC;AAAA,UAC9C;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADpDO,IAAK,OAAL,kBAAKC,UAAL;AACL,EAAAA,MAAA,aAAU;AAEV,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,eAAY;AAEZ,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,wBAAqB;AAXX,SAAAA;AAAA,GAAA;AAwCL,IAAK,eAAL,kBAAKC,kBAAL;AACL,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,eAAY;AACZ,EAAAA,cAAA,YAAS;AACT,EAAAA,cAAA,aAAU;AAJA,SAAAA;AAAA,GAAA;AAsEL,IAAK,SAAL,kBAAKC,YAAL;AACL,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,iBAAc;AACd,EAAAA,QAAA,eAAY;AACZ,EAAAA,QAAA,sBAAmB;AACnB,EAAAA,QAAA,wBAAqB;AANX,SAAAA;AAAA,GAAA;AA2CZ,eAAsB,oBAWpB;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC,CAAC,CAAC;AAExD,QAAM,UAAsD,IAAI,OAAO;AAEvE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,CAAC;AAAA,QAC3B,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC;AAAA,IACH;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;;;AElNO,SAASC,mBACd,YAC4B;AAC5B,SAAO,MACL;AAAA;AAAA,IAEE,EAAE,WAAW;AAAA,EACf;AACJ;;;ACfA,SAAS,wBAAwB;AAG1B,IAAMC,qBAGK,iCAAiBA,kBAAuB;","names":["payload","Enum","BillingCycle","Action","getAccountDetails","getAccountDetails"]}
|
|
1
|
+
{"version":3,"sources":["../../src/email-marketing-v1-account-details-account-details.universal.ts","../../src/email-marketing-v1-account-details-account-details.http.ts","../../src/email-marketing-v1-account-details-account-details.public.ts","../../src/email-marketing-v1-account-details-account-details.context.ts"],"sourcesContent":["import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n renameKeysFromSDKRequestToRESTRequest,\n renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixEmailMarketingV1AccountDetails from './email-marketing-v1-account-details-account-details.http.js';\n\n/**\n * An account can be active or in some state of suspension (warned/suspended/banned).\n * If a user is in a state of suspension they must visit their email marketing account in the dashboard and follow the instructions.\n */\nexport interface AccountDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /** Current premium package information. */\n package?: Package;\n /** Quota period and usage. */\n quotaPeriod?: QuotaPeriod;\n /** Max number of recipients for an email marketing campaign. Exceeding this limit may lead to campaigns being rejected. */\n maxCampaignAudienceSize?: number;\n}\n\nexport enum Enum {\n UNKNOWN = 'UNKNOWN',\n /** Able to use email marketing normally. */\n ACTIVE = 'ACTIVE',\n /** Must explicitly agree to terms of use to activate the account. */\n WARNED = 'WARNED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n SUSPENDED = 'SUSPENDED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n BANNED = 'BANNED',\n /** Must fill out compliance questionnaire to activate the account. */\n SUSPENDED_AUTOLIFT = 'SUSPENDED_AUTOLIFT',\n}\n\n/** @enumType */\nexport type EnumWithLiterals =\n | Enum\n | 'UNKNOWN'\n | 'ACTIVE'\n | 'WARNED'\n | 'SUSPENDED'\n | 'BANNED'\n | 'SUSPENDED_AUTOLIFT';\n\nexport interface Package {\n /** Package ID. */\n _id?: string;\n /** Package group. */\n group?: string;\n /** Allocated quota per month. */\n monthlyQuotaAllocation?: Quota;\n}\n\nexport interface Quota {\n /** Number of allocated marketing campaigns per month (-1 means unlimited). */\n campaigns?: number;\n /** Number of allocated individual emails per month. */\n emails?: number;\n}\n\nexport enum BillingCycle {\n UNKNOWN = 'UNKNOWN',\n TWO_YEARS = 'TWO_YEARS',\n YEARLY = 'YEARLY',\n MONTHLY = 'MONTHLY',\n}\n\n/** @enumType */\nexport type BillingCycleWithLiterals =\n | BillingCycle\n | 'UNKNOWN'\n | 'TWO_YEARS'\n | 'YEARLY'\n | 'MONTHLY';\n\nexport interface QuotaPeriod {\n /** Current quota period start date. */\n dateFrom?: Date | null;\n /** Current quota period end date - after which quota will roll over. */\n dateTo?: Date | null;\n /** Information about allocated quota already used in this period. */\n quotaUsage?: Quota;\n}\n\nexport interface Features {\n multipleSenderDetails?: boolean;\n removeWixBranding?: boolean;\n scheduling?: boolean;\n}\n\nexport enum Rank {\n /** No reputation has been established (new site or didn't have enough traffic in the recent time period). */\n NEW = 'NEW',\n /** Has traffic and it's quality is good. */\n GOOD = 'GOOD',\n /** Has traffic but it's quality is bad. */\n BAD = 'BAD',\n}\n\n/** @enumType */\nexport type RankWithLiterals = Rank | 'NEW' | 'GOOD' | 'BAD';\n\nexport interface GetAccountDetailsRequest {}\n\nexport interface GetAccountDetailsResponse {\n /** Current account details. */\n accountDetails?: AccountDetails;\n}\n\nexport interface GetComplianceDetailsRequest {}\n\nexport interface GetComplianceDetailsResponse {\n /** Current compliance details. */\n complianceDetails?: ComplianceDetails;\n}\n\nexport interface ComplianceDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /**\n * Suspension reasons.\n * @maxSize 10\n * @maxLength 100\n */\n suspensionReasons?: string[];\n /**\n * Suspension description.\n * @maxLength 1000\n */\n note?: string | null;\n /**\n * Support ticket id.\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\nexport interface RespondRequest {\n action?: ActionWithLiterals;\n supportTicketData?: SupportTicketData;\n}\n\nexport enum Action {\n UNKNOWN_ACTION = 'UNKNOWN_ACTION',\n AGREE_TO_TERMS = 'AGREE_TO_TERMS',\n OPEN_TICKET = 'OPEN_TICKET',\n FILL_FORM = 'FILL_FORM',\n ANSWER_QUESTIONS = 'ANSWER_QUESTIONS',\n FILL_AUTOLIFT_FORM = 'FILL_AUTOLIFT_FORM',\n}\n\n/** @enumType */\nexport type ActionWithLiterals =\n | Action\n | 'UNKNOWN_ACTION'\n | 'AGREE_TO_TERMS'\n | 'OPEN_TICKET'\n | 'FILL_FORM'\n | 'ANSWER_QUESTIONS'\n | 'FILL_AUTOLIFT_FORM';\n\nexport interface SupportTicketData {\n /** @maxLength 200 */\n subject?: string;\n /** @maxLength 20000 */\n body?: string;\n /** @maxLength 20000 */\n agentReplyBody?: string | null;\n}\n\nexport interface RespondResponse {\n /**\n * ID of the support ticket created (optional).\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\n/**\n * Retrieves email marketing account details.\n * @public\n * @permissionId Shoutout.Manage\n * @applicableIdentity APP\n * @fqn wix.emailmarketing.api.v1.AccountDetailsService.Get\n */\nexport async function getAccountDetails(): Promise<\n NonNullablePaths<\n GetAccountDetailsResponse,\n | `accountDetails.status`\n | `accountDetails.package._id`\n | `accountDetails.package.group`\n | `accountDetails.package.monthlyQuotaAllocation.campaigns`\n | `accountDetails.package.monthlyQuotaAllocation.emails`\n | `accountDetails.maxCampaignAudienceSize`,\n 5\n >\n> {\n // @ts-ignore\n const { httpClient, sideEffects } = arguments[0] as {\n httpClient: HttpClient;\n sideEffects?: any;\n };\n\n const payload = renameKeysFromSDKRequestToRESTRequest({});\n\n const reqOpts = ambassadorWixEmailMarketingV1AccountDetails.get(payload);\n\n sideEffects?.onSiteCall?.();\n try {\n const result = await httpClient.request(reqOpts);\n sideEffects?.onSuccess?.(result);\n\n return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n } catch (err: any) {\n const transformedError = sdkTransformError(\n err,\n {\n spreadPathsToArguments: {},\n explicitPathsToArguments: {},\n singleArgumentUnchanged: false,\n },\n []\n );\n sideEffects?.onError?.(err);\n\n throw transformedError;\n }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixEmailmarketingApiV1AccountDetailsServiceUrl(\n opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n const domainToMappings = {\n 'manage._base_domain_': [\n {\n srcPath: '/_api/shoutout/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n 'www.wixapis.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n '*.dev.wix-code.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n _: [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n };\n\n return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_email-marketing_account-details';\n\n/** Retrieves email marketing account details. */\nexport function get(payload: object): RequestOptionsFactory<any> {\n function __get({ host }: any) {\n const metadata = {\n entityFqdn: 'wix.email_marketing.v1.account_details',\n method: 'GET' as any,\n methodFqn: 'wix.emailmarketing.api.v1.AccountDetailsService.Get',\n packageName: PACKAGE_NAME,\n migrationOptions: {\n optInTransformResponse: true,\n },\n url: resolveWixEmailmarketingApiV1AccountDetailsServiceUrl({\n protoPath: '/v1/account-details',\n data: payload,\n host,\n }),\n params: toURLSearchParams(payload),\n transformResponse: (payload: any) =>\n transformPaths(payload, [\n {\n transformFn: transformRESTTimestampToSDKTimestamp,\n paths: [\n { path: 'accountDetails.quotaPeriod.dateFrom' },\n { path: 'accountDetails.quotaPeriod.dateTo' },\n ],\n },\n ]),\n };\n\n return metadata;\n }\n\n return __get;\n}\n","import { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport {\n GetAccountDetailsResponse,\n getAccountDetails as universalGetAccountDetails,\n} from './email-marketing-v1-account-details-account-details.universal.js';\n\nexport const __metadata = { PACKAGE_NAME: '@wix/email-marketing' };\n\nexport function getAccountDetails(\n httpClient: HttpClient\n): GetAccountDetailsSignature {\n return () =>\n universalGetAccountDetails(\n // @ts-ignore\n { httpClient }\n );\n}\n\ninterface GetAccountDetailsSignature {\n /**\n * Retrieves email marketing account details.\n */\n (): Promise<\n NonNullablePaths<\n GetAccountDetailsResponse,\n | `accountDetails.status`\n | `accountDetails.package._id`\n | `accountDetails.package.group`\n | `accountDetails.package.monthlyQuotaAllocation.campaigns`\n | `accountDetails.package.monthlyQuotaAllocation.emails`\n | `accountDetails.maxCampaignAudienceSize`,\n 5\n >\n >;\n}\n\nexport {\n AccountDetails,\n Action,\n BillingCycle,\n ComplianceDetails,\n Enum,\n Features,\n GetAccountDetailsRequest,\n GetAccountDetailsResponse,\n GetComplianceDetailsRequest,\n GetComplianceDetailsResponse,\n Package,\n Quota,\n QuotaPeriod,\n Rank,\n RespondRequest,\n RespondResponse,\n SupportTicketData,\n} from './email-marketing-v1-account-details-account-details.universal.js';\n","import { getAccountDetails as publicGetAccountDetails } from './email-marketing-v1-account-details-account-details.public.js';\nimport { createRESTModule } from '@wix/sdk-runtime/rest-modules';\nimport { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';\n\nexport const getAccountDetails: MaybeContext<\n BuildRESTFunction<typeof publicGetAccountDetails> &\n typeof publicGetAccountDetails\n> = /*#__PURE__*/ createRESTModule(publicGetAccountDetails);\n\nexport {\n Enum,\n BillingCycle,\n Rank,\n Action,\n} from './email-marketing-v1-account-details-account-details.universal.js';\nexport {\n AccountDetails,\n Package,\n Quota,\n QuotaPeriod,\n Features,\n GetAccountDetailsRequest,\n GetAccountDetailsResponse,\n GetComplianceDetailsRequest,\n GetComplianceDetailsResponse,\n ComplianceDetails,\n RespondRequest,\n SupportTicketData,\n RespondResponse,\n} from './email-marketing-v1-account-details-account-details.universal.js';\nexport {\n EnumWithLiterals,\n BillingCycleWithLiterals,\n RankWithLiterals,\n ActionWithLiterals,\n} from './email-marketing-v1-account-details-account-details.universal.js';\n"],"mappings":";AAAA,SAAS,kBAAkB,yBAAyB;AACpD;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACJP,SAAS,yBAAyB;AAClC,SAAS,4CAA4C;AACrD,SAAS,sBAAsB;AAC/B,SAAS,kBAAkB;AAI3B,SAAS,sDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,SAAO,WAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAGd,SAAS,IAAI,SAA6C;AAC/D,WAAS,MAAM,EAAE,KAAK,GAAQ;AAC5B,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,QAAQ,kBAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACA,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,sCAAsC;AAAA,YAC9C,EAAE,MAAM,oCAAoC;AAAA,UAC9C;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADpDO,IAAK,OAAL,kBAAKC,UAAL;AACL,EAAAA,MAAA,aAAU;AAEV,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,eAAY;AAEZ,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,wBAAqB;AAXX,SAAAA;AAAA,GAAA;AAwCL,IAAK,eAAL,kBAAKC,kBAAL;AACL,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,eAAY;AACZ,EAAAA,cAAA,YAAS;AACT,EAAAA,cAAA,aAAU;AAJA,SAAAA;AAAA,GAAA;AA8BL,IAAK,OAAL,kBAAKC,UAAL;AAEL,EAAAA,MAAA,SAAM;AAEN,EAAAA,MAAA,UAAO;AAEP,EAAAA,MAAA,SAAM;AANI,SAAAA;AAAA,GAAA;AAoDL,IAAK,SAAL,kBAAKC,YAAL;AACL,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,iBAAc;AACd,EAAAA,QAAA,eAAY;AACZ,EAAAA,QAAA,sBAAmB;AACnB,EAAAA,QAAA,wBAAqB;AANX,SAAAA;AAAA,GAAA;AA2CZ,eAAsB,oBAWpB;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC,CAAC,CAAC;AAExD,QAAM,UAAsD,IAAI,OAAO;AAEvE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,CAAC;AAAA,QAC3B,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC;AAAA,IACH;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;;;AE9NO,SAASC,mBACd,YAC4B;AAC5B,SAAO,MACL;AAAA;AAAA,IAEE,EAAE,WAAW;AAAA,EACf;AACJ;;;ACfA,SAAS,wBAAwB;AAG1B,IAAMC,qBAGK,iCAAiBA,kBAAuB;","names":["payload","Enum","BillingCycle","Rank","Action","getAccountDetails","getAccountDetails"]}
|
|
@@ -64,6 +64,16 @@ interface Features {
|
|
|
64
64
|
removeWixBranding?: boolean;
|
|
65
65
|
scheduling?: boolean;
|
|
66
66
|
}
|
|
67
|
+
declare enum Rank {
|
|
68
|
+
/** No reputation has been established (new site or didn't have enough traffic in the recent time period). */
|
|
69
|
+
NEW = "NEW",
|
|
70
|
+
/** Has traffic and it's quality is good. */
|
|
71
|
+
GOOD = "GOOD",
|
|
72
|
+
/** Has traffic but it's quality is bad. */
|
|
73
|
+
BAD = "BAD"
|
|
74
|
+
}
|
|
75
|
+
/** @enumType */
|
|
76
|
+
type RankWithLiterals = Rank | 'NEW' | 'GOOD' | 'BAD';
|
|
67
77
|
interface GetAccountDetailsRequest {
|
|
68
78
|
}
|
|
69
79
|
interface GetAccountDetailsResponse {
|
|
@@ -134,4 +144,4 @@ interface RespondResponse {
|
|
|
134
144
|
*/
|
|
135
145
|
declare function getAccountDetails(): Promise<NonNullablePaths<GetAccountDetailsResponse, `accountDetails.status` | `accountDetails.package._id` | `accountDetails.package.group` | `accountDetails.package.monthlyQuotaAllocation.campaigns` | `accountDetails.package.monthlyQuotaAllocation.emails` | `accountDetails.maxCampaignAudienceSize`, 5>>;
|
|
136
146
|
|
|
137
|
-
export { type AccountDetails, Action, type ActionWithLiterals, BillingCycle, type BillingCycleWithLiterals, type ComplianceDetails, Enum, type EnumWithLiterals, type Features, type GetAccountDetailsRequest, type GetAccountDetailsResponse, type GetComplianceDetailsRequest, type GetComplianceDetailsResponse, type Package, type Quota, type QuotaPeriod, type RespondRequest, type RespondResponse, type SupportTicketData, getAccountDetails };
|
|
147
|
+
export { type AccountDetails, Action, type ActionWithLiterals, BillingCycle, type BillingCycleWithLiterals, type ComplianceDetails, Enum, type EnumWithLiterals, type Features, type GetAccountDetailsRequest, type GetAccountDetailsResponse, type GetComplianceDetailsRequest, type GetComplianceDetailsResponse, type Package, type Quota, type QuotaPeriod, Rank, type RankWithLiterals, type RespondRequest, type RespondResponse, type SupportTicketData, getAccountDetails };
|
|
@@ -88,6 +88,12 @@ var BillingCycle = /* @__PURE__ */ ((BillingCycle2) => {
|
|
|
88
88
|
BillingCycle2["MONTHLY"] = "MONTHLY";
|
|
89
89
|
return BillingCycle2;
|
|
90
90
|
})(BillingCycle || {});
|
|
91
|
+
var Rank = /* @__PURE__ */ ((Rank2) => {
|
|
92
|
+
Rank2["NEW"] = "NEW";
|
|
93
|
+
Rank2["GOOD"] = "GOOD";
|
|
94
|
+
Rank2["BAD"] = "BAD";
|
|
95
|
+
return Rank2;
|
|
96
|
+
})(Rank || {});
|
|
91
97
|
var Action = /* @__PURE__ */ ((Action2) => {
|
|
92
98
|
Action2["UNKNOWN_ACTION"] = "UNKNOWN_ACTION";
|
|
93
99
|
Action2["AGREE_TO_TERMS"] = "AGREE_TO_TERMS";
|
|
@@ -124,6 +130,7 @@ export {
|
|
|
124
130
|
Action,
|
|
125
131
|
BillingCycle,
|
|
126
132
|
Enum,
|
|
133
|
+
Rank,
|
|
127
134
|
getAccountDetails
|
|
128
135
|
};
|
|
129
136
|
//# sourceMappingURL=index.typings.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/email-marketing-v1-account-details-account-details.universal.ts","../../src/email-marketing-v1-account-details-account-details.http.ts"],"sourcesContent":["import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n renameKeysFromSDKRequestToRESTRequest,\n renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixEmailMarketingV1AccountDetails from './email-marketing-v1-account-details-account-details.http.js';\n\n/**\n * An account can be active or in some state of suspension (warned/suspended/banned).\n * If a user is in a state of suspension they must visit their email marketing account in the dashboard and follow the instructions.\n */\nexport interface AccountDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /** Current premium package information. */\n package?: Package;\n /** Quota period and usage. */\n quotaPeriod?: QuotaPeriod;\n /** Max number of recipients for an email marketing campaign. Exceeding this limit may lead to campaigns being rejected. */\n maxCampaignAudienceSize?: number;\n}\n\nexport enum Enum {\n UNKNOWN = 'UNKNOWN',\n /** Able to use email marketing normally. */\n ACTIVE = 'ACTIVE',\n /** Must explicitly agree to terms of use to activate the account. */\n WARNED = 'WARNED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n SUSPENDED = 'SUSPENDED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n BANNED = 'BANNED',\n /** Must fill out compliance questionnaire to activate the account. */\n SUSPENDED_AUTOLIFT = 'SUSPENDED_AUTOLIFT',\n}\n\n/** @enumType */\nexport type EnumWithLiterals =\n | Enum\n | 'UNKNOWN'\n | 'ACTIVE'\n | 'WARNED'\n | 'SUSPENDED'\n | 'BANNED'\n | 'SUSPENDED_AUTOLIFT';\n\nexport interface Package {\n /** Package ID. */\n _id?: string;\n /** Package group. */\n group?: string;\n /** Allocated quota per month. */\n monthlyQuotaAllocation?: Quota;\n}\n\nexport interface Quota {\n /** Number of allocated marketing campaigns per month (-1 means unlimited). */\n campaigns?: number;\n /** Number of allocated individual emails per month. */\n emails?: number;\n}\n\nexport enum BillingCycle {\n UNKNOWN = 'UNKNOWN',\n TWO_YEARS = 'TWO_YEARS',\n YEARLY = 'YEARLY',\n MONTHLY = 'MONTHLY',\n}\n\n/** @enumType */\nexport type BillingCycleWithLiterals =\n | BillingCycle\n | 'UNKNOWN'\n | 'TWO_YEARS'\n | 'YEARLY'\n | 'MONTHLY';\n\nexport interface QuotaPeriod {\n /** Current quota period start date. */\n dateFrom?: Date | null;\n /** Current quota period end date - after which quota will roll over. */\n dateTo?: Date | null;\n /** Information about allocated quota already used in this period. */\n quotaUsage?: Quota;\n}\n\nexport interface Features {\n multipleSenderDetails?: boolean;\n removeWixBranding?: boolean;\n scheduling?: boolean;\n}\n\nexport interface GetAccountDetailsRequest {}\n\nexport interface GetAccountDetailsResponse {\n /** Current account details. */\n accountDetails?: AccountDetails;\n}\n\nexport interface GetComplianceDetailsRequest {}\n\nexport interface GetComplianceDetailsResponse {\n /** Current compliance details. */\n complianceDetails?: ComplianceDetails;\n}\n\nexport interface ComplianceDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /**\n * Suspension reasons.\n * @maxSize 10\n * @maxLength 100\n */\n suspensionReasons?: string[];\n /**\n * Suspension description.\n * @maxLength 1000\n */\n note?: string | null;\n /**\n * Support ticket id.\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\nexport interface RespondRequest {\n action?: ActionWithLiterals;\n supportTicketData?: SupportTicketData;\n}\n\nexport enum Action {\n UNKNOWN_ACTION = 'UNKNOWN_ACTION',\n AGREE_TO_TERMS = 'AGREE_TO_TERMS',\n OPEN_TICKET = 'OPEN_TICKET',\n FILL_FORM = 'FILL_FORM',\n ANSWER_QUESTIONS = 'ANSWER_QUESTIONS',\n FILL_AUTOLIFT_FORM = 'FILL_AUTOLIFT_FORM',\n}\n\n/** @enumType */\nexport type ActionWithLiterals =\n | Action\n | 'UNKNOWN_ACTION'\n | 'AGREE_TO_TERMS'\n | 'OPEN_TICKET'\n | 'FILL_FORM'\n | 'ANSWER_QUESTIONS'\n | 'FILL_AUTOLIFT_FORM';\n\nexport interface SupportTicketData {\n /** @maxLength 200 */\n subject?: string;\n /** @maxLength 20000 */\n body?: string;\n /** @maxLength 20000 */\n agentReplyBody?: string | null;\n}\n\nexport interface RespondResponse {\n /**\n * ID of the support ticket created (optional).\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\n/**\n * Retrieves email marketing account details.\n * @public\n * @permissionId Shoutout.Manage\n * @applicableIdentity APP\n * @fqn wix.emailmarketing.api.v1.AccountDetailsService.Get\n */\nexport async function getAccountDetails(): Promise<\n NonNullablePaths<\n GetAccountDetailsResponse,\n | `accountDetails.status`\n | `accountDetails.package._id`\n | `accountDetails.package.group`\n | `accountDetails.package.monthlyQuotaAllocation.campaigns`\n | `accountDetails.package.monthlyQuotaAllocation.emails`\n | `accountDetails.maxCampaignAudienceSize`,\n 5\n >\n> {\n // @ts-ignore\n const { httpClient, sideEffects } = arguments[0] as {\n httpClient: HttpClient;\n sideEffects?: any;\n };\n\n const payload = renameKeysFromSDKRequestToRESTRequest({});\n\n const reqOpts = ambassadorWixEmailMarketingV1AccountDetails.get(payload);\n\n sideEffects?.onSiteCall?.();\n try {\n const result = await httpClient.request(reqOpts);\n sideEffects?.onSuccess?.(result);\n\n return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n } catch (err: any) {\n const transformedError = sdkTransformError(\n err,\n {\n spreadPathsToArguments: {},\n explicitPathsToArguments: {},\n singleArgumentUnchanged: false,\n },\n []\n );\n sideEffects?.onError?.(err);\n\n throw transformedError;\n }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixEmailmarketingApiV1AccountDetailsServiceUrl(\n opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n const domainToMappings = {\n 'manage._base_domain_': [\n {\n srcPath: '/_api/shoutout/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n 'www.wixapis.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n '*.dev.wix-code.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n _: [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n };\n\n return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_email-marketing_account-details';\n\n/** Retrieves email marketing account details. */\nexport function get(payload: object): RequestOptionsFactory<any> {\n function __get({ host }: any) {\n const metadata = {\n entityFqdn: 'wix.email_marketing.v1.account_details',\n method: 'GET' as any,\n methodFqn: 'wix.emailmarketing.api.v1.AccountDetailsService.Get',\n packageName: PACKAGE_NAME,\n migrationOptions: {\n optInTransformResponse: true,\n },\n url: resolveWixEmailmarketingApiV1AccountDetailsServiceUrl({\n protoPath: '/v1/account-details',\n data: payload,\n host,\n }),\n params: toURLSearchParams(payload),\n transformResponse: (payload: any) =>\n transformPaths(payload, [\n {\n transformFn: transformRESTTimestampToSDKTimestamp,\n paths: [\n { path: 'accountDetails.quotaPeriod.dateFrom' },\n { path: 'accountDetails.quotaPeriod.dateTo' },\n ],\n },\n ]),\n };\n\n return metadata;\n }\n\n return __get;\n}\n"],"mappings":";AAAA,SAAS,kBAAkB,yBAAyB;AACpD;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACJP,SAAS,yBAAyB;AAClC,SAAS,4CAA4C;AACrD,SAAS,sBAAsB;AAC/B,SAAS,kBAAkB;AAI3B,SAAS,sDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,SAAO,WAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAGd,SAAS,IAAI,SAA6C;AAC/D,WAAS,MAAM,EAAE,KAAK,GAAQ;AAC5B,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,QAAQ,kBAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACA,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,sCAAsC;AAAA,YAC9C,EAAE,MAAM,oCAAoC;AAAA,UAC9C;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADpDO,IAAK,OAAL,kBAAKC,UAAL;AACL,EAAAA,MAAA,aAAU;AAEV,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,eAAY;AAEZ,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,wBAAqB;AAXX,SAAAA;AAAA,GAAA;AAwCL,IAAK,eAAL,kBAAKC,kBAAL;AACL,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,eAAY;AACZ,EAAAA,cAAA,YAAS;AACT,EAAAA,cAAA,aAAU;AAJA,SAAAA;AAAA,GAAA;AAsEL,IAAK,SAAL,kBAAKC,YAAL;AACL,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,iBAAc;AACd,EAAAA,QAAA,eAAY;AACZ,EAAAA,QAAA,sBAAmB;AACnB,EAAAA,QAAA,wBAAqB;AANX,SAAAA;AAAA,GAAA;AA2CZ,eAAsB,oBAWpB;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC,CAAC,CAAC;AAExD,QAAM,UAAsD,IAAI,OAAO;AAEvE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,CAAC;AAAA,QAC3B,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC;AAAA,IACH;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;","names":["payload","Enum","BillingCycle","Action"]}
|
|
1
|
+
{"version":3,"sources":["../../src/email-marketing-v1-account-details-account-details.universal.ts","../../src/email-marketing-v1-account-details-account-details.http.ts"],"sourcesContent":["import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n renameKeysFromSDKRequestToRESTRequest,\n renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixEmailMarketingV1AccountDetails from './email-marketing-v1-account-details-account-details.http.js';\n\n/**\n * An account can be active or in some state of suspension (warned/suspended/banned).\n * If a user is in a state of suspension they must visit their email marketing account in the dashboard and follow the instructions.\n */\nexport interface AccountDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /** Current premium package information. */\n package?: Package;\n /** Quota period and usage. */\n quotaPeriod?: QuotaPeriod;\n /** Max number of recipients for an email marketing campaign. Exceeding this limit may lead to campaigns being rejected. */\n maxCampaignAudienceSize?: number;\n}\n\nexport enum Enum {\n UNKNOWN = 'UNKNOWN',\n /** Able to use email marketing normally. */\n ACTIVE = 'ACTIVE',\n /** Must explicitly agree to terms of use to activate the account. */\n WARNED = 'WARNED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n SUSPENDED = 'SUSPENDED',\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n BANNED = 'BANNED',\n /** Must fill out compliance questionnaire to activate the account. */\n SUSPENDED_AUTOLIFT = 'SUSPENDED_AUTOLIFT',\n}\n\n/** @enumType */\nexport type EnumWithLiterals =\n | Enum\n | 'UNKNOWN'\n | 'ACTIVE'\n | 'WARNED'\n | 'SUSPENDED'\n | 'BANNED'\n | 'SUSPENDED_AUTOLIFT';\n\nexport interface Package {\n /** Package ID. */\n _id?: string;\n /** Package group. */\n group?: string;\n /** Allocated quota per month. */\n monthlyQuotaAllocation?: Quota;\n}\n\nexport interface Quota {\n /** Number of allocated marketing campaigns per month (-1 means unlimited). */\n campaigns?: number;\n /** Number of allocated individual emails per month. */\n emails?: number;\n}\n\nexport enum BillingCycle {\n UNKNOWN = 'UNKNOWN',\n TWO_YEARS = 'TWO_YEARS',\n YEARLY = 'YEARLY',\n MONTHLY = 'MONTHLY',\n}\n\n/** @enumType */\nexport type BillingCycleWithLiterals =\n | BillingCycle\n | 'UNKNOWN'\n | 'TWO_YEARS'\n | 'YEARLY'\n | 'MONTHLY';\n\nexport interface QuotaPeriod {\n /** Current quota period start date. */\n dateFrom?: Date | null;\n /** Current quota period end date - after which quota will roll over. */\n dateTo?: Date | null;\n /** Information about allocated quota already used in this period. */\n quotaUsage?: Quota;\n}\n\nexport interface Features {\n multipleSenderDetails?: boolean;\n removeWixBranding?: boolean;\n scheduling?: boolean;\n}\n\nexport enum Rank {\n /** No reputation has been established (new site or didn't have enough traffic in the recent time period). */\n NEW = 'NEW',\n /** Has traffic and it's quality is good. */\n GOOD = 'GOOD',\n /** Has traffic but it's quality is bad. */\n BAD = 'BAD',\n}\n\n/** @enumType */\nexport type RankWithLiterals = Rank | 'NEW' | 'GOOD' | 'BAD';\n\nexport interface GetAccountDetailsRequest {}\n\nexport interface GetAccountDetailsResponse {\n /** Current account details. */\n accountDetails?: AccountDetails;\n}\n\nexport interface GetComplianceDetailsRequest {}\n\nexport interface GetComplianceDetailsResponse {\n /** Current compliance details. */\n complianceDetails?: ComplianceDetails;\n}\n\nexport interface ComplianceDetails {\n /** Account status. */\n status?: EnumWithLiterals;\n /**\n * Suspension reasons.\n * @maxSize 10\n * @maxLength 100\n */\n suspensionReasons?: string[];\n /**\n * Suspension description.\n * @maxLength 1000\n */\n note?: string | null;\n /**\n * Support ticket id.\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\nexport interface RespondRequest {\n action?: ActionWithLiterals;\n supportTicketData?: SupportTicketData;\n}\n\nexport enum Action {\n UNKNOWN_ACTION = 'UNKNOWN_ACTION',\n AGREE_TO_TERMS = 'AGREE_TO_TERMS',\n OPEN_TICKET = 'OPEN_TICKET',\n FILL_FORM = 'FILL_FORM',\n ANSWER_QUESTIONS = 'ANSWER_QUESTIONS',\n FILL_AUTOLIFT_FORM = 'FILL_AUTOLIFT_FORM',\n}\n\n/** @enumType */\nexport type ActionWithLiterals =\n | Action\n | 'UNKNOWN_ACTION'\n | 'AGREE_TO_TERMS'\n | 'OPEN_TICKET'\n | 'FILL_FORM'\n | 'ANSWER_QUESTIONS'\n | 'FILL_AUTOLIFT_FORM';\n\nexport interface SupportTicketData {\n /** @maxLength 200 */\n subject?: string;\n /** @maxLength 20000 */\n body?: string;\n /** @maxLength 20000 */\n agentReplyBody?: string | null;\n}\n\nexport interface RespondResponse {\n /**\n * ID of the support ticket created (optional).\n * @format GUID\n */\n supportTicketId?: string | null;\n}\n\n/**\n * Retrieves email marketing account details.\n * @public\n * @permissionId Shoutout.Manage\n * @applicableIdentity APP\n * @fqn wix.emailmarketing.api.v1.AccountDetailsService.Get\n */\nexport async function getAccountDetails(): Promise<\n NonNullablePaths<\n GetAccountDetailsResponse,\n | `accountDetails.status`\n | `accountDetails.package._id`\n | `accountDetails.package.group`\n | `accountDetails.package.monthlyQuotaAllocation.campaigns`\n | `accountDetails.package.monthlyQuotaAllocation.emails`\n | `accountDetails.maxCampaignAudienceSize`,\n 5\n >\n> {\n // @ts-ignore\n const { httpClient, sideEffects } = arguments[0] as {\n httpClient: HttpClient;\n sideEffects?: any;\n };\n\n const payload = renameKeysFromSDKRequestToRESTRequest({});\n\n const reqOpts = ambassadorWixEmailMarketingV1AccountDetails.get(payload);\n\n sideEffects?.onSiteCall?.();\n try {\n const result = await httpClient.request(reqOpts);\n sideEffects?.onSuccess?.(result);\n\n return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n } catch (err: any) {\n const transformedError = sdkTransformError(\n err,\n {\n spreadPathsToArguments: {},\n explicitPathsToArguments: {},\n singleArgumentUnchanged: false,\n },\n []\n );\n sideEffects?.onError?.(err);\n\n throw transformedError;\n }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixEmailmarketingApiV1AccountDetailsServiceUrl(\n opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n const domainToMappings = {\n 'manage._base_domain_': [\n {\n srcPath: '/_api/shoutout/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n 'www.wixapis.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n '*.dev.wix-code.com': [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n _: [\n {\n srcPath: '/email-marketing/v1/account-details',\n destPath: '/v1/account-details',\n },\n ],\n };\n\n return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_email-marketing_account-details';\n\n/** Retrieves email marketing account details. */\nexport function get(payload: object): RequestOptionsFactory<any> {\n function __get({ host }: any) {\n const metadata = {\n entityFqdn: 'wix.email_marketing.v1.account_details',\n method: 'GET' as any,\n methodFqn: 'wix.emailmarketing.api.v1.AccountDetailsService.Get',\n packageName: PACKAGE_NAME,\n migrationOptions: {\n optInTransformResponse: true,\n },\n url: resolveWixEmailmarketingApiV1AccountDetailsServiceUrl({\n protoPath: '/v1/account-details',\n data: payload,\n host,\n }),\n params: toURLSearchParams(payload),\n transformResponse: (payload: any) =>\n transformPaths(payload, [\n {\n transformFn: transformRESTTimestampToSDKTimestamp,\n paths: [\n { path: 'accountDetails.quotaPeriod.dateFrom' },\n { path: 'accountDetails.quotaPeriod.dateTo' },\n ],\n },\n ]),\n };\n\n return metadata;\n }\n\n return __get;\n}\n"],"mappings":";AAAA,SAAS,kBAAkB,yBAAyB;AACpD;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACJP,SAAS,yBAAyB;AAClC,SAAS,4CAA4C;AACrD,SAAS,sBAAsB;AAC/B,SAAS,kBAAkB;AAI3B,SAAS,sDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,SAAO,WAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAGd,SAAS,IAAI,SAA6C;AAC/D,WAAS,MAAM,EAAE,KAAK,GAAQ;AAC5B,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,QAAQ,kBAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACA,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,sCAAsC;AAAA,YAC9C,EAAE,MAAM,oCAAoC;AAAA,UAC9C;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADpDO,IAAK,OAAL,kBAAKC,UAAL;AACL,EAAAA,MAAA,aAAU;AAEV,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,eAAY;AAEZ,EAAAA,MAAA,YAAS;AAET,EAAAA,MAAA,wBAAqB;AAXX,SAAAA;AAAA,GAAA;AAwCL,IAAK,eAAL,kBAAKC,kBAAL;AACL,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,eAAY;AACZ,EAAAA,cAAA,YAAS;AACT,EAAAA,cAAA,aAAU;AAJA,SAAAA;AAAA,GAAA;AA8BL,IAAK,OAAL,kBAAKC,UAAL;AAEL,EAAAA,MAAA,SAAM;AAEN,EAAAA,MAAA,UAAO;AAEP,EAAAA,MAAA,SAAM;AANI,SAAAA;AAAA,GAAA;AAoDL,IAAK,SAAL,kBAAKC,YAAL;AACL,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,oBAAiB;AACjB,EAAAA,QAAA,iBAAc;AACd,EAAAA,QAAA,eAAY;AACZ,EAAAA,QAAA,sBAAmB;AACnB,EAAAA,QAAA,wBAAqB;AANX,SAAAA;AAAA,GAAA;AA2CZ,eAAsB,oBAWpB;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC,CAAC,CAAC;AAExD,QAAM,UAAsD,IAAI,OAAO;AAEvE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,CAAC;AAAA,QAC3B,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC;AAAA,IACH;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;","names":["payload","Enum","BillingCycle","Rank","Action"]}
|
package/build/es/meta.d.mts
CHANGED
|
@@ -65,6 +65,16 @@ interface Features {
|
|
|
65
65
|
removeWixBranding?: boolean;
|
|
66
66
|
scheduling?: boolean;
|
|
67
67
|
}
|
|
68
|
+
declare enum Rank {
|
|
69
|
+
/** No reputation has been established (new site or didn't have enough traffic in the recent time period). */
|
|
70
|
+
NEW = "NEW",
|
|
71
|
+
/** Has traffic and it's quality is good. */
|
|
72
|
+
GOOD = "GOOD",
|
|
73
|
+
/** Has traffic but it's quality is bad. */
|
|
74
|
+
BAD = "BAD"
|
|
75
|
+
}
|
|
76
|
+
/** @enumType */
|
|
77
|
+
type RankWithLiterals = Rank | 'NEW' | 'GOOD' | 'BAD';
|
|
68
78
|
interface GetAccountDetailsRequest {
|
|
69
79
|
}
|
|
70
80
|
interface GetAccountDetailsResponse {
|
|
@@ -139,4 +149,4 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
139
149
|
};
|
|
140
150
|
declare function getAccountDetails(): __PublicMethodMetaInfo<'GET', {}, GetAccountDetailsRequest$1, GetAccountDetailsRequest, GetAccountDetailsResponse$1, GetAccountDetailsResponse>;
|
|
141
151
|
|
|
142
|
-
export { type AccountDetails as AccountDetailsOriginal, Action as ActionOriginal, type ActionWithLiterals as ActionWithLiteralsOriginal, BillingCycle as BillingCycleOriginal, type BillingCycleWithLiterals as BillingCycleWithLiteralsOriginal, type ComplianceDetails as ComplianceDetailsOriginal, Enum as EnumOriginal, type EnumWithLiterals as EnumWithLiteralsOriginal, type Features as FeaturesOriginal, type GetAccountDetailsRequest as GetAccountDetailsRequestOriginal, type GetAccountDetailsResponse as GetAccountDetailsResponseOriginal, type GetComplianceDetailsRequest as GetComplianceDetailsRequestOriginal, type GetComplianceDetailsResponse as GetComplianceDetailsResponseOriginal, type Package as PackageOriginal, type Quota as QuotaOriginal, type QuotaPeriod as QuotaPeriodOriginal, type RespondRequest as RespondRequestOriginal, type RespondResponse as RespondResponseOriginal, type SupportTicketData as SupportTicketDataOriginal, type __PublicMethodMetaInfo, getAccountDetails };
|
|
152
|
+
export { type AccountDetails as AccountDetailsOriginal, Action as ActionOriginal, type ActionWithLiterals as ActionWithLiteralsOriginal, BillingCycle as BillingCycleOriginal, type BillingCycleWithLiterals as BillingCycleWithLiteralsOriginal, type ComplianceDetails as ComplianceDetailsOriginal, Enum as EnumOriginal, type EnumWithLiterals as EnumWithLiteralsOriginal, type Features as FeaturesOriginal, type GetAccountDetailsRequest as GetAccountDetailsRequestOriginal, type GetAccountDetailsResponse as GetAccountDetailsResponseOriginal, type GetComplianceDetailsRequest as GetComplianceDetailsRequestOriginal, type GetComplianceDetailsResponse as GetComplianceDetailsResponseOriginal, type Package as PackageOriginal, type Quota as QuotaOriginal, type QuotaPeriod as QuotaPeriodOriginal, Rank as RankOriginal, type RankWithLiterals as RankWithLiteralsOriginal, type RespondRequest as RespondRequestOriginal, type RespondResponse as RespondResponseOriginal, type SupportTicketData as SupportTicketDataOriginal, type __PublicMethodMetaInfo, getAccountDetails };
|
package/build/es/meta.mjs
CHANGED
|
@@ -81,6 +81,12 @@ var BillingCycle = /* @__PURE__ */ ((BillingCycle2) => {
|
|
|
81
81
|
BillingCycle2["MONTHLY"] = "MONTHLY";
|
|
82
82
|
return BillingCycle2;
|
|
83
83
|
})(BillingCycle || {});
|
|
84
|
+
var Rank = /* @__PURE__ */ ((Rank2) => {
|
|
85
|
+
Rank2["NEW"] = "NEW";
|
|
86
|
+
Rank2["GOOD"] = "GOOD";
|
|
87
|
+
Rank2["BAD"] = "BAD";
|
|
88
|
+
return Rank2;
|
|
89
|
+
})(Rank || {});
|
|
84
90
|
var Action = /* @__PURE__ */ ((Action2) => {
|
|
85
91
|
Action2["UNKNOWN_ACTION"] = "UNKNOWN_ACTION";
|
|
86
92
|
Action2["AGREE_TO_TERMS"] = "AGREE_TO_TERMS";
|
|
@@ -114,6 +120,7 @@ export {
|
|
|
114
120
|
Action as ActionOriginal,
|
|
115
121
|
BillingCycle as BillingCycleOriginal,
|
|
116
122
|
Enum as EnumOriginal,
|
|
123
|
+
Rank as RankOriginal,
|
|
117
124
|
getAccountDetails
|
|
118
125
|
};
|
|
119
126
|
//# sourceMappingURL=meta.mjs.map
|