@wix/auto_sdk_email-marketing_account-details 1.0.18 → 1.0.20
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 +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/{email-marketing-v1-account-details-account-details.universal-BXEsgY4R.d.mts → cjs/index.typings.d.ts} +16 -1
- package/build/cjs/index.typings.js +135 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/{internal → cjs}/meta.d.ts +2 -1
- package/build/es/index.d.mts +18 -0
- package/build/es/index.mjs.map +1 -0
- package/build/{email-marketing-v1-account-details-account-details.universal-BXEsgY4R.d.ts → es/index.typings.d.mts} +16 -1
- package/build/es/index.typings.mjs +108 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/{internal → es}/meta.d.mts +2 -1
- package/build/internal/cjs/index.d.ts +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/{email-marketing-v1-account-details-account-details.universal-BXEsgY4R.d.mts → cjs/index.typings.d.ts} +16 -1
- package/build/internal/cjs/index.typings.js +135 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/{meta.d.ts → internal/cjs/meta.d.ts} +2 -1
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/es/index.d.mts +18 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/{email-marketing-v1-account-details-account-details.universal-BXEsgY4R.d.ts → es/index.typings.d.mts} +16 -1
- package/build/internal/es/index.typings.mjs +108 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/{meta.d.mts → internal/es/meta.d.mts} +2 -1
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +11 -11
- package/build/index.d.mts +0 -15
- package/build/index.d.ts +0 -15
- package/build/index.js.map +0 -1
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -15
- package/build/internal/index.d.ts +0 -15
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs.map +0 -1
- package/build/meta.js.map +0 -1
- package/build/meta.mjs.map +0 -1
- /package/build/{index.js → cjs/index.js} +0 -0
- /package/build/{internal → cjs}/meta.js +0 -0
- /package/build/{internal → cjs}/meta.js.map +0 -0
- /package/build/{index.mjs → es/index.mjs} +0 -0
- /package/build/{internal → es}/meta.mjs +0 -0
- /package/build/{internal → es}/meta.mjs.map +0 -0
- /package/build/internal/{index.js → cjs/index.js} +0 -0
- /package/build/{meta.js → internal/cjs/meta.js} +0 -0
- /package/build/internal/{index.mjs → es/index.mjs} +0 -0
- /package/build/{meta.mjs → internal/es/meta.mjs} +0 -0
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
+
import { GetAccountDetailsResponse } from './index.typings.js';
|
|
3
|
+
export { AccountDetails, Action, BillingCycle, ComplianceDetails, Enum, Features, GetAccountDetailsRequest, GetComplianceDetailsRequest, GetComplianceDetailsResponse, Package, Quota, QuotaPeriod, RespondRequest, RespondResponse, SupportTicketData } from './index.typings.js';
|
|
4
|
+
|
|
5
|
+
type AccountDetailsNonNullablePaths = `status` | `package._id` | `package.group` | `package.monthlyQuotaAllocation.campaigns` | `package.monthlyQuotaAllocation.emails` | `quotaPeriod.quotaUsage.campaigns` | `quotaPeriod.quotaUsage.emails`;
|
|
6
|
+
declare function getAccountDetails$1(httpClient: HttpClient): GetAccountDetailsSignature;
|
|
7
|
+
interface GetAccountDetailsSignature {
|
|
8
|
+
/**
|
|
9
|
+
* Retrieves email marketing account details.
|
|
10
|
+
*/
|
|
11
|
+
(): Promise<NonNullablePaths<GetAccountDetailsResponse, {
|
|
12
|
+
[P in AccountDetailsNonNullablePaths]: `accountDetails.${P}`;
|
|
13
|
+
}[AccountDetailsNonNullablePaths]>>;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
declare const getAccountDetails: MaybeContext<BuildRESTFunction<typeof getAccountDetails$1> & typeof getAccountDetails$1>;
|
|
17
|
+
|
|
18
|
+
export { GetAccountDetailsResponse, getAccountDetails };
|
|
@@ -0,0 +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}\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\ntype AccountDetailsNonNullablePaths =\n | `status`\n | `package._id`\n | `package.group`\n | `package.monthlyQuotaAllocation.campaigns`\n | `package.monthlyQuotaAllocation.emails`\n | `quotaPeriod.quotaUsage.campaigns`\n | `quotaPeriod.quotaUsage.emails`;\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 {\n [P in AccountDetailsNonNullablePaths]: `accountDetails.${P}`;\n }[AccountDetailsNonNullablePaths]\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 };\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 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\ntype AccountDetailsNonNullablePaths =\n | `status`\n | `package._id`\n | `package.group`\n | `package.monthlyQuotaAllocation.campaigns`\n | `package.monthlyQuotaAllocation.emails`\n | `quotaPeriod.quotaUsage.campaigns`\n | `quotaPeriod.quotaUsage.emails`;\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 {\n [P in AccountDetailsNonNullablePaths]: `accountDetails.${P}`;\n }[AccountDetailsNonNullablePaths]\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';\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,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,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;;;ADjCO,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;AAoDZ,eAAsB,oBAOpB;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;;;AE5MO,SAASC,mBACd,YAC4B;AAC5B,SAAO,MACL;AAAA;AAAA,IAEE,EAAE,WAAW;AAAA,EACf;AACJ;;;ACxBA,IAAAC,uBAAiC;AAG1B,IAAMC,qBAGK,2DAAiBA,kBAAuB;","names":["getAccountDetails","import_rest_modules","payload","Enum","BillingCycle","Action","sdkTransformError","getAccountDetails","import_rest_modules","getAccountDetails"]}
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
4
|
* An account can be active or in some state of suspension (warned/suspended/banned).
|
|
3
5
|
* If a user is in a state of suspension they must visit their email marketing account in the dashboard and follow the instructions.
|
|
@@ -45,6 +47,8 @@ declare enum BillingCycle {
|
|
|
45
47
|
YEARLY = "YEARLY",
|
|
46
48
|
MONTHLY = "MONTHLY"
|
|
47
49
|
}
|
|
50
|
+
/** @enumType */
|
|
51
|
+
type BillingCycleWithLiterals = BillingCycle | 'UNKNOWN' | 'TWO_YEARS' | 'YEARLY' | 'MONTHLY';
|
|
48
52
|
interface QuotaPeriod {
|
|
49
53
|
/** Current quota period start date. */
|
|
50
54
|
dateFrom?: Date | null;
|
|
@@ -119,5 +123,16 @@ interface RespondResponse {
|
|
|
119
123
|
*/
|
|
120
124
|
supportTicketId?: string | null;
|
|
121
125
|
}
|
|
126
|
+
type AccountDetailsNonNullablePaths = `status` | `package._id` | `package.group` | `package.monthlyQuotaAllocation.campaigns` | `package.monthlyQuotaAllocation.emails` | `quotaPeriod.quotaUsage.campaigns` | `quotaPeriod.quotaUsage.emails`;
|
|
127
|
+
/**
|
|
128
|
+
* Retrieves email marketing account details.
|
|
129
|
+
* @public
|
|
130
|
+
* @permissionId Shoutout.Manage
|
|
131
|
+
* @applicableIdentity APP
|
|
132
|
+
* @fqn wix.emailmarketing.api.v1.AccountDetailsService.Get
|
|
133
|
+
*/
|
|
134
|
+
declare function getAccountDetails(): Promise<NonNullablePaths<GetAccountDetailsResponse, {
|
|
135
|
+
[P in AccountDetailsNonNullablePaths]: `accountDetails.${P}`;
|
|
136
|
+
}[AccountDetailsNonNullablePaths]>>;
|
|
122
137
|
|
|
123
|
-
export { Action
|
|
138
|
+
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 };
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// index.typings.ts
|
|
21
|
+
var index_typings_exports = {};
|
|
22
|
+
__export(index_typings_exports, {
|
|
23
|
+
Action: () => Action,
|
|
24
|
+
BillingCycle: () => BillingCycle,
|
|
25
|
+
Enum: () => Enum,
|
|
26
|
+
getAccountDetails: () => getAccountDetails
|
|
27
|
+
});
|
|
28
|
+
module.exports = __toCommonJS(index_typings_exports);
|
|
29
|
+
|
|
30
|
+
// src/email-marketing-v1-account-details-account-details.universal.ts
|
|
31
|
+
var import_transform_error = require("@wix/sdk-runtime/transform-error");
|
|
32
|
+
var import_rename_all_nested_keys = require("@wix/sdk-runtime/rename-all-nested-keys");
|
|
33
|
+
|
|
34
|
+
// src/email-marketing-v1-account-details-account-details.http.ts
|
|
35
|
+
var import_rest_modules = require("@wix/sdk-runtime/rest-modules");
|
|
36
|
+
var import_timestamp = require("@wix/sdk-runtime/transformations/timestamp");
|
|
37
|
+
var import_transform_paths = require("@wix/sdk-runtime/transformations/transform-paths");
|
|
38
|
+
var import_rest_modules2 = require("@wix/sdk-runtime/rest-modules");
|
|
39
|
+
function resolveWixEmailmarketingApiV1AccountDetailsServiceUrl(opts) {
|
|
40
|
+
const domainToMappings = {
|
|
41
|
+
"manage._base_domain_": [
|
|
42
|
+
{
|
|
43
|
+
srcPath: "/_api/shoutout/v1/account-details",
|
|
44
|
+
destPath: "/v1/account-details"
|
|
45
|
+
}
|
|
46
|
+
]
|
|
47
|
+
};
|
|
48
|
+
return (0, import_rest_modules2.resolveUrl)(Object.assign(opts, { domainToMappings }));
|
|
49
|
+
}
|
|
50
|
+
var PACKAGE_NAME = "@wix/auto_sdk_email-marketing_account-details";
|
|
51
|
+
function get(payload) {
|
|
52
|
+
function __get({ host }) {
|
|
53
|
+
const metadata = {
|
|
54
|
+
entityFqdn: "wix.email_marketing.v1.account_details",
|
|
55
|
+
method: "GET",
|
|
56
|
+
methodFqn: "wix.emailmarketing.api.v1.AccountDetailsService.Get",
|
|
57
|
+
packageName: PACKAGE_NAME,
|
|
58
|
+
url: resolveWixEmailmarketingApiV1AccountDetailsServiceUrl({
|
|
59
|
+
protoPath: "/v1/account-details",
|
|
60
|
+
data: payload,
|
|
61
|
+
host
|
|
62
|
+
}),
|
|
63
|
+
params: (0, import_rest_modules.toURLSearchParams)(payload),
|
|
64
|
+
transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
|
|
65
|
+
{
|
|
66
|
+
transformFn: import_timestamp.transformRESTTimestampToSDKTimestamp,
|
|
67
|
+
paths: [
|
|
68
|
+
{ path: "accountDetails.quotaPeriod.dateFrom" },
|
|
69
|
+
{ path: "accountDetails.quotaPeriod.dateTo" }
|
|
70
|
+
]
|
|
71
|
+
}
|
|
72
|
+
])
|
|
73
|
+
};
|
|
74
|
+
return metadata;
|
|
75
|
+
}
|
|
76
|
+
return __get;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
// src/email-marketing-v1-account-details-account-details.universal.ts
|
|
80
|
+
var Enum = /* @__PURE__ */ ((Enum2) => {
|
|
81
|
+
Enum2["UNKNOWN"] = "UNKNOWN";
|
|
82
|
+
Enum2["ACTIVE"] = "ACTIVE";
|
|
83
|
+
Enum2["WARNED"] = "WARNED";
|
|
84
|
+
Enum2["SUSPENDED"] = "SUSPENDED";
|
|
85
|
+
Enum2["BANNED"] = "BANNED";
|
|
86
|
+
Enum2["SUSPENDED_AUTOLIFT"] = "SUSPENDED_AUTOLIFT";
|
|
87
|
+
return Enum2;
|
|
88
|
+
})(Enum || {});
|
|
89
|
+
var BillingCycle = /* @__PURE__ */ ((BillingCycle2) => {
|
|
90
|
+
BillingCycle2["UNKNOWN"] = "UNKNOWN";
|
|
91
|
+
BillingCycle2["TWO_YEARS"] = "TWO_YEARS";
|
|
92
|
+
BillingCycle2["YEARLY"] = "YEARLY";
|
|
93
|
+
BillingCycle2["MONTHLY"] = "MONTHLY";
|
|
94
|
+
return BillingCycle2;
|
|
95
|
+
})(BillingCycle || {});
|
|
96
|
+
var Action = /* @__PURE__ */ ((Action2) => {
|
|
97
|
+
Action2["UNKNOWN_ACTION"] = "UNKNOWN_ACTION";
|
|
98
|
+
Action2["AGREE_TO_TERMS"] = "AGREE_TO_TERMS";
|
|
99
|
+
Action2["OPEN_TICKET"] = "OPEN_TICKET";
|
|
100
|
+
Action2["FILL_FORM"] = "FILL_FORM";
|
|
101
|
+
Action2["ANSWER_QUESTIONS"] = "ANSWER_QUESTIONS";
|
|
102
|
+
Action2["FILL_AUTOLIFT_FORM"] = "FILL_AUTOLIFT_FORM";
|
|
103
|
+
return Action2;
|
|
104
|
+
})(Action || {});
|
|
105
|
+
async function getAccountDetails() {
|
|
106
|
+
const { httpClient, sideEffects } = arguments[0];
|
|
107
|
+
const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({});
|
|
108
|
+
const reqOpts = get(payload);
|
|
109
|
+
sideEffects?.onSiteCall?.();
|
|
110
|
+
try {
|
|
111
|
+
const result = await httpClient.request(reqOpts);
|
|
112
|
+
sideEffects?.onSuccess?.(result);
|
|
113
|
+
return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
|
|
114
|
+
} catch (err) {
|
|
115
|
+
const transformedError = (0, import_transform_error.transformError)(
|
|
116
|
+
err,
|
|
117
|
+
{
|
|
118
|
+
spreadPathsToArguments: {},
|
|
119
|
+
explicitPathsToArguments: {},
|
|
120
|
+
singleArgumentUnchanged: false
|
|
121
|
+
},
|
|
122
|
+
[]
|
|
123
|
+
);
|
|
124
|
+
sideEffects?.onError?.(err);
|
|
125
|
+
throw transformedError;
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
129
|
+
0 && (module.exports = {
|
|
130
|
+
Action,
|
|
131
|
+
BillingCycle,
|
|
132
|
+
Enum,
|
|
133
|
+
getAccountDetails
|
|
134
|
+
});
|
|
135
|
+
//# sourceMappingURL=index.typings.js.map
|
|
@@ -0,0 +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}\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\ntype AccountDetailsNonNullablePaths =\n | `status`\n | `package._id`\n | `package.group`\n | `package.monthlyQuotaAllocation.campaigns`\n | `package.monthlyQuotaAllocation.emails`\n | `quotaPeriod.quotaUsage.campaigns`\n | `quotaPeriod.quotaUsage.emails`;\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 {\n [P in AccountDetailsNonNullablePaths]: `accountDetails.${P}`;\n }[AccountDetailsNonNullablePaths]\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 };\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 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,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,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;;;ADjCO,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;AAoDZ,eAAsB,oBAOpB;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,4 +1,5 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { GetAccountDetailsRequest as GetAccountDetailsRequest$1, GetAccountDetailsResponse as GetAccountDetailsResponse$1 } from './index.typings.js';
|
|
2
|
+
import '@wix/sdk-types';
|
|
2
3
|
|
|
3
4
|
/**
|
|
4
5
|
* An account can be active or in some state of suspension (warned/suspended/banned).
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
+
import { GetAccountDetailsResponse } from './index.typings.mjs';
|
|
3
|
+
export { AccountDetails, Action, BillingCycle, ComplianceDetails, Enum, Features, GetAccountDetailsRequest, GetComplianceDetailsRequest, GetComplianceDetailsResponse, Package, Quota, QuotaPeriod, RespondRequest, RespondResponse, SupportTicketData } from './index.typings.mjs';
|
|
4
|
+
|
|
5
|
+
type AccountDetailsNonNullablePaths = `status` | `package._id` | `package.group` | `package.monthlyQuotaAllocation.campaigns` | `package.monthlyQuotaAllocation.emails` | `quotaPeriod.quotaUsage.campaigns` | `quotaPeriod.quotaUsage.emails`;
|
|
6
|
+
declare function getAccountDetails$1(httpClient: HttpClient): GetAccountDetailsSignature;
|
|
7
|
+
interface GetAccountDetailsSignature {
|
|
8
|
+
/**
|
|
9
|
+
* Retrieves email marketing account details.
|
|
10
|
+
*/
|
|
11
|
+
(): Promise<NonNullablePaths<GetAccountDetailsResponse, {
|
|
12
|
+
[P in AccountDetailsNonNullablePaths]: `accountDetails.${P}`;
|
|
13
|
+
}[AccountDetailsNonNullablePaths]>>;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
declare const getAccountDetails: MaybeContext<BuildRESTFunction<typeof getAccountDetails$1> & typeof getAccountDetails$1>;
|
|
17
|
+
|
|
18
|
+
export { GetAccountDetailsResponse, getAccountDetails };
|
|
@@ -0,0 +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}\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\ntype AccountDetailsNonNullablePaths =\n | `status`\n | `package._id`\n | `package.group`\n | `package.monthlyQuotaAllocation.campaigns`\n | `package.monthlyQuotaAllocation.emails`\n | `quotaPeriod.quotaUsage.campaigns`\n | `quotaPeriod.quotaUsage.emails`;\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 {\n [P in AccountDetailsNonNullablePaths]: `accountDetails.${P}`;\n }[AccountDetailsNonNullablePaths]\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 };\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 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\ntype AccountDetailsNonNullablePaths =\n | `status`\n | `package._id`\n | `package.group`\n | `package.monthlyQuotaAllocation.campaigns`\n | `package.monthlyQuotaAllocation.emails`\n | `quotaPeriod.quotaUsage.campaigns`\n | `quotaPeriod.quotaUsage.emails`;\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 {\n [P in AccountDetailsNonNullablePaths]: `accountDetails.${P}`;\n }[AccountDetailsNonNullablePaths]\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';\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,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,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;;;ADjCO,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;AAoDZ,eAAsB,oBAOpB;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;;;AE5MO,SAASC,mBACd,YAC4B;AAC5B,SAAO,MACL;AAAA;AAAA,IAEE,EAAE,WAAW;AAAA,EACf;AACJ;;;ACxBA,SAAS,wBAAwB;AAG1B,IAAMC,qBAGK,iCAAiBA,kBAAuB;","names":["payload","Enum","BillingCycle","Action","getAccountDetails","getAccountDetails"]}
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
4
|
* An account can be active or in some state of suspension (warned/suspended/banned).
|
|
3
5
|
* If a user is in a state of suspension they must visit their email marketing account in the dashboard and follow the instructions.
|
|
@@ -45,6 +47,8 @@ declare enum BillingCycle {
|
|
|
45
47
|
YEARLY = "YEARLY",
|
|
46
48
|
MONTHLY = "MONTHLY"
|
|
47
49
|
}
|
|
50
|
+
/** @enumType */
|
|
51
|
+
type BillingCycleWithLiterals = BillingCycle | 'UNKNOWN' | 'TWO_YEARS' | 'YEARLY' | 'MONTHLY';
|
|
48
52
|
interface QuotaPeriod {
|
|
49
53
|
/** Current quota period start date. */
|
|
50
54
|
dateFrom?: Date | null;
|
|
@@ -119,5 +123,16 @@ interface RespondResponse {
|
|
|
119
123
|
*/
|
|
120
124
|
supportTicketId?: string | null;
|
|
121
125
|
}
|
|
126
|
+
type AccountDetailsNonNullablePaths = `status` | `package._id` | `package.group` | `package.monthlyQuotaAllocation.campaigns` | `package.monthlyQuotaAllocation.emails` | `quotaPeriod.quotaUsage.campaigns` | `quotaPeriod.quotaUsage.emails`;
|
|
127
|
+
/**
|
|
128
|
+
* Retrieves email marketing account details.
|
|
129
|
+
* @public
|
|
130
|
+
* @permissionId Shoutout.Manage
|
|
131
|
+
* @applicableIdentity APP
|
|
132
|
+
* @fqn wix.emailmarketing.api.v1.AccountDetailsService.Get
|
|
133
|
+
*/
|
|
134
|
+
declare function getAccountDetails(): Promise<NonNullablePaths<GetAccountDetailsResponse, {
|
|
135
|
+
[P in AccountDetailsNonNullablePaths]: `accountDetails.${P}`;
|
|
136
|
+
}[AccountDetailsNonNullablePaths]>>;
|
|
122
137
|
|
|
123
|
-
export { Action
|
|
138
|
+
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 };
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
// src/email-marketing-v1-account-details-account-details.universal.ts
|
|
2
|
+
import { transformError as sdkTransformError } from "@wix/sdk-runtime/transform-error";
|
|
3
|
+
import {
|
|
4
|
+
renameKeysFromSDKRequestToRESTRequest,
|
|
5
|
+
renameKeysFromRESTResponseToSDKResponse
|
|
6
|
+
} from "@wix/sdk-runtime/rename-all-nested-keys";
|
|
7
|
+
|
|
8
|
+
// src/email-marketing-v1-account-details-account-details.http.ts
|
|
9
|
+
import { toURLSearchParams } from "@wix/sdk-runtime/rest-modules";
|
|
10
|
+
import { transformRESTTimestampToSDKTimestamp } from "@wix/sdk-runtime/transformations/timestamp";
|
|
11
|
+
import { transformPaths } from "@wix/sdk-runtime/transformations/transform-paths";
|
|
12
|
+
import { resolveUrl } from "@wix/sdk-runtime/rest-modules";
|
|
13
|
+
function resolveWixEmailmarketingApiV1AccountDetailsServiceUrl(opts) {
|
|
14
|
+
const domainToMappings = {
|
|
15
|
+
"manage._base_domain_": [
|
|
16
|
+
{
|
|
17
|
+
srcPath: "/_api/shoutout/v1/account-details",
|
|
18
|
+
destPath: "/v1/account-details"
|
|
19
|
+
}
|
|
20
|
+
]
|
|
21
|
+
};
|
|
22
|
+
return resolveUrl(Object.assign(opts, { domainToMappings }));
|
|
23
|
+
}
|
|
24
|
+
var PACKAGE_NAME = "@wix/auto_sdk_email-marketing_account-details";
|
|
25
|
+
function get(payload) {
|
|
26
|
+
function __get({ host }) {
|
|
27
|
+
const metadata = {
|
|
28
|
+
entityFqdn: "wix.email_marketing.v1.account_details",
|
|
29
|
+
method: "GET",
|
|
30
|
+
methodFqn: "wix.emailmarketing.api.v1.AccountDetailsService.Get",
|
|
31
|
+
packageName: PACKAGE_NAME,
|
|
32
|
+
url: resolveWixEmailmarketingApiV1AccountDetailsServiceUrl({
|
|
33
|
+
protoPath: "/v1/account-details",
|
|
34
|
+
data: payload,
|
|
35
|
+
host
|
|
36
|
+
}),
|
|
37
|
+
params: toURLSearchParams(payload),
|
|
38
|
+
transformResponse: (payload2) => transformPaths(payload2, [
|
|
39
|
+
{
|
|
40
|
+
transformFn: transformRESTTimestampToSDKTimestamp,
|
|
41
|
+
paths: [
|
|
42
|
+
{ path: "accountDetails.quotaPeriod.dateFrom" },
|
|
43
|
+
{ path: "accountDetails.quotaPeriod.dateTo" }
|
|
44
|
+
]
|
|
45
|
+
}
|
|
46
|
+
])
|
|
47
|
+
};
|
|
48
|
+
return metadata;
|
|
49
|
+
}
|
|
50
|
+
return __get;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
// src/email-marketing-v1-account-details-account-details.universal.ts
|
|
54
|
+
var Enum = /* @__PURE__ */ ((Enum2) => {
|
|
55
|
+
Enum2["UNKNOWN"] = "UNKNOWN";
|
|
56
|
+
Enum2["ACTIVE"] = "ACTIVE";
|
|
57
|
+
Enum2["WARNED"] = "WARNED";
|
|
58
|
+
Enum2["SUSPENDED"] = "SUSPENDED";
|
|
59
|
+
Enum2["BANNED"] = "BANNED";
|
|
60
|
+
Enum2["SUSPENDED_AUTOLIFT"] = "SUSPENDED_AUTOLIFT";
|
|
61
|
+
return Enum2;
|
|
62
|
+
})(Enum || {});
|
|
63
|
+
var BillingCycle = /* @__PURE__ */ ((BillingCycle2) => {
|
|
64
|
+
BillingCycle2["UNKNOWN"] = "UNKNOWN";
|
|
65
|
+
BillingCycle2["TWO_YEARS"] = "TWO_YEARS";
|
|
66
|
+
BillingCycle2["YEARLY"] = "YEARLY";
|
|
67
|
+
BillingCycle2["MONTHLY"] = "MONTHLY";
|
|
68
|
+
return BillingCycle2;
|
|
69
|
+
})(BillingCycle || {});
|
|
70
|
+
var Action = /* @__PURE__ */ ((Action2) => {
|
|
71
|
+
Action2["UNKNOWN_ACTION"] = "UNKNOWN_ACTION";
|
|
72
|
+
Action2["AGREE_TO_TERMS"] = "AGREE_TO_TERMS";
|
|
73
|
+
Action2["OPEN_TICKET"] = "OPEN_TICKET";
|
|
74
|
+
Action2["FILL_FORM"] = "FILL_FORM";
|
|
75
|
+
Action2["ANSWER_QUESTIONS"] = "ANSWER_QUESTIONS";
|
|
76
|
+
Action2["FILL_AUTOLIFT_FORM"] = "FILL_AUTOLIFT_FORM";
|
|
77
|
+
return Action2;
|
|
78
|
+
})(Action || {});
|
|
79
|
+
async function getAccountDetails() {
|
|
80
|
+
const { httpClient, sideEffects } = arguments[0];
|
|
81
|
+
const payload = renameKeysFromSDKRequestToRESTRequest({});
|
|
82
|
+
const reqOpts = get(payload);
|
|
83
|
+
sideEffects?.onSiteCall?.();
|
|
84
|
+
try {
|
|
85
|
+
const result = await httpClient.request(reqOpts);
|
|
86
|
+
sideEffects?.onSuccess?.(result);
|
|
87
|
+
return renameKeysFromRESTResponseToSDKResponse(result.data);
|
|
88
|
+
} catch (err) {
|
|
89
|
+
const transformedError = sdkTransformError(
|
|
90
|
+
err,
|
|
91
|
+
{
|
|
92
|
+
spreadPathsToArguments: {},
|
|
93
|
+
explicitPathsToArguments: {},
|
|
94
|
+
singleArgumentUnchanged: false
|
|
95
|
+
},
|
|
96
|
+
[]
|
|
97
|
+
);
|
|
98
|
+
sideEffects?.onError?.(err);
|
|
99
|
+
throw transformedError;
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
export {
|
|
103
|
+
Action,
|
|
104
|
+
BillingCycle,
|
|
105
|
+
Enum,
|
|
106
|
+
getAccountDetails
|
|
107
|
+
};
|
|
108
|
+
//# sourceMappingURL=index.typings.mjs.map
|
|
@@ -0,0 +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}\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\ntype AccountDetailsNonNullablePaths =\n | `status`\n | `package._id`\n | `package.group`\n | `package.monthlyQuotaAllocation.campaigns`\n | `package.monthlyQuotaAllocation.emails`\n | `quotaPeriod.quotaUsage.campaigns`\n | `quotaPeriod.quotaUsage.emails`;\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 {\n [P in AccountDetailsNonNullablePaths]: `accountDetails.${P}`;\n }[AccountDetailsNonNullablePaths]\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 };\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 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,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,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;;;ADjCO,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;AAoDZ,eAAsB,oBAOpB;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,4 +1,5 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { GetAccountDetailsRequest as GetAccountDetailsRequest$1, GetAccountDetailsResponse as GetAccountDetailsResponse$1 } from './index.typings.mjs';
|
|
2
|
+
import '@wix/sdk-types';
|
|
2
3
|
|
|
3
4
|
/**
|
|
4
5
|
* An account can be active or in some state of suspension (warned/suspended/banned).
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
+
import { GetAccountDetailsResponse } from './index.typings.js';
|
|
3
|
+
export { AccountDetails, Action, BillingCycle, ComplianceDetails, Enum, Features, GetAccountDetailsRequest, GetComplianceDetailsRequest, GetComplianceDetailsResponse, Package, Quota, QuotaPeriod, RespondRequest, RespondResponse, SupportTicketData } from './index.typings.js';
|
|
4
|
+
|
|
5
|
+
type AccountDetailsNonNullablePaths = `status` | `package._id` | `package.group` | `package.monthlyQuotaAllocation.campaigns` | `package.monthlyQuotaAllocation.emails` | `quotaPeriod.quotaUsage.campaigns` | `quotaPeriod.quotaUsage.emails`;
|
|
6
|
+
declare function getAccountDetails$1(httpClient: HttpClient): GetAccountDetailsSignature;
|
|
7
|
+
interface GetAccountDetailsSignature {
|
|
8
|
+
/**
|
|
9
|
+
* Retrieves email marketing account details.
|
|
10
|
+
*/
|
|
11
|
+
(): Promise<NonNullablePaths<GetAccountDetailsResponse, {
|
|
12
|
+
[P in AccountDetailsNonNullablePaths]: `accountDetails.${P}`;
|
|
13
|
+
}[AccountDetailsNonNullablePaths]>>;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
declare const getAccountDetails: MaybeContext<BuildRESTFunction<typeof getAccountDetails$1> & typeof getAccountDetails$1>;
|
|
17
|
+
|
|
18
|
+
export { GetAccountDetailsResponse, getAccountDetails };
|
|
@@ -0,0 +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}\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\ntype AccountDetailsNonNullablePaths =\n | `status`\n | `package._id`\n | `package.group`\n | `package.monthlyQuotaAllocation.campaigns`\n | `package.monthlyQuotaAllocation.emails`\n | `quotaPeriod.quotaUsage.campaigns`\n | `quotaPeriod.quotaUsage.emails`;\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 {\n [P in AccountDetailsNonNullablePaths]: `accountDetails.${P}`;\n }[AccountDetailsNonNullablePaths]\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 };\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 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\ntype AccountDetailsNonNullablePaths =\n | `status`\n | `package._id`\n | `package.group`\n | `package.monthlyQuotaAllocation.campaigns`\n | `package.monthlyQuotaAllocation.emails`\n | `quotaPeriod.quotaUsage.campaigns`\n | `quotaPeriod.quotaUsage.emails`;\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 {\n [P in AccountDetailsNonNullablePaths]: `accountDetails.${P}`;\n }[AccountDetailsNonNullablePaths]\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';\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,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,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;;;ADjCO,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;AAoDZ,eAAsB,oBAOpB;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;;;AE5MO,SAASC,mBACd,YAC4B;AAC5B,SAAO,MACL;AAAA;AAAA,IAEE,EAAE,WAAW;AAAA,EACf;AACJ;;;ACxBA,IAAAC,uBAAiC;AAG1B,IAAMC,qBAGK,2DAAiBA,kBAAuB;","names":["getAccountDetails","import_rest_modules","payload","Enum","BillingCycle","Action","sdkTransformError","getAccountDetails","import_rest_modules","getAccountDetails"]}
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
4
|
* An account can be active or in some state of suspension (warned/suspended/banned).
|
|
3
5
|
* If a user is in a state of suspension they must visit their email marketing account in the dashboard and follow the instructions.
|
|
@@ -45,6 +47,8 @@ declare enum BillingCycle {
|
|
|
45
47
|
YEARLY = "YEARLY",
|
|
46
48
|
MONTHLY = "MONTHLY"
|
|
47
49
|
}
|
|
50
|
+
/** @enumType */
|
|
51
|
+
type BillingCycleWithLiterals = BillingCycle | 'UNKNOWN' | 'TWO_YEARS' | 'YEARLY' | 'MONTHLY';
|
|
48
52
|
interface QuotaPeriod {
|
|
49
53
|
/** Current quota period start date. */
|
|
50
54
|
dateFrom?: Date | null;
|
|
@@ -119,5 +123,16 @@ interface RespondResponse {
|
|
|
119
123
|
*/
|
|
120
124
|
supportTicketId?: string | null;
|
|
121
125
|
}
|
|
126
|
+
type AccountDetailsNonNullablePaths = `status` | `package._id` | `package.group` | `package.monthlyQuotaAllocation.campaigns` | `package.monthlyQuotaAllocation.emails` | `quotaPeriod.quotaUsage.campaigns` | `quotaPeriod.quotaUsage.emails`;
|
|
127
|
+
/**
|
|
128
|
+
* Retrieves email marketing account details.
|
|
129
|
+
* @public
|
|
130
|
+
* @permissionId Shoutout.Manage
|
|
131
|
+
* @applicableIdentity APP
|
|
132
|
+
* @fqn wix.emailmarketing.api.v1.AccountDetailsService.Get
|
|
133
|
+
*/
|
|
134
|
+
declare function getAccountDetails(): Promise<NonNullablePaths<GetAccountDetailsResponse, {
|
|
135
|
+
[P in AccountDetailsNonNullablePaths]: `accountDetails.${P}`;
|
|
136
|
+
}[AccountDetailsNonNullablePaths]>>;
|
|
122
137
|
|
|
123
|
-
export { Action
|
|
138
|
+
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 };
|