@hostinger/sdk 1.63.0 → 1.64.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 +626 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +459 -1
- package/dist/api.js +297 -1
- 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 +459 -1
- package/dist/esm/api.js +297 -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/ReachProfilesApi.md +232 -0
- package/docs/ReachV1ProfilesDomainsConnectRequest.md +21 -0
- package/docs/ReachV1ProfilesDomainsDisconnectRequest.md +21 -0
- package/docs/ReachV1ProfilesDomainsDnsStatusResource.md +2 -0
- package/docs/ReachV1ProfilesSettingsSettingsResource.md +63 -0
- package/docs/ReachV1ProfilesSettingsUpdateRequest.md +63 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.64.0
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -13912,6 +13912,32 @@ export interface ReachV1FormsFormTemplateResource {
|
|
|
13912
13912
|
*/
|
|
13913
13913
|
'path': string | null;
|
|
13914
13914
|
}
|
|
13915
|
+
/**
|
|
13916
|
+
* Sending domain to connect to the profile
|
|
13917
|
+
* @export
|
|
13918
|
+
* @interface ReachV1ProfilesDomainsConnectRequest
|
|
13919
|
+
*/
|
|
13920
|
+
export interface ReachV1ProfilesDomainsConnectRequest {
|
|
13921
|
+
/**
|
|
13922
|
+
*
|
|
13923
|
+
* @type {string}
|
|
13924
|
+
* @memberof ReachV1ProfilesDomainsConnectRequest
|
|
13925
|
+
*/
|
|
13926
|
+
'domain': string;
|
|
13927
|
+
}
|
|
13928
|
+
/**
|
|
13929
|
+
* Sending domain to disconnect from the profile
|
|
13930
|
+
* @export
|
|
13931
|
+
* @interface ReachV1ProfilesDomainsDisconnectRequest
|
|
13932
|
+
*/
|
|
13933
|
+
export interface ReachV1ProfilesDomainsDisconnectRequest {
|
|
13934
|
+
/**
|
|
13935
|
+
*
|
|
13936
|
+
* @type {string}
|
|
13937
|
+
* @memberof ReachV1ProfilesDomainsDisconnectRequest
|
|
13938
|
+
*/
|
|
13939
|
+
'domain': string;
|
|
13940
|
+
}
|
|
13915
13941
|
/**
|
|
13916
13942
|
*
|
|
13917
13943
|
* @export
|
|
@@ -14017,6 +14043,12 @@ export interface ReachV1ProfilesDomainsDnsStatusResource {
|
|
|
14017
14043
|
* @memberof ReachV1ProfilesDomainsDnsStatusResource
|
|
14018
14044
|
*/
|
|
14019
14045
|
'dmarc': ReachV1ProfilesDomainsDnsRecordStatus;
|
|
14046
|
+
/**
|
|
14047
|
+
*
|
|
14048
|
+
* @type {ReachV1ProfilesDomainsDnsRecordStatus}
|
|
14049
|
+
* @memberof ReachV1ProfilesDomainsDnsStatusResource
|
|
14050
|
+
*/
|
|
14051
|
+
'a': ReachV1ProfilesDomainsDnsRecordStatus;
|
|
14020
14052
|
}
|
|
14021
14053
|
/**
|
|
14022
14054
|
* The sending domain connected to the profile. When no domain is connected every field is `null` and `suspended_sender_emails` is empty, so the shape stays the same whether or not the profile is set up for sending.
|
|
@@ -14289,6 +14321,288 @@ export interface ReachV1ProfilesProfileResourceProfilesInner {
|
|
|
14289
14321
|
*/
|
|
14290
14322
|
'updated_at': string;
|
|
14291
14323
|
}
|
|
14324
|
+
/**
|
|
14325
|
+
* Sender identity and brand details saved on the profile. A profile that never filled its settings in returns empty values, so every field can be `null`.
|
|
14326
|
+
* @export
|
|
14327
|
+
* @interface ReachV1ProfilesSettingsSettingsResource
|
|
14328
|
+
*/
|
|
14329
|
+
export interface ReachV1ProfilesSettingsSettingsResource {
|
|
14330
|
+
/**
|
|
14331
|
+
*
|
|
14332
|
+
* @type {string}
|
|
14333
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14334
|
+
*/
|
|
14335
|
+
'brand_name': string | null;
|
|
14336
|
+
/**
|
|
14337
|
+
*
|
|
14338
|
+
* @type {string}
|
|
14339
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14340
|
+
*/
|
|
14341
|
+
'website_url': string | null;
|
|
14342
|
+
/**
|
|
14343
|
+
*
|
|
14344
|
+
* @type {string}
|
|
14345
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14346
|
+
*/
|
|
14347
|
+
'business_address': string | null;
|
|
14348
|
+
/**
|
|
14349
|
+
*
|
|
14350
|
+
* @type {string}
|
|
14351
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14352
|
+
*/
|
|
14353
|
+
'privacy_policy_url': string | null;
|
|
14354
|
+
/**
|
|
14355
|
+
*
|
|
14356
|
+
* @type {string}
|
|
14357
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14358
|
+
*/
|
|
14359
|
+
'accent_color': string | null;
|
|
14360
|
+
/**
|
|
14361
|
+
*
|
|
14362
|
+
* @type {string}
|
|
14363
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14364
|
+
*/
|
|
14365
|
+
'button_color': string | null;
|
|
14366
|
+
/**
|
|
14367
|
+
*
|
|
14368
|
+
* @type {string}
|
|
14369
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14370
|
+
*/
|
|
14371
|
+
'background_color': string | null;
|
|
14372
|
+
/**
|
|
14373
|
+
*
|
|
14374
|
+
* @type {string}
|
|
14375
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14376
|
+
*/
|
|
14377
|
+
'text_color': string | null;
|
|
14378
|
+
/**
|
|
14379
|
+
*
|
|
14380
|
+
* @type {string}
|
|
14381
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14382
|
+
*/
|
|
14383
|
+
'links_color': string | null;
|
|
14384
|
+
/**
|
|
14385
|
+
* Button text colour.
|
|
14386
|
+
* @type {string}
|
|
14387
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14388
|
+
*/
|
|
14389
|
+
'button_text': string | null;
|
|
14390
|
+
/**
|
|
14391
|
+
* Button corner radius in pixels.
|
|
14392
|
+
* @type {number}
|
|
14393
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14394
|
+
*/
|
|
14395
|
+
'button_corners': number | null;
|
|
14396
|
+
/**
|
|
14397
|
+
* Body and button font.
|
|
14398
|
+
* @type {string}
|
|
14399
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14400
|
+
*/
|
|
14401
|
+
'font_family': string | null;
|
|
14402
|
+
/**
|
|
14403
|
+
*
|
|
14404
|
+
* @type {string}
|
|
14405
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14406
|
+
*/
|
|
14407
|
+
'heading_font_family': string | null;
|
|
14408
|
+
/**
|
|
14409
|
+
*
|
|
14410
|
+
* @type {string}
|
|
14411
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14412
|
+
*/
|
|
14413
|
+
'logo_url': string | null;
|
|
14414
|
+
/**
|
|
14415
|
+
*
|
|
14416
|
+
* @type {Array<string>}
|
|
14417
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14418
|
+
*/
|
|
14419
|
+
'social_links': Array<string> | null;
|
|
14420
|
+
/**
|
|
14421
|
+
* Social profile links keyed by platform.
|
|
14422
|
+
* @type {{ [key: string]: string; }}
|
|
14423
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14424
|
+
*/
|
|
14425
|
+
'socials': {
|
|
14426
|
+
[key: string]: string;
|
|
14427
|
+
} | null;
|
|
14428
|
+
/**
|
|
14429
|
+
*
|
|
14430
|
+
* @type {string}
|
|
14431
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14432
|
+
*/
|
|
14433
|
+
'about': string | null;
|
|
14434
|
+
/**
|
|
14435
|
+
*
|
|
14436
|
+
* @type {Array<string>}
|
|
14437
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14438
|
+
*/
|
|
14439
|
+
'keywords': Array<string> | null;
|
|
14440
|
+
/**
|
|
14441
|
+
*
|
|
14442
|
+
* @type {Array<string>}
|
|
14443
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14444
|
+
*/
|
|
14445
|
+
'topics': Array<string> | null;
|
|
14446
|
+
/**
|
|
14447
|
+
*
|
|
14448
|
+
* @type {Array<string>}
|
|
14449
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14450
|
+
*/
|
|
14451
|
+
'selling_points': Array<string> | null;
|
|
14452
|
+
/**
|
|
14453
|
+
* Default sender name that campaigns created afterwards start from.
|
|
14454
|
+
* @type {string}
|
|
14455
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14456
|
+
*/
|
|
14457
|
+
'sender_name': string | null;
|
|
14458
|
+
/**
|
|
14459
|
+
* Part of the default sender address before the `@`. It is combined with the profile\'s connected sending domain, see the connected sending domain endpoint.
|
|
14460
|
+
* @type {string}
|
|
14461
|
+
* @memberof ReachV1ProfilesSettingsSettingsResource
|
|
14462
|
+
*/
|
|
14463
|
+
'sender_email': string | null;
|
|
14464
|
+
}
|
|
14465
|
+
/**
|
|
14466
|
+
* Settings to change. Only the fields sent are changed; `null` or an empty string clears a text field.
|
|
14467
|
+
* @export
|
|
14468
|
+
* @interface ReachV1ProfilesSettingsUpdateRequest
|
|
14469
|
+
*/
|
|
14470
|
+
export interface ReachV1ProfilesSettingsUpdateRequest {
|
|
14471
|
+
/**
|
|
14472
|
+
*
|
|
14473
|
+
* @type {string}
|
|
14474
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14475
|
+
*/
|
|
14476
|
+
'brand_name': string | null;
|
|
14477
|
+
/**
|
|
14478
|
+
*
|
|
14479
|
+
* @type {string}
|
|
14480
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14481
|
+
*/
|
|
14482
|
+
'website_url': string | null;
|
|
14483
|
+
/**
|
|
14484
|
+
*
|
|
14485
|
+
* @type {string}
|
|
14486
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14487
|
+
*/
|
|
14488
|
+
'business_address': string | null;
|
|
14489
|
+
/**
|
|
14490
|
+
*
|
|
14491
|
+
* @type {string}
|
|
14492
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14493
|
+
*/
|
|
14494
|
+
'privacy_policy_url': string | null;
|
|
14495
|
+
/**
|
|
14496
|
+
*
|
|
14497
|
+
* @type {string}
|
|
14498
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14499
|
+
*/
|
|
14500
|
+
'accent_color': string | null;
|
|
14501
|
+
/**
|
|
14502
|
+
*
|
|
14503
|
+
* @type {string}
|
|
14504
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14505
|
+
*/
|
|
14506
|
+
'button_color': string | null;
|
|
14507
|
+
/**
|
|
14508
|
+
*
|
|
14509
|
+
* @type {string}
|
|
14510
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14511
|
+
*/
|
|
14512
|
+
'background_color': string | null;
|
|
14513
|
+
/**
|
|
14514
|
+
*
|
|
14515
|
+
* @type {string}
|
|
14516
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14517
|
+
*/
|
|
14518
|
+
'text_color': string | null;
|
|
14519
|
+
/**
|
|
14520
|
+
*
|
|
14521
|
+
* @type {string}
|
|
14522
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14523
|
+
*/
|
|
14524
|
+
'links_color': string | null;
|
|
14525
|
+
/**
|
|
14526
|
+
* Button text colour.
|
|
14527
|
+
* @type {string}
|
|
14528
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14529
|
+
*/
|
|
14530
|
+
'button_text': string | null;
|
|
14531
|
+
/**
|
|
14532
|
+
*
|
|
14533
|
+
* @type {number}
|
|
14534
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14535
|
+
*/
|
|
14536
|
+
'button_corners': number | null;
|
|
14537
|
+
/**
|
|
14538
|
+
*
|
|
14539
|
+
* @type {string}
|
|
14540
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14541
|
+
*/
|
|
14542
|
+
'font_family': string | null;
|
|
14543
|
+
/**
|
|
14544
|
+
*
|
|
14545
|
+
* @type {string}
|
|
14546
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14547
|
+
*/
|
|
14548
|
+
'heading_font_family': string | null;
|
|
14549
|
+
/**
|
|
14550
|
+
* Public image URL. Logo uploads are not supported.
|
|
14551
|
+
* @type {string}
|
|
14552
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14553
|
+
*/
|
|
14554
|
+
'logo_url': string | null;
|
|
14555
|
+
/**
|
|
14556
|
+
*
|
|
14557
|
+
* @type {Array<string>}
|
|
14558
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14559
|
+
*/
|
|
14560
|
+
'social_links': Array<string>;
|
|
14561
|
+
/**
|
|
14562
|
+
* Social profile links keyed by platform.
|
|
14563
|
+
* @type {{ [key: string]: string; }}
|
|
14564
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14565
|
+
*/
|
|
14566
|
+
'socials': {
|
|
14567
|
+
[key: string]: string;
|
|
14568
|
+
} | null;
|
|
14569
|
+
/**
|
|
14570
|
+
*
|
|
14571
|
+
* @type {string}
|
|
14572
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14573
|
+
*/
|
|
14574
|
+
'about': string | null;
|
|
14575
|
+
/**
|
|
14576
|
+
*
|
|
14577
|
+
* @type {Array<string>}
|
|
14578
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14579
|
+
*/
|
|
14580
|
+
'keywords': Array<string> | null;
|
|
14581
|
+
/**
|
|
14582
|
+
*
|
|
14583
|
+
* @type {Array<string>}
|
|
14584
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14585
|
+
*/
|
|
14586
|
+
'topics': Array<string> | null;
|
|
14587
|
+
/**
|
|
14588
|
+
*
|
|
14589
|
+
* @type {Array<string>}
|
|
14590
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14591
|
+
*/
|
|
14592
|
+
'selling_points': Array<string> | null;
|
|
14593
|
+
/**
|
|
14594
|
+
* Default sender name. Letters, numbers and spaces only.
|
|
14595
|
+
* @type {string}
|
|
14596
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14597
|
+
*/
|
|
14598
|
+
'sender_name': string | null;
|
|
14599
|
+
/**
|
|
14600
|
+
* Part of the default sender address before the `@`, for example `hello`. Never send a full address: Reach adds the profile\'s connected sending domain itself.
|
|
14601
|
+
* @type {string}
|
|
14602
|
+
* @memberof ReachV1ProfilesSettingsUpdateRequest
|
|
14603
|
+
*/
|
|
14604
|
+
'sender_email': string | null;
|
|
14605
|
+
}
|
|
14292
14606
|
/**
|
|
14293
14607
|
* Create a reusable email template
|
|
14294
14608
|
* @export
|
|
@@ -29265,6 +29579,24 @@ export declare class ReachFormsApi extends BaseAPI {
|
|
|
29265
29579
|
* @export
|
|
29266
29580
|
*/
|
|
29267
29581
|
export declare const ReachProfilesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
29582
|
+
/**
|
|
29583
|
+
* Connect a sending domain to the profile so emails can be sent from addresses on it. Connecting does not make the domain ready to send: check the DNS status endpoint next for records that are still missing. A domain the account owns or has already verified connects immediately. Any other domain starts a TXT ownership verification and returns `409`; complete the verification in Reach, then retry. Returns `422` when the profile or another profile already has the domain, the domain is blocked, or its ownership cannot be verified. An already connected domain is never replaced. On success the sender address of draft and scheduled campaigns, and of published automation and double opt-in emails, moves onto the new domain in the background, keeping the part before the `@`.
|
|
29584
|
+
* @summary Connect sending domain
|
|
29585
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
29586
|
+
* @param {ReachV1ProfilesDomainsConnectRequest} reachV1ProfilesDomainsConnectRequest
|
|
29587
|
+
* @param {*} [options] Override http request option.
|
|
29588
|
+
* @throws {RequiredError}
|
|
29589
|
+
*/
|
|
29590
|
+
connectSendingDomainV1: (profileUuid: string, reachV1ProfilesDomainsConnectRequest: ReachV1ProfilesDomainsConnectRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29591
|
+
/**
|
|
29592
|
+
* Disconnect the sending domain from the profile. The domain record is removed, so the profile has no sending domain afterwards and campaigns cannot be sent until a domain is connected again. Sender addresses already stored on campaigns, automations and settings are left untouched and keep pointing at the removed domain. A domain that is not connected to the profile also succeeds, so success is not proof that anything was deleted. DNS records at the DNS provider are not removed. To switch domains, delete this one and connect the new one. Confirm the domain with the customer before calling.
|
|
29593
|
+
* @summary Delete sending domain
|
|
29594
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
29595
|
+
* @param {ReachV1ProfilesDomainsDisconnectRequest} reachV1ProfilesDomainsDisconnectRequest
|
|
29596
|
+
* @param {*} [options] Override http request option.
|
|
29597
|
+
* @throws {RequiredError}
|
|
29598
|
+
*/
|
|
29599
|
+
deleteSendingDomainV1: (profileUuid: string, reachV1ProfilesDomainsDisconnectRequest: ReachV1ProfilesDomainsDisconnectRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29268
29600
|
/**
|
|
29269
29601
|
* Get the sending domain connected to the profile, its verification status and any suspended sender addresses. Campaigns only go out once a domain is connected and active, so this is the cheapest way to check that precondition before building one. A profile with no domain connected returns the same shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records behind the status, use the DNS status endpoint.
|
|
29270
29602
|
* @summary Get connected sending domain
|
|
@@ -29281,6 +29613,14 @@ export declare const ReachProfilesApiAxiosParamCreator: (configuration?: Configu
|
|
|
29281
29613
|
* @throws {RequiredError}
|
|
29282
29614
|
*/
|
|
29283
29615
|
getProfileDomainDNSStatusV1: (profileUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29616
|
+
/**
|
|
29617
|
+
* Get the profile\'s saved sender identity and brand details. Read the default sender before creating a campaign instead of asking the customer, and reuse the brand fields when generating email content. Any field can be `null` for a profile that never filled its settings in. This does not check that the sending domain is verified, use the connected sending domain endpoint for that.
|
|
29618
|
+
* @summary Get profile settings
|
|
29619
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
29620
|
+
* @param {*} [options] Override http request option.
|
|
29621
|
+
* @throws {RequiredError}
|
|
29622
|
+
*/
|
|
29623
|
+
getProfileSettingsV1: (profileUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29284
29624
|
/**
|
|
29285
29625
|
* 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.
|
|
29286
29626
|
* @summary Get remaining plan limits
|
|
@@ -29304,12 +29644,39 @@ export declare const ReachProfilesApiAxiosParamCreator: (configuration?: Configu
|
|
|
29304
29644
|
* @throws {RequiredError}
|
|
29305
29645
|
*/
|
|
29306
29646
|
listProfilesV1: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29647
|
+
/**
|
|
29648
|
+
* Change the profile\'s default sender and brand details. Send only the fields to change: every omitted field keeps its value, and `null` or an empty string clears a text field. The default sender is what campaigns created afterwards start from; existing campaigns keep their own sender. `sender_email` is only the part before the `@`, because Reach combines it with the profile\'s connected sending domain, so an address outside that domain cannot be set. Connecting a sending domain is a separate endpoint and a connected domain cannot be changed here. Returns the settings after the change.
|
|
29649
|
+
* @summary Update profile settings
|
|
29650
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
29651
|
+
* @param {ReachV1ProfilesSettingsUpdateRequest} reachV1ProfilesSettingsUpdateRequest
|
|
29652
|
+
* @param {*} [options] Override http request option.
|
|
29653
|
+
* @throws {RequiredError}
|
|
29654
|
+
*/
|
|
29655
|
+
updateProfileSettingsV1: (profileUuid: string, reachV1ProfilesSettingsUpdateRequest: ReachV1ProfilesSettingsUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29307
29656
|
};
|
|
29308
29657
|
/**
|
|
29309
29658
|
* ReachProfilesApi - functional programming interface
|
|
29310
29659
|
* @export
|
|
29311
29660
|
*/
|
|
29312
29661
|
export declare const ReachProfilesApiFp: (configuration?: Configuration) => {
|
|
29662
|
+
/**
|
|
29663
|
+
* Connect a sending domain to the profile so emails can be sent from addresses on it. Connecting does not make the domain ready to send: check the DNS status endpoint next for records that are still missing. A domain the account owns or has already verified connects immediately. Any other domain starts a TXT ownership verification and returns `409`; complete the verification in Reach, then retry. Returns `422` when the profile or another profile already has the domain, the domain is blocked, or its ownership cannot be verified. An already connected domain is never replaced. On success the sender address of draft and scheduled campaigns, and of published automation and double opt-in emails, moves onto the new domain in the background, keeping the part before the `@`.
|
|
29664
|
+
* @summary Connect sending domain
|
|
29665
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
29666
|
+
* @param {ReachV1ProfilesDomainsConnectRequest} reachV1ProfilesDomainsConnectRequest
|
|
29667
|
+
* @param {*} [options] Override http request option.
|
|
29668
|
+
* @throws {RequiredError}
|
|
29669
|
+
*/
|
|
29670
|
+
connectSendingDomainV1(profileUuid: string, reachV1ProfilesDomainsConnectRequest: ReachV1ProfilesDomainsConnectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
29671
|
+
/**
|
|
29672
|
+
* Disconnect the sending domain from the profile. The domain record is removed, so the profile has no sending domain afterwards and campaigns cannot be sent until a domain is connected again. Sender addresses already stored on campaigns, automations and settings are left untouched and keep pointing at the removed domain. A domain that is not connected to the profile also succeeds, so success is not proof that anything was deleted. DNS records at the DNS provider are not removed. To switch domains, delete this one and connect the new one. Confirm the domain with the customer before calling.
|
|
29673
|
+
* @summary Delete sending domain
|
|
29674
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
29675
|
+
* @param {ReachV1ProfilesDomainsDisconnectRequest} reachV1ProfilesDomainsDisconnectRequest
|
|
29676
|
+
* @param {*} [options] Override http request option.
|
|
29677
|
+
* @throws {RequiredError}
|
|
29678
|
+
*/
|
|
29679
|
+
deleteSendingDomainV1(profileUuid: string, reachV1ProfilesDomainsDisconnectRequest: ReachV1ProfilesDomainsDisconnectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
29313
29680
|
/**
|
|
29314
29681
|
* Get the sending domain connected to the profile, its verification status and any suspended sender addresses. Campaigns only go out once a domain is connected and active, so this is the cheapest way to check that precondition before building one. A profile with no domain connected returns the same shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records behind the status, use the DNS status endpoint.
|
|
29315
29682
|
* @summary Get connected sending domain
|
|
@@ -29326,6 +29693,14 @@ export declare const ReachProfilesApiFp: (configuration?: Configuration) => {
|
|
|
29326
29693
|
* @throws {RequiredError}
|
|
29327
29694
|
*/
|
|
29328
29695
|
getProfileDomainDNSStatusV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1ProfilesDomainsDnsStatusResource>>;
|
|
29696
|
+
/**
|
|
29697
|
+
* Get the profile\'s saved sender identity and brand details. Read the default sender before creating a campaign instead of asking the customer, and reuse the brand fields when generating email content. Any field can be `null` for a profile that never filled its settings in. This does not check that the sending domain is verified, use the connected sending domain endpoint for that.
|
|
29698
|
+
* @summary Get profile settings
|
|
29699
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
29700
|
+
* @param {*} [options] Override http request option.
|
|
29701
|
+
* @throws {RequiredError}
|
|
29702
|
+
*/
|
|
29703
|
+
getProfileSettingsV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1ProfilesSettingsSettingsResource>>;
|
|
29329
29704
|
/**
|
|
29330
29705
|
* 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.
|
|
29331
29706
|
* @summary Get remaining plan limits
|
|
@@ -29349,12 +29724,39 @@ export declare const ReachProfilesApiFp: (configuration?: Configuration) => {
|
|
|
29349
29724
|
* @throws {RequiredError}
|
|
29350
29725
|
*/
|
|
29351
29726
|
listProfilesV1(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ReachV1ProfilesProfileResource>>>;
|
|
29727
|
+
/**
|
|
29728
|
+
* Change the profile\'s default sender and brand details. Send only the fields to change: every omitted field keeps its value, and `null` or an empty string clears a text field. The default sender is what campaigns created afterwards start from; existing campaigns keep their own sender. `sender_email` is only the part before the `@`, because Reach combines it with the profile\'s connected sending domain, so an address outside that domain cannot be set. Connecting a sending domain is a separate endpoint and a connected domain cannot be changed here. Returns the settings after the change.
|
|
29729
|
+
* @summary Update profile settings
|
|
29730
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
29731
|
+
* @param {ReachV1ProfilesSettingsUpdateRequest} reachV1ProfilesSettingsUpdateRequest
|
|
29732
|
+
* @param {*} [options] Override http request option.
|
|
29733
|
+
* @throws {RequiredError}
|
|
29734
|
+
*/
|
|
29735
|
+
updateProfileSettingsV1(profileUuid: string, reachV1ProfilesSettingsUpdateRequest: ReachV1ProfilesSettingsUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1ProfilesSettingsSettingsResource>>;
|
|
29352
29736
|
};
|
|
29353
29737
|
/**
|
|
29354
29738
|
* ReachProfilesApi - factory interface
|
|
29355
29739
|
* @export
|
|
29356
29740
|
*/
|
|
29357
29741
|
export declare const ReachProfilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
29742
|
+
/**
|
|
29743
|
+
* Connect a sending domain to the profile so emails can be sent from addresses on it. Connecting does not make the domain ready to send: check the DNS status endpoint next for records that are still missing. A domain the account owns or has already verified connects immediately. Any other domain starts a TXT ownership verification and returns `409`; complete the verification in Reach, then retry. Returns `422` when the profile or another profile already has the domain, the domain is blocked, or its ownership cannot be verified. An already connected domain is never replaced. On success the sender address of draft and scheduled campaigns, and of published automation and double opt-in emails, moves onto the new domain in the background, keeping the part before the `@`.
|
|
29744
|
+
* @summary Connect sending domain
|
|
29745
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
29746
|
+
* @param {ReachV1ProfilesDomainsConnectRequest} reachV1ProfilesDomainsConnectRequest
|
|
29747
|
+
* @param {*} [options] Override http request option.
|
|
29748
|
+
* @throws {RequiredError}
|
|
29749
|
+
*/
|
|
29750
|
+
connectSendingDomainV1(profileUuid: string, reachV1ProfilesDomainsConnectRequest: ReachV1ProfilesDomainsConnectRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
29751
|
+
/**
|
|
29752
|
+
* Disconnect the sending domain from the profile. The domain record is removed, so the profile has no sending domain afterwards and campaigns cannot be sent until a domain is connected again. Sender addresses already stored on campaigns, automations and settings are left untouched and keep pointing at the removed domain. A domain that is not connected to the profile also succeeds, so success is not proof that anything was deleted. DNS records at the DNS provider are not removed. To switch domains, delete this one and connect the new one. Confirm the domain with the customer before calling.
|
|
29753
|
+
* @summary Delete sending domain
|
|
29754
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
29755
|
+
* @param {ReachV1ProfilesDomainsDisconnectRequest} reachV1ProfilesDomainsDisconnectRequest
|
|
29756
|
+
* @param {*} [options] Override http request option.
|
|
29757
|
+
* @throws {RequiredError}
|
|
29758
|
+
*/
|
|
29759
|
+
deleteSendingDomainV1(profileUuid: string, reachV1ProfilesDomainsDisconnectRequest: ReachV1ProfilesDomainsDisconnectRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
29358
29760
|
/**
|
|
29359
29761
|
* Get the sending domain connected to the profile, its verification status and any suspended sender addresses. Campaigns only go out once a domain is connected and active, so this is the cheapest way to check that precondition before building one. A profile with no domain connected returns the same shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records behind the status, use the DNS status endpoint.
|
|
29360
29762
|
* @summary Get connected sending domain
|
|
@@ -29371,6 +29773,14 @@ export declare const ReachProfilesApiFactory: (configuration?: Configuration, ba
|
|
|
29371
29773
|
* @throws {RequiredError}
|
|
29372
29774
|
*/
|
|
29373
29775
|
getProfileDomainDNSStatusV1(profileUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1ProfilesDomainsDnsStatusResource>;
|
|
29776
|
+
/**
|
|
29777
|
+
* Get the profile\'s saved sender identity and brand details. Read the default sender before creating a campaign instead of asking the customer, and reuse the brand fields when generating email content. Any field can be `null` for a profile that never filled its settings in. This does not check that the sending domain is verified, use the connected sending domain endpoint for that.
|
|
29778
|
+
* @summary Get profile settings
|
|
29779
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
29780
|
+
* @param {*} [options] Override http request option.
|
|
29781
|
+
* @throws {RequiredError}
|
|
29782
|
+
*/
|
|
29783
|
+
getProfileSettingsV1(profileUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1ProfilesSettingsSettingsResource>;
|
|
29374
29784
|
/**
|
|
29375
29785
|
* 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.
|
|
29376
29786
|
* @summary Get remaining plan limits
|
|
@@ -29394,6 +29804,15 @@ export declare const ReachProfilesApiFactory: (configuration?: Configuration, ba
|
|
|
29394
29804
|
* @throws {RequiredError}
|
|
29395
29805
|
*/
|
|
29396
29806
|
listProfilesV1(options?: RawAxiosRequestConfig): AxiosPromise<Array<ReachV1ProfilesProfileResource>>;
|
|
29807
|
+
/**
|
|
29808
|
+
* Change the profile\'s default sender and brand details. Send only the fields to change: every omitted field keeps its value, and `null` or an empty string clears a text field. The default sender is what campaigns created afterwards start from; existing campaigns keep their own sender. `sender_email` is only the part before the `@`, because Reach combines it with the profile\'s connected sending domain, so an address outside that domain cannot be set. Connecting a sending domain is a separate endpoint and a connected domain cannot be changed here. Returns the settings after the change.
|
|
29809
|
+
* @summary Update profile settings
|
|
29810
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
29811
|
+
* @param {ReachV1ProfilesSettingsUpdateRequest} reachV1ProfilesSettingsUpdateRequest
|
|
29812
|
+
* @param {*} [options] Override http request option.
|
|
29813
|
+
* @throws {RequiredError}
|
|
29814
|
+
*/
|
|
29815
|
+
updateProfileSettingsV1(profileUuid: string, reachV1ProfilesSettingsUpdateRequest: ReachV1ProfilesSettingsUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1ProfilesSettingsSettingsResource>;
|
|
29397
29816
|
};
|
|
29398
29817
|
/**
|
|
29399
29818
|
* ReachProfilesApi - object-oriented interface
|
|
@@ -29402,6 +29821,26 @@ export declare const ReachProfilesApiFactory: (configuration?: Configuration, ba
|
|
|
29402
29821
|
* @extends {BaseAPI}
|
|
29403
29822
|
*/
|
|
29404
29823
|
export declare class ReachProfilesApi extends BaseAPI {
|
|
29824
|
+
/**
|
|
29825
|
+
* Connect a sending domain to the profile so emails can be sent from addresses on it. Connecting does not make the domain ready to send: check the DNS status endpoint next for records that are still missing. A domain the account owns or has already verified connects immediately. Any other domain starts a TXT ownership verification and returns `409`; complete the verification in Reach, then retry. Returns `422` when the profile or another profile already has the domain, the domain is blocked, or its ownership cannot be verified. An already connected domain is never replaced. On success the sender address of draft and scheduled campaigns, and of published automation and double opt-in emails, moves onto the new domain in the background, keeping the part before the `@`.
|
|
29826
|
+
* @summary Connect sending domain
|
|
29827
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
29828
|
+
* @param {ReachV1ProfilesDomainsConnectRequest} reachV1ProfilesDomainsConnectRequest
|
|
29829
|
+
* @param {*} [options] Override http request option.
|
|
29830
|
+
* @throws {RequiredError}
|
|
29831
|
+
* @memberof ReachProfilesApi
|
|
29832
|
+
*/
|
|
29833
|
+
connectSendingDomainV1(profileUuid: string, reachV1ProfilesDomainsConnectRequest: ReachV1ProfilesDomainsConnectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
29834
|
+
/**
|
|
29835
|
+
* Disconnect the sending domain from the profile. The domain record is removed, so the profile has no sending domain afterwards and campaigns cannot be sent until a domain is connected again. Sender addresses already stored on campaigns, automations and settings are left untouched and keep pointing at the removed domain. A domain that is not connected to the profile also succeeds, so success is not proof that anything was deleted. DNS records at the DNS provider are not removed. To switch domains, delete this one and connect the new one. Confirm the domain with the customer before calling.
|
|
29836
|
+
* @summary Delete sending domain
|
|
29837
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
29838
|
+
* @param {ReachV1ProfilesDomainsDisconnectRequest} reachV1ProfilesDomainsDisconnectRequest
|
|
29839
|
+
* @param {*} [options] Override http request option.
|
|
29840
|
+
* @throws {RequiredError}
|
|
29841
|
+
* @memberof ReachProfilesApi
|
|
29842
|
+
*/
|
|
29843
|
+
deleteSendingDomainV1(profileUuid: string, reachV1ProfilesDomainsDisconnectRequest: ReachV1ProfilesDomainsDisconnectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
29405
29844
|
/**
|
|
29406
29845
|
* Get the sending domain connected to the profile, its verification status and any suspended sender addresses. Campaigns only go out once a domain is connected and active, so this is the cheapest way to check that precondition before building one. A profile with no domain connected returns the same shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records behind the status, use the DNS status endpoint.
|
|
29407
29846
|
* @summary Get connected sending domain
|
|
@@ -29420,6 +29859,15 @@ export declare class ReachProfilesApi extends BaseAPI {
|
|
|
29420
29859
|
* @memberof ReachProfilesApi
|
|
29421
29860
|
*/
|
|
29422
29861
|
getProfileDomainDNSStatusV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1ProfilesDomainsDnsStatusResource, any, {}, any>>;
|
|
29862
|
+
/**
|
|
29863
|
+
* Get the profile\'s saved sender identity and brand details. Read the default sender before creating a campaign instead of asking the customer, and reuse the brand fields when generating email content. Any field can be `null` for a profile that never filled its settings in. This does not check that the sending domain is verified, use the connected sending domain endpoint for that.
|
|
29864
|
+
* @summary Get profile settings
|
|
29865
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
29866
|
+
* @param {*} [options] Override http request option.
|
|
29867
|
+
* @throws {RequiredError}
|
|
29868
|
+
* @memberof ReachProfilesApi
|
|
29869
|
+
*/
|
|
29870
|
+
getProfileSettingsV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1ProfilesSettingsSettingsResource, any, {}, any>>;
|
|
29423
29871
|
/**
|
|
29424
29872
|
* 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.
|
|
29425
29873
|
* @summary Get remaining plan limits
|
|
@@ -29446,6 +29894,16 @@ export declare class ReachProfilesApi extends BaseAPI {
|
|
|
29446
29894
|
* @memberof ReachProfilesApi
|
|
29447
29895
|
*/
|
|
29448
29896
|
listProfilesV1(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1ProfilesProfileResource[], any, {}, any>>;
|
|
29897
|
+
/**
|
|
29898
|
+
* Change the profile\'s default sender and brand details. Send only the fields to change: every omitted field keeps its value, and `null` or an empty string clears a text field. The default sender is what campaigns created afterwards start from; existing campaigns keep their own sender. `sender_email` is only the part before the `@`, because Reach combines it with the profile\'s connected sending domain, so an address outside that domain cannot be set. Connecting a sending domain is a separate endpoint and a connected domain cannot be changed here. Returns the settings after the change.
|
|
29899
|
+
* @summary Update profile settings
|
|
29900
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
29901
|
+
* @param {ReachV1ProfilesSettingsUpdateRequest} reachV1ProfilesSettingsUpdateRequest
|
|
29902
|
+
* @param {*} [options] Override http request option.
|
|
29903
|
+
* @throws {RequiredError}
|
|
29904
|
+
* @memberof ReachProfilesApi
|
|
29905
|
+
*/
|
|
29906
|
+
updateProfileSettingsV1(profileUuid: string, reachV1ProfilesSettingsUpdateRequest: ReachV1ProfilesSettingsUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1ProfilesSettingsSettingsResource, any, {}, any>>;
|
|
29449
29907
|
}
|
|
29450
29908
|
/**
|
|
29451
29909
|
* ReachSegmentsApi - axios parameter creator
|