@hostinger/sdk 1.62.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/api.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  /**
4
4
  * Hostinger API
5
5
  *
6
- * API Version: 1.62.0
6
+ * API Version: 1.64.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
@@ -14240,6 +14240,32 @@ export interface ReachV1FormsFormTemplateResource {
14240
14240
  */
14241
14241
  'path': string | null;
14242
14242
  }
14243
+ /**
14244
+ * Sending domain to connect to the profile
14245
+ * @export
14246
+ * @interface ReachV1ProfilesDomainsConnectRequest
14247
+ */
14248
+ export interface ReachV1ProfilesDomainsConnectRequest {
14249
+ /**
14250
+ *
14251
+ * @type {string}
14252
+ * @memberof ReachV1ProfilesDomainsConnectRequest
14253
+ */
14254
+ 'domain': string;
14255
+ }
14256
+ /**
14257
+ * Sending domain to disconnect from the profile
14258
+ * @export
14259
+ * @interface ReachV1ProfilesDomainsDisconnectRequest
14260
+ */
14261
+ export interface ReachV1ProfilesDomainsDisconnectRequest {
14262
+ /**
14263
+ *
14264
+ * @type {string}
14265
+ * @memberof ReachV1ProfilesDomainsDisconnectRequest
14266
+ */
14267
+ 'domain': string;
14268
+ }
14243
14269
  /**
14244
14270
  *
14245
14271
  * @export
@@ -14345,6 +14371,12 @@ export interface ReachV1ProfilesDomainsDnsStatusResource {
14345
14371
  * @memberof ReachV1ProfilesDomainsDnsStatusResource
14346
14372
  */
14347
14373
  'dmarc': ReachV1ProfilesDomainsDnsRecordStatus;
14374
+ /**
14375
+ *
14376
+ * @type {ReachV1ProfilesDomainsDnsRecordStatus}
14377
+ * @memberof ReachV1ProfilesDomainsDnsStatusResource
14378
+ */
14379
+ 'a': ReachV1ProfilesDomainsDnsRecordStatus;
14348
14380
  }
14349
14381
  /**
14350
14382
  * 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.
@@ -14623,6 +14655,284 @@ export interface ReachV1ProfilesProfileResourceProfilesInner {
14623
14655
  */
14624
14656
  'updated_at': string;
14625
14657
  }
14658
+ /**
14659
+ * 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`.
14660
+ * @export
14661
+ * @interface ReachV1ProfilesSettingsSettingsResource
14662
+ */
14663
+ export interface ReachV1ProfilesSettingsSettingsResource {
14664
+ /**
14665
+ *
14666
+ * @type {string}
14667
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14668
+ */
14669
+ 'brand_name': string | null;
14670
+ /**
14671
+ *
14672
+ * @type {string}
14673
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14674
+ */
14675
+ 'website_url': string | null;
14676
+ /**
14677
+ *
14678
+ * @type {string}
14679
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14680
+ */
14681
+ 'business_address': string | null;
14682
+ /**
14683
+ *
14684
+ * @type {string}
14685
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14686
+ */
14687
+ 'privacy_policy_url': string | null;
14688
+ /**
14689
+ *
14690
+ * @type {string}
14691
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14692
+ */
14693
+ 'accent_color': string | null;
14694
+ /**
14695
+ *
14696
+ * @type {string}
14697
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14698
+ */
14699
+ 'button_color': string | null;
14700
+ /**
14701
+ *
14702
+ * @type {string}
14703
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14704
+ */
14705
+ 'background_color': string | null;
14706
+ /**
14707
+ *
14708
+ * @type {string}
14709
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14710
+ */
14711
+ 'text_color': string | null;
14712
+ /**
14713
+ *
14714
+ * @type {string}
14715
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14716
+ */
14717
+ 'links_color': string | null;
14718
+ /**
14719
+ * Button text colour.
14720
+ * @type {string}
14721
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14722
+ */
14723
+ 'button_text': string | null;
14724
+ /**
14725
+ * Button corner radius in pixels.
14726
+ * @type {number}
14727
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14728
+ */
14729
+ 'button_corners': number | null;
14730
+ /**
14731
+ * Body and button font.
14732
+ * @type {string}
14733
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14734
+ */
14735
+ 'font_family': string | null;
14736
+ /**
14737
+ *
14738
+ * @type {string}
14739
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14740
+ */
14741
+ 'heading_font_family': string | null;
14742
+ /**
14743
+ *
14744
+ * @type {string}
14745
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14746
+ */
14747
+ 'logo_url': string | null;
14748
+ /**
14749
+ *
14750
+ * @type {Array<string>}
14751
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14752
+ */
14753
+ 'social_links': Array<string> | null;
14754
+ /**
14755
+ * Social profile links keyed by platform.
14756
+ * @type {{ [key: string]: string; }}
14757
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14758
+ */
14759
+ 'socials': { [key: string]: string; } | null;
14760
+ /**
14761
+ *
14762
+ * @type {string}
14763
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14764
+ */
14765
+ 'about': string | null;
14766
+ /**
14767
+ *
14768
+ * @type {Array<string>}
14769
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14770
+ */
14771
+ 'keywords': Array<string> | null;
14772
+ /**
14773
+ *
14774
+ * @type {Array<string>}
14775
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14776
+ */
14777
+ 'topics': Array<string> | null;
14778
+ /**
14779
+ *
14780
+ * @type {Array<string>}
14781
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14782
+ */
14783
+ 'selling_points': Array<string> | null;
14784
+ /**
14785
+ * Default sender name that campaigns created afterwards start from.
14786
+ * @type {string}
14787
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14788
+ */
14789
+ 'sender_name': string | null;
14790
+ /**
14791
+ * Part of the default sender address before the `@`. It is combined with the profile\'s connected sending domain, see the connected sending domain endpoint.
14792
+ * @type {string}
14793
+ * @memberof ReachV1ProfilesSettingsSettingsResource
14794
+ */
14795
+ 'sender_email': string | null;
14796
+ }
14797
+ /**
14798
+ * Settings to change. Only the fields sent are changed; `null` or an empty string clears a text field.
14799
+ * @export
14800
+ * @interface ReachV1ProfilesSettingsUpdateRequest
14801
+ */
14802
+ export interface ReachV1ProfilesSettingsUpdateRequest {
14803
+ /**
14804
+ *
14805
+ * @type {string}
14806
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14807
+ */
14808
+ 'brand_name': string | null;
14809
+ /**
14810
+ *
14811
+ * @type {string}
14812
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14813
+ */
14814
+ 'website_url': string | null;
14815
+ /**
14816
+ *
14817
+ * @type {string}
14818
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14819
+ */
14820
+ 'business_address': string | null;
14821
+ /**
14822
+ *
14823
+ * @type {string}
14824
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14825
+ */
14826
+ 'privacy_policy_url': string | null;
14827
+ /**
14828
+ *
14829
+ * @type {string}
14830
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14831
+ */
14832
+ 'accent_color': string | null;
14833
+ /**
14834
+ *
14835
+ * @type {string}
14836
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14837
+ */
14838
+ 'button_color': string | null;
14839
+ /**
14840
+ *
14841
+ * @type {string}
14842
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14843
+ */
14844
+ 'background_color': string | null;
14845
+ /**
14846
+ *
14847
+ * @type {string}
14848
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14849
+ */
14850
+ 'text_color': string | null;
14851
+ /**
14852
+ *
14853
+ * @type {string}
14854
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14855
+ */
14856
+ 'links_color': string | null;
14857
+ /**
14858
+ * Button text colour.
14859
+ * @type {string}
14860
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14861
+ */
14862
+ 'button_text': string | null;
14863
+ /**
14864
+ *
14865
+ * @type {number}
14866
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14867
+ */
14868
+ 'button_corners': number | null;
14869
+ /**
14870
+ *
14871
+ * @type {string}
14872
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14873
+ */
14874
+ 'font_family': string | null;
14875
+ /**
14876
+ *
14877
+ * @type {string}
14878
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14879
+ */
14880
+ 'heading_font_family': string | null;
14881
+ /**
14882
+ * Public image URL. Logo uploads are not supported.
14883
+ * @type {string}
14884
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14885
+ */
14886
+ 'logo_url': string | null;
14887
+ /**
14888
+ *
14889
+ * @type {Array<string>}
14890
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14891
+ */
14892
+ 'social_links': Array<string>;
14893
+ /**
14894
+ * Social profile links keyed by platform.
14895
+ * @type {{ [key: string]: string; }}
14896
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14897
+ */
14898
+ 'socials': { [key: string]: string; } | null;
14899
+ /**
14900
+ *
14901
+ * @type {string}
14902
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14903
+ */
14904
+ 'about': string | null;
14905
+ /**
14906
+ *
14907
+ * @type {Array<string>}
14908
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14909
+ */
14910
+ 'keywords': Array<string> | null;
14911
+ /**
14912
+ *
14913
+ * @type {Array<string>}
14914
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14915
+ */
14916
+ 'topics': Array<string> | null;
14917
+ /**
14918
+ *
14919
+ * @type {Array<string>}
14920
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14921
+ */
14922
+ 'selling_points': Array<string> | null;
14923
+ /**
14924
+ * Default sender name. Letters, numbers and spaces only.
14925
+ * @type {string}
14926
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14927
+ */
14928
+ 'sender_name': string | null;
14929
+ /**
14930
+ * 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.
14931
+ * @type {string}
14932
+ * @memberof ReachV1ProfilesSettingsUpdateRequest
14933
+ */
14934
+ 'sender_email': string | null;
14935
+ }
14626
14936
  /**
14627
14937
  * Create a reusable email template
14628
14938
  * @export
@@ -42337,6 +42647,94 @@ export class ReachFormsApi extends BaseAPI {
42337
42647
  */
42338
42648
  export const ReachProfilesApiAxiosParamCreator = function (configuration?: Configuration) {
42339
42649
  return {
42650
+ /**
42651
+ * 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 `@`.
42652
+ * @summary Connect sending domain
42653
+ * @param {string} profileUuid Profile uuid parameter
42654
+ * @param {ReachV1ProfilesDomainsConnectRequest} reachV1ProfilesDomainsConnectRequest
42655
+ * @param {*} [options] Override http request option.
42656
+ * @throws {RequiredError}
42657
+ */
42658
+ connectSendingDomainV1: async (profileUuid: string, reachV1ProfilesDomainsConnectRequest: ReachV1ProfilesDomainsConnectRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
42659
+ // verify required parameter 'profileUuid' is not null or undefined
42660
+ assertParamExists('connectSendingDomainV1', 'profileUuid', profileUuid)
42661
+ // verify required parameter 'reachV1ProfilesDomainsConnectRequest' is not null or undefined
42662
+ assertParamExists('connectSendingDomainV1', 'reachV1ProfilesDomainsConnectRequest', reachV1ProfilesDomainsConnectRequest)
42663
+ const localVarPath = `/api/reach/v1/profiles/{profileUuid}/domains`
42664
+ .replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
42665
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
42666
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
42667
+ let baseOptions;
42668
+ if (configuration) {
42669
+ baseOptions = configuration.baseOptions;
42670
+ }
42671
+
42672
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
42673
+ const localVarHeaderParameter = {} as any;
42674
+ const localVarQueryParameter = {} as any;
42675
+
42676
+ // authentication apiToken required
42677
+ // http bearer authentication required
42678
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
42679
+
42680
+
42681
+
42682
+ localVarHeaderParameter['Content-Type'] = 'application/json';
42683
+
42684
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
42685
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
42686
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
42687
+ localVarRequestOptions.data = serializeDataIfNeeded(reachV1ProfilesDomainsConnectRequest, localVarRequestOptions, configuration)
42688
+
42689
+ return {
42690
+ url: toPathString(localVarUrlObj),
42691
+ options: localVarRequestOptions,
42692
+ };
42693
+ },
42694
+ /**
42695
+ * 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.
42696
+ * @summary Delete sending domain
42697
+ * @param {string} profileUuid Profile uuid parameter
42698
+ * @param {ReachV1ProfilesDomainsDisconnectRequest} reachV1ProfilesDomainsDisconnectRequest
42699
+ * @param {*} [options] Override http request option.
42700
+ * @throws {RequiredError}
42701
+ */
42702
+ deleteSendingDomainV1: async (profileUuid: string, reachV1ProfilesDomainsDisconnectRequest: ReachV1ProfilesDomainsDisconnectRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
42703
+ // verify required parameter 'profileUuid' is not null or undefined
42704
+ assertParamExists('deleteSendingDomainV1', 'profileUuid', profileUuid)
42705
+ // verify required parameter 'reachV1ProfilesDomainsDisconnectRequest' is not null or undefined
42706
+ assertParamExists('deleteSendingDomainV1', 'reachV1ProfilesDomainsDisconnectRequest', reachV1ProfilesDomainsDisconnectRequest)
42707
+ const localVarPath = `/api/reach/v1/profiles/{profileUuid}/domains`
42708
+ .replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
42709
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
42710
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
42711
+ let baseOptions;
42712
+ if (configuration) {
42713
+ baseOptions = configuration.baseOptions;
42714
+ }
42715
+
42716
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
42717
+ const localVarHeaderParameter = {} as any;
42718
+ const localVarQueryParameter = {} as any;
42719
+
42720
+ // authentication apiToken required
42721
+ // http bearer authentication required
42722
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
42723
+
42724
+
42725
+
42726
+ localVarHeaderParameter['Content-Type'] = 'application/json';
42727
+
42728
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
42729
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
42730
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
42731
+ localVarRequestOptions.data = serializeDataIfNeeded(reachV1ProfilesDomainsDisconnectRequest, localVarRequestOptions, configuration)
42732
+
42733
+ return {
42734
+ url: toPathString(localVarUrlObj),
42735
+ options: localVarRequestOptions,
42736
+ };
42737
+ },
42340
42738
  /**
42341
42739
  * 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.
42342
42740
  * @summary Get connected sending domain
@@ -42404,6 +42802,44 @@ export const ReachProfilesApiAxiosParamCreator = function (configuration?: Confi
42404
42802
 
42405
42803
 
42406
42804
 
42805
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
42806
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
42807
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
42808
+
42809
+ return {
42810
+ url: toPathString(localVarUrlObj),
42811
+ options: localVarRequestOptions,
42812
+ };
42813
+ },
42814
+ /**
42815
+ * 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.
42816
+ * @summary Get profile settings
42817
+ * @param {string} profileUuid Profile uuid parameter
42818
+ * @param {*} [options] Override http request option.
42819
+ * @throws {RequiredError}
42820
+ */
42821
+ getProfileSettingsV1: async (profileUuid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
42822
+ // verify required parameter 'profileUuid' is not null or undefined
42823
+ assertParamExists('getProfileSettingsV1', 'profileUuid', profileUuid)
42824
+ const localVarPath = `/api/reach/v1/profiles/{profileUuid}/settings`
42825
+ .replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
42826
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
42827
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
42828
+ let baseOptions;
42829
+ if (configuration) {
42830
+ baseOptions = configuration.baseOptions;
42831
+ }
42832
+
42833
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
42834
+ const localVarHeaderParameter = {} as any;
42835
+ const localVarQueryParameter = {} as any;
42836
+
42837
+ // authentication apiToken required
42838
+ // http bearer authentication required
42839
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
42840
+
42841
+
42842
+
42407
42843
  setSearchParams(localVarUrlObj, localVarQueryParameter);
42408
42844
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
42409
42845
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -42518,6 +42954,50 @@ export const ReachProfilesApiAxiosParamCreator = function (configuration?: Confi
42518
42954
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
42519
42955
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
42520
42956
 
42957
+ return {
42958
+ url: toPathString(localVarUrlObj),
42959
+ options: localVarRequestOptions,
42960
+ };
42961
+ },
42962
+ /**
42963
+ * 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.
42964
+ * @summary Update profile settings
42965
+ * @param {string} profileUuid Profile uuid parameter
42966
+ * @param {ReachV1ProfilesSettingsUpdateRequest} reachV1ProfilesSettingsUpdateRequest
42967
+ * @param {*} [options] Override http request option.
42968
+ * @throws {RequiredError}
42969
+ */
42970
+ updateProfileSettingsV1: async (profileUuid: string, reachV1ProfilesSettingsUpdateRequest: ReachV1ProfilesSettingsUpdateRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
42971
+ // verify required parameter 'profileUuid' is not null or undefined
42972
+ assertParamExists('updateProfileSettingsV1', 'profileUuid', profileUuid)
42973
+ // verify required parameter 'reachV1ProfilesSettingsUpdateRequest' is not null or undefined
42974
+ assertParamExists('updateProfileSettingsV1', 'reachV1ProfilesSettingsUpdateRequest', reachV1ProfilesSettingsUpdateRequest)
42975
+ const localVarPath = `/api/reach/v1/profiles/{profileUuid}/settings`
42976
+ .replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
42977
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
42978
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
42979
+ let baseOptions;
42980
+ if (configuration) {
42981
+ baseOptions = configuration.baseOptions;
42982
+ }
42983
+
42984
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
42985
+ const localVarHeaderParameter = {} as any;
42986
+ const localVarQueryParameter = {} as any;
42987
+
42988
+ // authentication apiToken required
42989
+ // http bearer authentication required
42990
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
42991
+
42992
+
42993
+
42994
+ localVarHeaderParameter['Content-Type'] = 'application/json';
42995
+
42996
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
42997
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
42998
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
42999
+ localVarRequestOptions.data = serializeDataIfNeeded(reachV1ProfilesSettingsUpdateRequest, localVarRequestOptions, configuration)
43000
+
42521
43001
  return {
42522
43002
  url: toPathString(localVarUrlObj),
42523
43003
  options: localVarRequestOptions,
@@ -42533,6 +43013,32 @@ export const ReachProfilesApiAxiosParamCreator = function (configuration?: Confi
42533
43013
  export const ReachProfilesApiFp = function(configuration?: Configuration) {
42534
43014
  const localVarAxiosParamCreator = ReachProfilesApiAxiosParamCreator(configuration)
42535
43015
  return {
43016
+ /**
43017
+ * 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 `@`.
43018
+ * @summary Connect sending domain
43019
+ * @param {string} profileUuid Profile uuid parameter
43020
+ * @param {ReachV1ProfilesDomainsConnectRequest} reachV1ProfilesDomainsConnectRequest
43021
+ * @param {*} [options] Override http request option.
43022
+ * @throws {RequiredError}
43023
+ */
43024
+ async connectSendingDomainV1(profileUuid: string, reachV1ProfilesDomainsConnectRequest: ReachV1ProfilesDomainsConnectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>> {
43025
+ const localVarAxiosArgs = await localVarAxiosParamCreator.connectSendingDomainV1(profileUuid, reachV1ProfilesDomainsConnectRequest, options);
43026
+ const localVarOperationServerBasePath = operationServerMap['ReachProfilesApi.connectSendingDomainV1']?.[0]?.url;
43027
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
43028
+ },
43029
+ /**
43030
+ * 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.
43031
+ * @summary Delete sending domain
43032
+ * @param {string} profileUuid Profile uuid parameter
43033
+ * @param {ReachV1ProfilesDomainsDisconnectRequest} reachV1ProfilesDomainsDisconnectRequest
43034
+ * @param {*} [options] Override http request option.
43035
+ * @throws {RequiredError}
43036
+ */
43037
+ async deleteSendingDomainV1(profileUuid: string, reachV1ProfilesDomainsDisconnectRequest: ReachV1ProfilesDomainsDisconnectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>> {
43038
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSendingDomainV1(profileUuid, reachV1ProfilesDomainsDisconnectRequest, options);
43039
+ const localVarOperationServerBasePath = operationServerMap['ReachProfilesApi.deleteSendingDomainV1']?.[0]?.url;
43040
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
43041
+ },
42536
43042
  /**
42537
43043
  * 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.
42538
43044
  * @summary Get connected sending domain
@@ -42557,6 +43063,18 @@ export const ReachProfilesApiFp = function(configuration?: Configuration) {
42557
43063
  const localVarOperationServerBasePath = operationServerMap['ReachProfilesApi.getProfileDomainDNSStatusV1']?.[0]?.url;
42558
43064
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
42559
43065
  },
43066
+ /**
43067
+ * 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.
43068
+ * @summary Get profile settings
43069
+ * @param {string} profileUuid Profile uuid parameter
43070
+ * @param {*} [options] Override http request option.
43071
+ * @throws {RequiredError}
43072
+ */
43073
+ async getProfileSettingsV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1ProfilesSettingsSettingsResource>> {
43074
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProfileSettingsV1(profileUuid, options);
43075
+ const localVarOperationServerBasePath = operationServerMap['ReachProfilesApi.getProfileSettingsV1']?.[0]?.url;
43076
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
43077
+ },
42560
43078
  /**
42561
43079
  * 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.
42562
43080
  * @summary Get remaining plan limits
@@ -42592,6 +43110,19 @@ export const ReachProfilesApiFp = function(configuration?: Configuration) {
42592
43110
  const localVarOperationServerBasePath = operationServerMap['ReachProfilesApi.listProfilesV1']?.[0]?.url;
42593
43111
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
42594
43112
  },
43113
+ /**
43114
+ * 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.
43115
+ * @summary Update profile settings
43116
+ * @param {string} profileUuid Profile uuid parameter
43117
+ * @param {ReachV1ProfilesSettingsUpdateRequest} reachV1ProfilesSettingsUpdateRequest
43118
+ * @param {*} [options] Override http request option.
43119
+ * @throws {RequiredError}
43120
+ */
43121
+ async updateProfileSettingsV1(profileUuid: string, reachV1ProfilesSettingsUpdateRequest: ReachV1ProfilesSettingsUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1ProfilesSettingsSettingsResource>> {
43122
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateProfileSettingsV1(profileUuid, reachV1ProfilesSettingsUpdateRequest, options);
43123
+ const localVarOperationServerBasePath = operationServerMap['ReachProfilesApi.updateProfileSettingsV1']?.[0]?.url;
43124
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
43125
+ },
42595
43126
  }
42596
43127
  };
42597
43128
 
@@ -42602,6 +43133,28 @@ export const ReachProfilesApiFp = function(configuration?: Configuration) {
42602
43133
  export const ReachProfilesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
42603
43134
  const localVarFp = ReachProfilesApiFp(configuration)
42604
43135
  return {
43136
+ /**
43137
+ * 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 `@`.
43138
+ * @summary Connect sending domain
43139
+ * @param {string} profileUuid Profile uuid parameter
43140
+ * @param {ReachV1ProfilesDomainsConnectRequest} reachV1ProfilesDomainsConnectRequest
43141
+ * @param {*} [options] Override http request option.
43142
+ * @throws {RequiredError}
43143
+ */
43144
+ connectSendingDomainV1(profileUuid: string, reachV1ProfilesDomainsConnectRequest: ReachV1ProfilesDomainsConnectRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource> {
43145
+ return localVarFp.connectSendingDomainV1(profileUuid, reachV1ProfilesDomainsConnectRequest, options).then((request) => request(axios, basePath));
43146
+ },
43147
+ /**
43148
+ * 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.
43149
+ * @summary Delete sending domain
43150
+ * @param {string} profileUuid Profile uuid parameter
43151
+ * @param {ReachV1ProfilesDomainsDisconnectRequest} reachV1ProfilesDomainsDisconnectRequest
43152
+ * @param {*} [options] Override http request option.
43153
+ * @throws {RequiredError}
43154
+ */
43155
+ deleteSendingDomainV1(profileUuid: string, reachV1ProfilesDomainsDisconnectRequest: ReachV1ProfilesDomainsDisconnectRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource> {
43156
+ return localVarFp.deleteSendingDomainV1(profileUuid, reachV1ProfilesDomainsDisconnectRequest, options).then((request) => request(axios, basePath));
43157
+ },
42605
43158
  /**
42606
43159
  * 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.
42607
43160
  * @summary Get connected sending domain
@@ -42622,6 +43175,16 @@ export const ReachProfilesApiFactory = function (configuration?: Configuration,
42622
43175
  getProfileDomainDNSStatusV1(profileUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1ProfilesDomainsDnsStatusResource> {
42623
43176
  return localVarFp.getProfileDomainDNSStatusV1(profileUuid, options).then((request) => request(axios, basePath));
42624
43177
  },
43178
+ /**
43179
+ * 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.
43180
+ * @summary Get profile settings
43181
+ * @param {string} profileUuid Profile uuid parameter
43182
+ * @param {*} [options] Override http request option.
43183
+ * @throws {RequiredError}
43184
+ */
43185
+ getProfileSettingsV1(profileUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1ProfilesSettingsSettingsResource> {
43186
+ return localVarFp.getProfileSettingsV1(profileUuid, options).then((request) => request(axios, basePath));
43187
+ },
42625
43188
  /**
42626
43189
  * 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.
42627
43190
  * @summary Get remaining plan limits
@@ -42651,6 +43214,17 @@ export const ReachProfilesApiFactory = function (configuration?: Configuration,
42651
43214
  listProfilesV1(options?: RawAxiosRequestConfig): AxiosPromise<Array<ReachV1ProfilesProfileResource>> {
42652
43215
  return localVarFp.listProfilesV1(options).then((request) => request(axios, basePath));
42653
43216
  },
43217
+ /**
43218
+ * 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.
43219
+ * @summary Update profile settings
43220
+ * @param {string} profileUuid Profile uuid parameter
43221
+ * @param {ReachV1ProfilesSettingsUpdateRequest} reachV1ProfilesSettingsUpdateRequest
43222
+ * @param {*} [options] Override http request option.
43223
+ * @throws {RequiredError}
43224
+ */
43225
+ updateProfileSettingsV1(profileUuid: string, reachV1ProfilesSettingsUpdateRequest: ReachV1ProfilesSettingsUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1ProfilesSettingsSettingsResource> {
43226
+ return localVarFp.updateProfileSettingsV1(profileUuid, reachV1ProfilesSettingsUpdateRequest, options).then((request) => request(axios, basePath));
43227
+ },
42654
43228
  };
42655
43229
  };
42656
43230
 
@@ -42661,6 +43235,32 @@ export const ReachProfilesApiFactory = function (configuration?: Configuration,
42661
43235
  * @extends {BaseAPI}
42662
43236
  */
42663
43237
  export class ReachProfilesApi extends BaseAPI {
43238
+ /**
43239
+ * 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 `@`.
43240
+ * @summary Connect sending domain
43241
+ * @param {string} profileUuid Profile uuid parameter
43242
+ * @param {ReachV1ProfilesDomainsConnectRequest} reachV1ProfilesDomainsConnectRequest
43243
+ * @param {*} [options] Override http request option.
43244
+ * @throws {RequiredError}
43245
+ * @memberof ReachProfilesApi
43246
+ */
43247
+ public connectSendingDomainV1(profileUuid: string, reachV1ProfilesDomainsConnectRequest: ReachV1ProfilesDomainsConnectRequest, options?: RawAxiosRequestConfig) {
43248
+ return ReachProfilesApiFp(this.configuration).connectSendingDomainV1(profileUuid, reachV1ProfilesDomainsConnectRequest, options).then((request) => request(this.axios, this.basePath));
43249
+ }
43250
+
43251
+ /**
43252
+ * 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.
43253
+ * @summary Delete sending domain
43254
+ * @param {string} profileUuid Profile uuid parameter
43255
+ * @param {ReachV1ProfilesDomainsDisconnectRequest} reachV1ProfilesDomainsDisconnectRequest
43256
+ * @param {*} [options] Override http request option.
43257
+ * @throws {RequiredError}
43258
+ * @memberof ReachProfilesApi
43259
+ */
43260
+ public deleteSendingDomainV1(profileUuid: string, reachV1ProfilesDomainsDisconnectRequest: ReachV1ProfilesDomainsDisconnectRequest, options?: RawAxiosRequestConfig) {
43261
+ return ReachProfilesApiFp(this.configuration).deleteSendingDomainV1(profileUuid, reachV1ProfilesDomainsDisconnectRequest, options).then((request) => request(this.axios, this.basePath));
43262
+ }
43263
+
42664
43264
  /**
42665
43265
  * 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.
42666
43266
  * @summary Get connected sending domain
@@ -42685,6 +43285,18 @@ export class ReachProfilesApi extends BaseAPI {
42685
43285
  return ReachProfilesApiFp(this.configuration).getProfileDomainDNSStatusV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
42686
43286
  }
42687
43287
 
43288
+ /**
43289
+ * 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.
43290
+ * @summary Get profile settings
43291
+ * @param {string} profileUuid Profile uuid parameter
43292
+ * @param {*} [options] Override http request option.
43293
+ * @throws {RequiredError}
43294
+ * @memberof ReachProfilesApi
43295
+ */
43296
+ public getProfileSettingsV1(profileUuid: string, options?: RawAxiosRequestConfig) {
43297
+ return ReachProfilesApiFp(this.configuration).getProfileSettingsV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
43298
+ }
43299
+
42688
43300
  /**
42689
43301
  * 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.
42690
43302
  * @summary Get remaining plan limits
@@ -42719,6 +43331,19 @@ export class ReachProfilesApi extends BaseAPI {
42719
43331
  public listProfilesV1(options?: RawAxiosRequestConfig) {
42720
43332
  return ReachProfilesApiFp(this.configuration).listProfilesV1(options).then((request) => request(this.axios, this.basePath));
42721
43333
  }
43334
+
43335
+ /**
43336
+ * 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.
43337
+ * @summary Update profile settings
43338
+ * @param {string} profileUuid Profile uuid parameter
43339
+ * @param {ReachV1ProfilesSettingsUpdateRequest} reachV1ProfilesSettingsUpdateRequest
43340
+ * @param {*} [options] Override http request option.
43341
+ * @throws {RequiredError}
43342
+ * @memberof ReachProfilesApi
43343
+ */
43344
+ public updateProfileSettingsV1(profileUuid: string, reachV1ProfilesSettingsUpdateRequest: ReachV1ProfilesSettingsUpdateRequest, options?: RawAxiosRequestConfig) {
43345
+ return ReachProfilesApiFp(this.configuration).updateProfileSettingsV1(profileUuid, reachV1ProfilesSettingsUpdateRequest, options).then((request) => request(this.axios, this.basePath));
43346
+ }
42722
43347
  }
42723
43348
 
42724
43349