hostinger-api-sdk 1.31.0 → 1.33.0
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/README.md +2 -2
- package/api.ts +1440 -52
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +1045 -15
- package/dist/api.js +710 -9
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +1045 -15
- package/dist/esm/api.js +693 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ReachCampaignsApi.md +190 -0
- package/docs/ReachFormsApi.md +182 -0
- package/docs/ReachListCampaignsV1200Response.md +22 -0
- package/docs/ReachListFormsV1200Response.md +22 -0
- package/docs/ReachProfilesApi.md +54 -0
- package/docs/ReachV1CampaignsCampaignDeliveryResource.md +25 -0
- package/docs/ReachV1CampaignsCampaignDetailsResource.md +52 -0
- package/docs/ReachV1CampaignsCampaignResource.md +44 -0
- package/docs/ReachV1CampaignsCampaignStatisticsResource.md +49 -0
- package/docs/ReachV1CampaignsCampaignSummaryStatisticsResource.md +27 -0
- package/docs/ReachV1FormsFormDetailsResource.md +34 -0
- package/docs/ReachV1FormsFormResource.md +32 -0
- package/docs/ReachV1FormsFormTagResource.md +25 -0
- package/docs/ReachV1FormsFormTemplateDetailsResource.md +25 -0
- package/docs/ReachV1FormsFormTemplateResource.md +23 -0
- package/docs/ReachV1ProfilesPlanLimitUsageResource.md +25 -0
- package/docs/ReachV1ProfilesPlanLimitsResource.md +29 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.35.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -390,6 +390,30 @@ export const ReachV1AutomationsStepsAutomationStepResourceValueEnum = {
|
|
|
390
390
|
Decision: 'decision',
|
|
391
391
|
Delay: 'delay'
|
|
392
392
|
};
|
|
393
|
+
export const ReachV1CampaignsCampaignDetailsResourceStatusEnum = {
|
|
394
|
+
Draft: 'draft',
|
|
395
|
+
Scheduled: 'scheduled',
|
|
396
|
+
Sending: 'sending',
|
|
397
|
+
Publish: 'publish',
|
|
398
|
+
Failed: 'failed'
|
|
399
|
+
};
|
|
400
|
+
export const ReachV1CampaignsCampaignDetailsResourceTypeEnum = {
|
|
401
|
+
Campaign: 'campaign',
|
|
402
|
+
Automation: 'automation',
|
|
403
|
+
DoubleOptIn: 'double_opt_in'
|
|
404
|
+
};
|
|
405
|
+
export const ReachV1CampaignsCampaignResourceStatusEnum = {
|
|
406
|
+
Draft: 'draft',
|
|
407
|
+
Scheduled: 'scheduled',
|
|
408
|
+
Sending: 'sending',
|
|
409
|
+
Publish: 'publish',
|
|
410
|
+
Failed: 'failed'
|
|
411
|
+
};
|
|
412
|
+
export const ReachV1CampaignsCampaignResourceTypeEnum = {
|
|
413
|
+
Campaign: 'campaign',
|
|
414
|
+
Automation: 'automation',
|
|
415
|
+
DoubleOptIn: 'double_opt_in'
|
|
416
|
+
};
|
|
393
417
|
export const ReachV1ContactsContactDetailsResourceSubscriptionStatusEnum = {
|
|
394
418
|
Subscribed: 'subscribed',
|
|
395
419
|
Unsubscribed: 'unsubscribed',
|
|
@@ -577,6 +601,28 @@ export const ReachV1ContactsUpdateRequestSubscriptionStatusEnum = {
|
|
|
577
601
|
Confirmed: 'confirmed',
|
|
578
602
|
Pending: 'pending'
|
|
579
603
|
};
|
|
604
|
+
export const ReachV1FormsFormDetailsResourceStatusEnum = {
|
|
605
|
+
Active: 'active',
|
|
606
|
+
Paused: 'paused',
|
|
607
|
+
Draft: 'draft'
|
|
608
|
+
};
|
|
609
|
+
export const ReachV1FormsFormDetailsResourceTypeEnum = {
|
|
610
|
+
Form: 'form'
|
|
611
|
+
};
|
|
612
|
+
export const ReachV1FormsFormResourceStatusEnum = {
|
|
613
|
+
Active: 'active',
|
|
614
|
+
Paused: 'paused',
|
|
615
|
+
Draft: 'draft'
|
|
616
|
+
};
|
|
617
|
+
export const ReachV1FormsFormResourceTypeEnum = {
|
|
618
|
+
Form: 'form'
|
|
619
|
+
};
|
|
620
|
+
export const ReachV1FormsFormTagResourceTypeEnum = {
|
|
621
|
+
Form: 'form',
|
|
622
|
+
Custom: 'custom',
|
|
623
|
+
Import: 'import',
|
|
624
|
+
System: 'system'
|
|
625
|
+
};
|
|
580
626
|
export const VPSV1ActionActionResourceStateEnum = {
|
|
581
627
|
Success: 'success',
|
|
582
628
|
Error: 'error',
|
|
@@ -16430,6 +16476,318 @@ export const ListAutomationsV1SortDirectionEnum = {
|
|
|
16430
16476
|
Asc: 'asc',
|
|
16431
16477
|
Desc: 'desc'
|
|
16432
16478
|
};
|
|
16479
|
+
/**
|
|
16480
|
+
* ReachCampaignsApi - axios parameter creator
|
|
16481
|
+
* @export
|
|
16482
|
+
*/
|
|
16483
|
+
export const ReachCampaignsApiAxiosParamCreator = function (configuration) {
|
|
16484
|
+
return {
|
|
16485
|
+
/**
|
|
16486
|
+
* Get a single campaign with its sender, subject, template reference, targeting and delivery progress. This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.
|
|
16487
|
+
* @summary Get campaign details
|
|
16488
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16489
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
16490
|
+
* @param {*} [options] Override http request option.
|
|
16491
|
+
* @throws {RequiredError}
|
|
16492
|
+
*/
|
|
16493
|
+
getCampaignDetailsV1: (profileUuid_1, campaignUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, campaignUuid_1, ...args_1], void 0, function* (profileUuid, campaignUuid, options = {}) {
|
|
16494
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
16495
|
+
assertParamExists('getCampaignDetailsV1', 'profileUuid', profileUuid);
|
|
16496
|
+
// verify required parameter 'campaignUuid' is not null or undefined
|
|
16497
|
+
assertParamExists('getCampaignDetailsV1', 'campaignUuid', campaignUuid);
|
|
16498
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}`
|
|
16499
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)))
|
|
16500
|
+
.replace(`{${"campaignUuid"}}`, encodeURIComponent(String(campaignUuid)));
|
|
16501
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16502
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16503
|
+
let baseOptions;
|
|
16504
|
+
if (configuration) {
|
|
16505
|
+
baseOptions = configuration.baseOptions;
|
|
16506
|
+
}
|
|
16507
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
16508
|
+
const localVarHeaderParameter = {};
|
|
16509
|
+
const localVarQueryParameter = {};
|
|
16510
|
+
// authentication apiToken required
|
|
16511
|
+
// http bearer authentication required
|
|
16512
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
16513
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16514
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16515
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16516
|
+
return {
|
|
16517
|
+
url: toPathString(localVarUrlObj),
|
|
16518
|
+
options: localVarRequestOptions,
|
|
16519
|
+
};
|
|
16520
|
+
}),
|
|
16521
|
+
/**
|
|
16522
|
+
* Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
|
|
16523
|
+
* @summary Get campaign performance
|
|
16524
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16525
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
16526
|
+
* @param {*} [options] Override http request option.
|
|
16527
|
+
* @throws {RequiredError}
|
|
16528
|
+
*/
|
|
16529
|
+
getCampaignPerformanceV1: (profileUuid_1, campaignUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, campaignUuid_1, ...args_1], void 0, function* (profileUuid, campaignUuid, options = {}) {
|
|
16530
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
16531
|
+
assertParamExists('getCampaignPerformanceV1', 'profileUuid', profileUuid);
|
|
16532
|
+
// verify required parameter 'campaignUuid' is not null or undefined
|
|
16533
|
+
assertParamExists('getCampaignPerformanceV1', 'campaignUuid', campaignUuid);
|
|
16534
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}/statistics`
|
|
16535
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)))
|
|
16536
|
+
.replace(`{${"campaignUuid"}}`, encodeURIComponent(String(campaignUuid)));
|
|
16537
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16538
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16539
|
+
let baseOptions;
|
|
16540
|
+
if (configuration) {
|
|
16541
|
+
baseOptions = configuration.baseOptions;
|
|
16542
|
+
}
|
|
16543
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
16544
|
+
const localVarHeaderParameter = {};
|
|
16545
|
+
const localVarQueryParameter = {};
|
|
16546
|
+
// authentication apiToken required
|
|
16547
|
+
// http bearer authentication required
|
|
16548
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
16549
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16550
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16551
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16552
|
+
return {
|
|
16553
|
+
url: toPathString(localVarUrlObj),
|
|
16554
|
+
options: localVarRequestOptions,
|
|
16555
|
+
};
|
|
16556
|
+
}),
|
|
16557
|
+
/**
|
|
16558
|
+
* Get a paginated list of the campaigns in a profile. Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
|
|
16559
|
+
* @summary List campaigns
|
|
16560
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16561
|
+
* @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status. A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
|
|
16562
|
+
* @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations.
|
|
16563
|
+
* @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to `asc`.
|
|
16564
|
+
* @param {number} [page] Page number
|
|
16565
|
+
* @param {number} [perPage] Number of items per page
|
|
16566
|
+
* @param {*} [options] Override http request option.
|
|
16567
|
+
* @throws {RequiredError}
|
|
16568
|
+
*/
|
|
16569
|
+
listCampaignsV1: (profileUuid_1, status_1, type_1, sortDirection_1, page_1, perPage_1, ...args_1) => __awaiter(this, [profileUuid_1, status_1, type_1, sortDirection_1, page_1, perPage_1, ...args_1], void 0, function* (profileUuid, status, type, sortDirection, page, perPage, options = {}) {
|
|
16570
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
16571
|
+
assertParamExists('listCampaignsV1', 'profileUuid', profileUuid);
|
|
16572
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/campaigns`
|
|
16573
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
16574
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16575
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16576
|
+
let baseOptions;
|
|
16577
|
+
if (configuration) {
|
|
16578
|
+
baseOptions = configuration.baseOptions;
|
|
16579
|
+
}
|
|
16580
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
16581
|
+
const localVarHeaderParameter = {};
|
|
16582
|
+
const localVarQueryParameter = {};
|
|
16583
|
+
// authentication apiToken required
|
|
16584
|
+
// http bearer authentication required
|
|
16585
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
16586
|
+
if (status !== undefined) {
|
|
16587
|
+
localVarQueryParameter['status'] = status;
|
|
16588
|
+
}
|
|
16589
|
+
if (type !== undefined) {
|
|
16590
|
+
localVarQueryParameter['type'] = type;
|
|
16591
|
+
}
|
|
16592
|
+
if (sortDirection !== undefined) {
|
|
16593
|
+
localVarQueryParameter['sort_direction'] = sortDirection;
|
|
16594
|
+
}
|
|
16595
|
+
if (page !== undefined) {
|
|
16596
|
+
localVarQueryParameter['page'] = page;
|
|
16597
|
+
}
|
|
16598
|
+
if (perPage !== undefined) {
|
|
16599
|
+
localVarQueryParameter['per_page'] = perPage;
|
|
16600
|
+
}
|
|
16601
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16602
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16603
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16604
|
+
return {
|
|
16605
|
+
url: toPathString(localVarUrlObj),
|
|
16606
|
+
options: localVarRequestOptions,
|
|
16607
|
+
};
|
|
16608
|
+
}),
|
|
16609
|
+
};
|
|
16610
|
+
};
|
|
16611
|
+
/**
|
|
16612
|
+
* ReachCampaignsApi - functional programming interface
|
|
16613
|
+
* @export
|
|
16614
|
+
*/
|
|
16615
|
+
export const ReachCampaignsApiFp = function (configuration) {
|
|
16616
|
+
const localVarAxiosParamCreator = ReachCampaignsApiAxiosParamCreator(configuration);
|
|
16617
|
+
return {
|
|
16618
|
+
/**
|
|
16619
|
+
* Get a single campaign with its sender, subject, template reference, targeting and delivery progress. This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.
|
|
16620
|
+
* @summary Get campaign details
|
|
16621
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16622
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
16623
|
+
* @param {*} [options] Override http request option.
|
|
16624
|
+
* @throws {RequiredError}
|
|
16625
|
+
*/
|
|
16626
|
+
getCampaignDetailsV1(profileUuid, campaignUuid, options) {
|
|
16627
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
16628
|
+
var _a, _b;
|
|
16629
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getCampaignDetailsV1(profileUuid, campaignUuid, options);
|
|
16630
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachCampaignsApi.getCampaignDetailsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
16631
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16632
|
+
});
|
|
16633
|
+
},
|
|
16634
|
+
/**
|
|
16635
|
+
* Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
|
|
16636
|
+
* @summary Get campaign performance
|
|
16637
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16638
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
16639
|
+
* @param {*} [options] Override http request option.
|
|
16640
|
+
* @throws {RequiredError}
|
|
16641
|
+
*/
|
|
16642
|
+
getCampaignPerformanceV1(profileUuid, campaignUuid, options) {
|
|
16643
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
16644
|
+
var _a, _b;
|
|
16645
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getCampaignPerformanceV1(profileUuid, campaignUuid, options);
|
|
16646
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachCampaignsApi.getCampaignPerformanceV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
16647
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16648
|
+
});
|
|
16649
|
+
},
|
|
16650
|
+
/**
|
|
16651
|
+
* Get a paginated list of the campaigns in a profile. Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
|
|
16652
|
+
* @summary List campaigns
|
|
16653
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16654
|
+
* @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status. A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
|
|
16655
|
+
* @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations.
|
|
16656
|
+
* @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to `asc`.
|
|
16657
|
+
* @param {number} [page] Page number
|
|
16658
|
+
* @param {number} [perPage] Number of items per page
|
|
16659
|
+
* @param {*} [options] Override http request option.
|
|
16660
|
+
* @throws {RequiredError}
|
|
16661
|
+
*/
|
|
16662
|
+
listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options) {
|
|
16663
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
16664
|
+
var _a, _b;
|
|
16665
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options);
|
|
16666
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachCampaignsApi.listCampaignsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
16667
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16668
|
+
});
|
|
16669
|
+
},
|
|
16670
|
+
};
|
|
16671
|
+
};
|
|
16672
|
+
/**
|
|
16673
|
+
* ReachCampaignsApi - factory interface
|
|
16674
|
+
* @export
|
|
16675
|
+
*/
|
|
16676
|
+
export const ReachCampaignsApiFactory = function (configuration, basePath, axios) {
|
|
16677
|
+
const localVarFp = ReachCampaignsApiFp(configuration);
|
|
16678
|
+
return {
|
|
16679
|
+
/**
|
|
16680
|
+
* Get a single campaign with its sender, subject, template reference, targeting and delivery progress. This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.
|
|
16681
|
+
* @summary Get campaign details
|
|
16682
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16683
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
16684
|
+
* @param {*} [options] Override http request option.
|
|
16685
|
+
* @throws {RequiredError}
|
|
16686
|
+
*/
|
|
16687
|
+
getCampaignDetailsV1(profileUuid, campaignUuid, options) {
|
|
16688
|
+
return localVarFp.getCampaignDetailsV1(profileUuid, campaignUuid, options).then((request) => request(axios, basePath));
|
|
16689
|
+
},
|
|
16690
|
+
/**
|
|
16691
|
+
* Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
|
|
16692
|
+
* @summary Get campaign performance
|
|
16693
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16694
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
16695
|
+
* @param {*} [options] Override http request option.
|
|
16696
|
+
* @throws {RequiredError}
|
|
16697
|
+
*/
|
|
16698
|
+
getCampaignPerformanceV1(profileUuid, campaignUuid, options) {
|
|
16699
|
+
return localVarFp.getCampaignPerformanceV1(profileUuid, campaignUuid, options).then((request) => request(axios, basePath));
|
|
16700
|
+
},
|
|
16701
|
+
/**
|
|
16702
|
+
* Get a paginated list of the campaigns in a profile. Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
|
|
16703
|
+
* @summary List campaigns
|
|
16704
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16705
|
+
* @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status. A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
|
|
16706
|
+
* @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations.
|
|
16707
|
+
* @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to `asc`.
|
|
16708
|
+
* @param {number} [page] Page number
|
|
16709
|
+
* @param {number} [perPage] Number of items per page
|
|
16710
|
+
* @param {*} [options] Override http request option.
|
|
16711
|
+
* @throws {RequiredError}
|
|
16712
|
+
*/
|
|
16713
|
+
listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options) {
|
|
16714
|
+
return localVarFp.listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options).then((request) => request(axios, basePath));
|
|
16715
|
+
},
|
|
16716
|
+
};
|
|
16717
|
+
};
|
|
16718
|
+
/**
|
|
16719
|
+
* ReachCampaignsApi - object-oriented interface
|
|
16720
|
+
* @export
|
|
16721
|
+
* @class ReachCampaignsApi
|
|
16722
|
+
* @extends {BaseAPI}
|
|
16723
|
+
*/
|
|
16724
|
+
export class ReachCampaignsApi extends BaseAPI {
|
|
16725
|
+
/**
|
|
16726
|
+
* Get a single campaign with its sender, subject, template reference, targeting and delivery progress. This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.
|
|
16727
|
+
* @summary Get campaign details
|
|
16728
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16729
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
16730
|
+
* @param {*} [options] Override http request option.
|
|
16731
|
+
* @throws {RequiredError}
|
|
16732
|
+
* @memberof ReachCampaignsApi
|
|
16733
|
+
*/
|
|
16734
|
+
getCampaignDetailsV1(profileUuid, campaignUuid, options) {
|
|
16735
|
+
return ReachCampaignsApiFp(this.configuration).getCampaignDetailsV1(profileUuid, campaignUuid, options).then((request) => request(this.axios, this.basePath));
|
|
16736
|
+
}
|
|
16737
|
+
/**
|
|
16738
|
+
* Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
|
|
16739
|
+
* @summary Get campaign performance
|
|
16740
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16741
|
+
* @param {string} campaignUuid Campaign uuid parameter
|
|
16742
|
+
* @param {*} [options] Override http request option.
|
|
16743
|
+
* @throws {RequiredError}
|
|
16744
|
+
* @memberof ReachCampaignsApi
|
|
16745
|
+
*/
|
|
16746
|
+
getCampaignPerformanceV1(profileUuid, campaignUuid, options) {
|
|
16747
|
+
return ReachCampaignsApiFp(this.configuration).getCampaignPerformanceV1(profileUuid, campaignUuid, options).then((request) => request(this.axios, this.basePath));
|
|
16748
|
+
}
|
|
16749
|
+
/**
|
|
16750
|
+
* Get a paginated list of the campaigns in a profile. Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
|
|
16751
|
+
* @summary List campaigns
|
|
16752
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
16753
|
+
* @param {ListCampaignsV1StatusEnum} [status] Filter campaigns by status. A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived.
|
|
16754
|
+
* @param {ListCampaignsV1TypeEnum} [type] Filter campaigns by type. Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations.
|
|
16755
|
+
* @param {ListCampaignsV1SortDirectionEnum} [sortDirection] Order campaigns by creation date. Newest first unless set to `asc`.
|
|
16756
|
+
* @param {number} [page] Page number
|
|
16757
|
+
* @param {number} [perPage] Number of items per page
|
|
16758
|
+
* @param {*} [options] Override http request option.
|
|
16759
|
+
* @throws {RequiredError}
|
|
16760
|
+
* @memberof ReachCampaignsApi
|
|
16761
|
+
*/
|
|
16762
|
+
listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options) {
|
|
16763
|
+
return ReachCampaignsApiFp(this.configuration).listCampaignsV1(profileUuid, status, type, sortDirection, page, perPage, options).then((request) => request(this.axios, this.basePath));
|
|
16764
|
+
}
|
|
16765
|
+
}
|
|
16766
|
+
/**
|
|
16767
|
+
* @export
|
|
16768
|
+
*/
|
|
16769
|
+
export const ListCampaignsV1StatusEnum = {
|
|
16770
|
+
Draft: 'draft',
|
|
16771
|
+
Scheduled: 'scheduled',
|
|
16772
|
+
Sending: 'sending',
|
|
16773
|
+
Publish: 'publish',
|
|
16774
|
+
Failed: 'failed'
|
|
16775
|
+
};
|
|
16776
|
+
/**
|
|
16777
|
+
* @export
|
|
16778
|
+
*/
|
|
16779
|
+
export const ListCampaignsV1TypeEnum = {
|
|
16780
|
+
Campaign: 'campaign',
|
|
16781
|
+
Automation: 'automation',
|
|
16782
|
+
DoubleOptIn: 'double_opt_in'
|
|
16783
|
+
};
|
|
16784
|
+
/**
|
|
16785
|
+
* @export
|
|
16786
|
+
*/
|
|
16787
|
+
export const ListCampaignsV1SortDirectionEnum = {
|
|
16788
|
+
Asc: 'asc',
|
|
16789
|
+
Desc: 'desc'
|
|
16790
|
+
};
|
|
16433
16791
|
/**
|
|
16434
16792
|
* ReachContactFieldsApi - axios parameter creator
|
|
16435
16793
|
* @export
|
|
@@ -17602,6 +17960,272 @@ export const ListProfileContactsV1SubscriptionStatusEnum = {
|
|
|
17602
17960
|
Confirmed: 'confirmed',
|
|
17603
17961
|
Pending: 'pending'
|
|
17604
17962
|
};
|
|
17963
|
+
/**
|
|
17964
|
+
* ReachFormsApi - axios parameter creator
|
|
17965
|
+
* @export
|
|
17966
|
+
*/
|
|
17967
|
+
export const ReachFormsApiAxiosParamCreator = function (configuration) {
|
|
17968
|
+
return {
|
|
17969
|
+
/**
|
|
17970
|
+
* Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
|
|
17971
|
+
* @summary Delete form
|
|
17972
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
17973
|
+
* @param {string} formUuid Form uuid parameter
|
|
17974
|
+
* @param {*} [options] Override http request option.
|
|
17975
|
+
* @throws {RequiredError}
|
|
17976
|
+
*/
|
|
17977
|
+
deleteFormV1: (profileUuid_1, formUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, formUuid_1, ...args_1], void 0, function* (profileUuid, formUuid, options = {}) {
|
|
17978
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
17979
|
+
assertParamExists('deleteFormV1', 'profileUuid', profileUuid);
|
|
17980
|
+
// verify required parameter 'formUuid' is not null or undefined
|
|
17981
|
+
assertParamExists('deleteFormV1', 'formUuid', formUuid);
|
|
17982
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}`
|
|
17983
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)))
|
|
17984
|
+
.replace(`{${"formUuid"}}`, encodeURIComponent(String(formUuid)));
|
|
17985
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17986
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17987
|
+
let baseOptions;
|
|
17988
|
+
if (configuration) {
|
|
17989
|
+
baseOptions = configuration.baseOptions;
|
|
17990
|
+
}
|
|
17991
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
17992
|
+
const localVarHeaderParameter = {};
|
|
17993
|
+
const localVarQueryParameter = {};
|
|
17994
|
+
// authentication apiToken required
|
|
17995
|
+
// http bearer authentication required
|
|
17996
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
17997
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17998
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17999
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18000
|
+
return {
|
|
18001
|
+
url: toPathString(localVarUrlObj),
|
|
18002
|
+
options: localVarRequestOptions,
|
|
18003
|
+
};
|
|
18004
|
+
}),
|
|
18005
|
+
/**
|
|
18006
|
+
* Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
|
|
18007
|
+
* @summary Get form details
|
|
18008
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18009
|
+
* @param {string} formUuid Form uuid parameter
|
|
18010
|
+
* @param {*} [options] Override http request option.
|
|
18011
|
+
* @throws {RequiredError}
|
|
18012
|
+
*/
|
|
18013
|
+
getFormDetailsV1: (profileUuid_1, formUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, formUuid_1, ...args_1], void 0, function* (profileUuid, formUuid, options = {}) {
|
|
18014
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
18015
|
+
assertParamExists('getFormDetailsV1', 'profileUuid', profileUuid);
|
|
18016
|
+
// verify required parameter 'formUuid' is not null or undefined
|
|
18017
|
+
assertParamExists('getFormDetailsV1', 'formUuid', formUuid);
|
|
18018
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}`
|
|
18019
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)))
|
|
18020
|
+
.replace(`{${"formUuid"}}`, encodeURIComponent(String(formUuid)));
|
|
18021
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18022
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18023
|
+
let baseOptions;
|
|
18024
|
+
if (configuration) {
|
|
18025
|
+
baseOptions = configuration.baseOptions;
|
|
18026
|
+
}
|
|
18027
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
18028
|
+
const localVarHeaderParameter = {};
|
|
18029
|
+
const localVarQueryParameter = {};
|
|
18030
|
+
// authentication apiToken required
|
|
18031
|
+
// http bearer authentication required
|
|
18032
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18033
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18034
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18035
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18036
|
+
return {
|
|
18037
|
+
url: toPathString(localVarUrlObj),
|
|
18038
|
+
options: localVarRequestOptions,
|
|
18039
|
+
};
|
|
18040
|
+
}),
|
|
18041
|
+
/**
|
|
18042
|
+
* Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
18043
|
+
* @summary List forms
|
|
18044
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18045
|
+
* @param {number} [page] Page number
|
|
18046
|
+
* @param {number} [perPage] Number of items per page
|
|
18047
|
+
* @param {*} [options] Override http request option.
|
|
18048
|
+
* @throws {RequiredError}
|
|
18049
|
+
*/
|
|
18050
|
+
listFormsV1: (profileUuid_1, page_1, perPage_1, ...args_1) => __awaiter(this, [profileUuid_1, page_1, perPage_1, ...args_1], void 0, function* (profileUuid, page, perPage, options = {}) {
|
|
18051
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
18052
|
+
assertParamExists('listFormsV1', 'profileUuid', profileUuid);
|
|
18053
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/forms`
|
|
18054
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
18055
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18056
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18057
|
+
let baseOptions;
|
|
18058
|
+
if (configuration) {
|
|
18059
|
+
baseOptions = configuration.baseOptions;
|
|
18060
|
+
}
|
|
18061
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
18062
|
+
const localVarHeaderParameter = {};
|
|
18063
|
+
const localVarQueryParameter = {};
|
|
18064
|
+
// authentication apiToken required
|
|
18065
|
+
// http bearer authentication required
|
|
18066
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18067
|
+
if (page !== undefined) {
|
|
18068
|
+
localVarQueryParameter['page'] = page;
|
|
18069
|
+
}
|
|
18070
|
+
if (perPage !== undefined) {
|
|
18071
|
+
localVarQueryParameter['per_page'] = perPage;
|
|
18072
|
+
}
|
|
18073
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18074
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18075
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18076
|
+
return {
|
|
18077
|
+
url: toPathString(localVarUrlObj),
|
|
18078
|
+
options: localVarRequestOptions,
|
|
18079
|
+
};
|
|
18080
|
+
}),
|
|
18081
|
+
};
|
|
18082
|
+
};
|
|
18083
|
+
/**
|
|
18084
|
+
* ReachFormsApi - functional programming interface
|
|
18085
|
+
* @export
|
|
18086
|
+
*/
|
|
18087
|
+
export const ReachFormsApiFp = function (configuration) {
|
|
18088
|
+
const localVarAxiosParamCreator = ReachFormsApiAxiosParamCreator(configuration);
|
|
18089
|
+
return {
|
|
18090
|
+
/**
|
|
18091
|
+
* Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
|
|
18092
|
+
* @summary Delete form
|
|
18093
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18094
|
+
* @param {string} formUuid Form uuid parameter
|
|
18095
|
+
* @param {*} [options] Override http request option.
|
|
18096
|
+
* @throws {RequiredError}
|
|
18097
|
+
*/
|
|
18098
|
+
deleteFormV1(profileUuid, formUuid, options) {
|
|
18099
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18100
|
+
var _a, _b;
|
|
18101
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteFormV1(profileUuid, formUuid, options);
|
|
18102
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachFormsApi.deleteFormV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18103
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18104
|
+
});
|
|
18105
|
+
},
|
|
18106
|
+
/**
|
|
18107
|
+
* Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
|
|
18108
|
+
* @summary Get form details
|
|
18109
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18110
|
+
* @param {string} formUuid Form uuid parameter
|
|
18111
|
+
* @param {*} [options] Override http request option.
|
|
18112
|
+
* @throws {RequiredError}
|
|
18113
|
+
*/
|
|
18114
|
+
getFormDetailsV1(profileUuid, formUuid, options) {
|
|
18115
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18116
|
+
var _a, _b;
|
|
18117
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFormDetailsV1(profileUuid, formUuid, options);
|
|
18118
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachFormsApi.getFormDetailsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18119
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18120
|
+
});
|
|
18121
|
+
},
|
|
18122
|
+
/**
|
|
18123
|
+
* Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
18124
|
+
* @summary List forms
|
|
18125
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18126
|
+
* @param {number} [page] Page number
|
|
18127
|
+
* @param {number} [perPage] Number of items per page
|
|
18128
|
+
* @param {*} [options] Override http request option.
|
|
18129
|
+
* @throws {RequiredError}
|
|
18130
|
+
*/
|
|
18131
|
+
listFormsV1(profileUuid, page, perPage, options) {
|
|
18132
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18133
|
+
var _a, _b;
|
|
18134
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listFormsV1(profileUuid, page, perPage, options);
|
|
18135
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachFormsApi.listFormsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18136
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18137
|
+
});
|
|
18138
|
+
},
|
|
18139
|
+
};
|
|
18140
|
+
};
|
|
18141
|
+
/**
|
|
18142
|
+
* ReachFormsApi - factory interface
|
|
18143
|
+
* @export
|
|
18144
|
+
*/
|
|
18145
|
+
export const ReachFormsApiFactory = function (configuration, basePath, axios) {
|
|
18146
|
+
const localVarFp = ReachFormsApiFp(configuration);
|
|
18147
|
+
return {
|
|
18148
|
+
/**
|
|
18149
|
+
* Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
|
|
18150
|
+
* @summary Delete form
|
|
18151
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18152
|
+
* @param {string} formUuid Form uuid parameter
|
|
18153
|
+
* @param {*} [options] Override http request option.
|
|
18154
|
+
* @throws {RequiredError}
|
|
18155
|
+
*/
|
|
18156
|
+
deleteFormV1(profileUuid, formUuid, options) {
|
|
18157
|
+
return localVarFp.deleteFormV1(profileUuid, formUuid, options).then((request) => request(axios, basePath));
|
|
18158
|
+
},
|
|
18159
|
+
/**
|
|
18160
|
+
* Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
|
|
18161
|
+
* @summary Get form details
|
|
18162
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18163
|
+
* @param {string} formUuid Form uuid parameter
|
|
18164
|
+
* @param {*} [options] Override http request option.
|
|
18165
|
+
* @throws {RequiredError}
|
|
18166
|
+
*/
|
|
18167
|
+
getFormDetailsV1(profileUuid, formUuid, options) {
|
|
18168
|
+
return localVarFp.getFormDetailsV1(profileUuid, formUuid, options).then((request) => request(axios, basePath));
|
|
18169
|
+
},
|
|
18170
|
+
/**
|
|
18171
|
+
* Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
18172
|
+
* @summary List forms
|
|
18173
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18174
|
+
* @param {number} [page] Page number
|
|
18175
|
+
* @param {number} [perPage] Number of items per page
|
|
18176
|
+
* @param {*} [options] Override http request option.
|
|
18177
|
+
* @throws {RequiredError}
|
|
18178
|
+
*/
|
|
18179
|
+
listFormsV1(profileUuid, page, perPage, options) {
|
|
18180
|
+
return localVarFp.listFormsV1(profileUuid, page, perPage, options).then((request) => request(axios, basePath));
|
|
18181
|
+
},
|
|
18182
|
+
};
|
|
18183
|
+
};
|
|
18184
|
+
/**
|
|
18185
|
+
* ReachFormsApi - object-oriented interface
|
|
18186
|
+
* @export
|
|
18187
|
+
* @class ReachFormsApi
|
|
18188
|
+
* @extends {BaseAPI}
|
|
18189
|
+
*/
|
|
18190
|
+
export class ReachFormsApi extends BaseAPI {
|
|
18191
|
+
/**
|
|
18192
|
+
* Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
|
|
18193
|
+
* @summary Delete form
|
|
18194
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18195
|
+
* @param {string} formUuid Form uuid parameter
|
|
18196
|
+
* @param {*} [options] Override http request option.
|
|
18197
|
+
* @throws {RequiredError}
|
|
18198
|
+
* @memberof ReachFormsApi
|
|
18199
|
+
*/
|
|
18200
|
+
deleteFormV1(profileUuid, formUuid, options) {
|
|
18201
|
+
return ReachFormsApiFp(this.configuration).deleteFormV1(profileUuid, formUuid, options).then((request) => request(this.axios, this.basePath));
|
|
18202
|
+
}
|
|
18203
|
+
/**
|
|
18204
|
+
* Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
|
|
18205
|
+
* @summary Get form details
|
|
18206
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18207
|
+
* @param {string} formUuid Form uuid parameter
|
|
18208
|
+
* @param {*} [options] Override http request option.
|
|
18209
|
+
* @throws {RequiredError}
|
|
18210
|
+
* @memberof ReachFormsApi
|
|
18211
|
+
*/
|
|
18212
|
+
getFormDetailsV1(profileUuid, formUuid, options) {
|
|
18213
|
+
return ReachFormsApiFp(this.configuration).getFormDetailsV1(profileUuid, formUuid, options).then((request) => request(this.axios, this.basePath));
|
|
18214
|
+
}
|
|
18215
|
+
/**
|
|
18216
|
+
* Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
18217
|
+
* @summary List forms
|
|
18218
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18219
|
+
* @param {number} [page] Page number
|
|
18220
|
+
* @param {number} [perPage] Number of items per page
|
|
18221
|
+
* @param {*} [options] Override http request option.
|
|
18222
|
+
* @throws {RequiredError}
|
|
18223
|
+
* @memberof ReachFormsApi
|
|
18224
|
+
*/
|
|
18225
|
+
listFormsV1(profileUuid, page, perPage, options) {
|
|
18226
|
+
return ReachFormsApiFp(this.configuration).listFormsV1(profileUuid, page, perPage, options).then((request) => request(this.axios, this.basePath));
|
|
18227
|
+
}
|
|
18228
|
+
}
|
|
17605
18229
|
/**
|
|
17606
18230
|
* ReachProfilesApi - axios parameter creator
|
|
17607
18231
|
* @export
|
|
@@ -17640,6 +18264,38 @@ export const ReachProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
17640
18264
|
options: localVarRequestOptions,
|
|
17641
18265
|
};
|
|
17642
18266
|
}),
|
|
18267
|
+
/**
|
|
18268
|
+
* Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
|
|
18269
|
+
* @summary Get remaining plan limits
|
|
18270
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18271
|
+
* @param {*} [options] Override http request option.
|
|
18272
|
+
* @throws {RequiredError}
|
|
18273
|
+
*/
|
|
18274
|
+
getRemainingPlanLimitsV1: (profileUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, ...args_1], void 0, function* (profileUuid, options = {}) {
|
|
18275
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
18276
|
+
assertParamExists('getRemainingPlanLimitsV1', 'profileUuid', profileUuid);
|
|
18277
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/limits`
|
|
18278
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
18279
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18280
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18281
|
+
let baseOptions;
|
|
18282
|
+
if (configuration) {
|
|
18283
|
+
baseOptions = configuration.baseOptions;
|
|
18284
|
+
}
|
|
18285
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
18286
|
+
const localVarHeaderParameter = {};
|
|
18287
|
+
const localVarQueryParameter = {};
|
|
18288
|
+
// authentication apiToken required
|
|
18289
|
+
// http bearer authentication required
|
|
18290
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18291
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18292
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18293
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18294
|
+
return {
|
|
18295
|
+
url: toPathString(localVarUrlObj),
|
|
18296
|
+
options: localVarRequestOptions,
|
|
18297
|
+
};
|
|
18298
|
+
}),
|
|
17643
18299
|
/**
|
|
17644
18300
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
17645
18301
|
* @summary List Profiles
|
|
@@ -17692,6 +18348,21 @@ export const ReachProfilesApiFp = function (configuration) {
|
|
|
17692
18348
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17693
18349
|
});
|
|
17694
18350
|
},
|
|
18351
|
+
/**
|
|
18352
|
+
* Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
|
|
18353
|
+
* @summary Get remaining plan limits
|
|
18354
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18355
|
+
* @param {*} [options] Override http request option.
|
|
18356
|
+
* @throws {RequiredError}
|
|
18357
|
+
*/
|
|
18358
|
+
getRemainingPlanLimitsV1(profileUuid, options) {
|
|
18359
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18360
|
+
var _a, _b;
|
|
18361
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getRemainingPlanLimitsV1(profileUuid, options);
|
|
18362
|
+
const localVarOperationServerBasePath = (_b = (_a = operationServerMap['ReachProfilesApi.getRemainingPlanLimitsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
18363
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18364
|
+
});
|
|
18365
|
+
},
|
|
17695
18366
|
/**
|
|
17696
18367
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
17697
18368
|
* @summary List Profiles
|
|
@@ -17725,6 +18396,16 @@ export const ReachProfilesApiFactory = function (configuration, basePath, axios)
|
|
|
17725
18396
|
getProfileDomainDNSStatusV1(profileUuid, options) {
|
|
17726
18397
|
return localVarFp.getProfileDomainDNSStatusV1(profileUuid, options).then((request) => request(axios, basePath));
|
|
17727
18398
|
},
|
|
18399
|
+
/**
|
|
18400
|
+
* Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
|
|
18401
|
+
* @summary Get remaining plan limits
|
|
18402
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18403
|
+
* @param {*} [options] Override http request option.
|
|
18404
|
+
* @throws {RequiredError}
|
|
18405
|
+
*/
|
|
18406
|
+
getRemainingPlanLimitsV1(profileUuid, options) {
|
|
18407
|
+
return localVarFp.getRemainingPlanLimitsV1(profileUuid, options).then((request) => request(axios, basePath));
|
|
18408
|
+
},
|
|
17728
18409
|
/**
|
|
17729
18410
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
17730
18411
|
* @summary List Profiles
|
|
@@ -17754,6 +18435,17 @@ export class ReachProfilesApi extends BaseAPI {
|
|
|
17754
18435
|
getProfileDomainDNSStatusV1(profileUuid, options) {
|
|
17755
18436
|
return ReachProfilesApiFp(this.configuration).getProfileDomainDNSStatusV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
|
|
17756
18437
|
}
|
|
18438
|
+
/**
|
|
18439
|
+
* Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
|
|
18440
|
+
* @summary Get remaining plan limits
|
|
18441
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
18442
|
+
* @param {*} [options] Override http request option.
|
|
18443
|
+
* @throws {RequiredError}
|
|
18444
|
+
* @memberof ReachProfilesApi
|
|
18445
|
+
*/
|
|
18446
|
+
getRemainingPlanLimitsV1(profileUuid, options) {
|
|
18447
|
+
return ReachProfilesApiFp(this.configuration).getRemainingPlanLimitsV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
|
|
18448
|
+
}
|
|
17757
18449
|
/**
|
|
17758
18450
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
17759
18451
|
* @summary List Profiles
|