hostinger-api-sdk 1.32.0 → 1.33.1

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/dist/esm/api.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * Hostinger API
3
3
  *
4
- * API Version: 1.34.0
4
+ * API Version: 1.35.1
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
@@ -4930,11 +4930,24 @@ export interface HostingV1NodeJsBuildOptionsResource {
4930
4930
  }
4931
4931
  export declare const HostingV1NodeJsBuildOptionsResourceAppTypeEnum: {
4932
4932
  readonly CreateReactApp: "create-react-app";
4933
+ readonly Gatsby: "gatsby";
4933
4934
  readonly Vite: "vite";
4934
4935
  readonly Angular: "angular";
4935
4936
  readonly React: "react";
4936
4937
  readonly Vue: "vue";
4937
4938
  readonly Parcel: "parcel";
4939
+ readonly Next: "next";
4940
+ readonly Nuxt: "nuxt";
4941
+ readonly Nest: "nest";
4942
+ readonly Express: "express";
4943
+ readonly Fastify: "fastify";
4944
+ readonly Astro: "astro";
4945
+ readonly Svelte: "svelte";
4946
+ readonly SvelteKit: "svelte-kit";
4947
+ readonly Hono: "hono";
4948
+ readonly ReactRouter: "react-router";
4949
+ readonly Nitro: "nitro";
4950
+ readonly Other: "other";
4938
4951
  };
4939
4952
  export type HostingV1NodeJsBuildOptionsResourceAppTypeEnum = typeof HostingV1NodeJsBuildOptionsResourceAppTypeEnum[keyof typeof HostingV1NodeJsBuildOptionsResourceAppTypeEnum];
4940
4953
  export declare const HostingV1NodeJsBuildOptionsResourcePackageManagerEnum: {
@@ -5055,14 +5068,24 @@ export declare const HostingV1NodeJsCreateFromArchiveRequestNodeVersionEnum: {
5055
5068
  export type HostingV1NodeJsCreateFromArchiveRequestNodeVersionEnum = typeof HostingV1NodeJsCreateFromArchiveRequestNodeVersionEnum[keyof typeof HostingV1NodeJsCreateFromArchiveRequestNodeVersionEnum];
5056
5069
  export declare const HostingV1NodeJsCreateFromArchiveRequestAppTypeEnum: {
5057
5070
  readonly CreateReactApp: "create-react-app";
5071
+ readonly Gatsby: "gatsby";
5058
5072
  readonly Vite: "vite";
5059
5073
  readonly Angular: "angular";
5060
5074
  readonly React: "react";
5061
5075
  readonly Vue: "vue";
5062
5076
  readonly Parcel: "parcel";
5077
+ readonly Next: "next";
5078
+ readonly Nuxt: "nuxt";
5079
+ readonly Nest: "nest";
5063
5080
  readonly Express: "express";
5064
5081
  readonly Fastify: "fastify";
5065
- readonly Nest: "nest";
5082
+ readonly Astro: "astro";
5083
+ readonly Svelte: "svelte";
5084
+ readonly SvelteKit: "svelte-kit";
5085
+ readonly Hono: "hono";
5086
+ readonly ReactRouter: "react-router";
5087
+ readonly Nitro: "nitro";
5088
+ readonly Other: "other";
5066
5089
  };
5067
5090
  export type HostingV1NodeJsCreateFromArchiveRequestAppTypeEnum = typeof HostingV1NodeJsCreateFromArchiveRequestAppTypeEnum[keyof typeof HostingV1NodeJsCreateFromArchiveRequestAppTypeEnum];
5068
5091
  export declare const HostingV1NodeJsCreateFromArchiveRequestPackageManagerEnum: {
@@ -7671,6 +7694,25 @@ export interface ReachListContactsV1200Response {
7671
7694
  */
7672
7695
  'meta': CommonSchemaPaginationMetaSchema;
7673
7696
  }
7697
+ /**
7698
+ *
7699
+ * @export
7700
+ * @interface ReachListFormsV1200Response
7701
+ */
7702
+ export interface ReachListFormsV1200Response {
7703
+ /**
7704
+ * Array of [`Reach.V1.Forms.FormResource`](#model/reachv1formsformresource)
7705
+ * @type {Array<ReachV1FormsFormResource>}
7706
+ * @memberof ReachListFormsV1200Response
7707
+ */
7708
+ 'data': Array<ReachV1FormsFormResource>;
7709
+ /**
7710
+ *
7711
+ * @type {CommonSchemaPaginationMetaSchema}
7712
+ * @memberof ReachListFormsV1200Response
7713
+ */
7714
+ 'meta': CommonSchemaPaginationMetaSchema;
7715
+ }
7674
7716
  /**
7675
7717
  *
7676
7718
  * @export
@@ -9491,6 +9533,206 @@ export interface ReachV1ContactsUpdateRequestFieldsInner {
9491
9533
  */
9492
9534
  'selected_option_uuids': Array<string>;
9493
9535
  }
9536
+ /**
9537
+ *
9538
+ * @export
9539
+ * @interface ReachV1FormsFormDetailsResource
9540
+ */
9541
+ export interface ReachV1FormsFormDetailsResource {
9542
+ /**
9543
+ *
9544
+ * @type {string}
9545
+ * @memberof ReachV1FormsFormDetailsResource
9546
+ */
9547
+ 'uuid': string;
9548
+ /**
9549
+ *
9550
+ * @type {string}
9551
+ * @memberof ReachV1FormsFormDetailsResource
9552
+ */
9553
+ 'name': string;
9554
+ /**
9555
+ * A `paused` form keeps its template online but stops accepting submissions.
9556
+ * @type {string}
9557
+ * @memberof ReachV1FormsFormDetailsResource
9558
+ */
9559
+ 'status': ReachV1FormsFormDetailsResourceStatusEnum;
9560
+ /**
9561
+ *
9562
+ * @type {string}
9563
+ * @memberof ReachV1FormsFormDetailsResource
9564
+ */
9565
+ 'type': ReachV1FormsFormDetailsResourceTypeEnum;
9566
+ /**
9567
+ *
9568
+ * @type {ReachV1FormsFormTemplateDetailsResource}
9569
+ * @memberof ReachV1FormsFormDetailsResource
9570
+ */
9571
+ 'template': ReachV1FormsFormTemplateDetailsResource;
9572
+ /**
9573
+ * Tags applied to every contact this form captures.
9574
+ * @type {Array<ReachV1FormsFormTagResource>}
9575
+ * @memberof ReachV1FormsFormDetailsResource
9576
+ */
9577
+ 'tags': Array<ReachV1FormsFormTagResource>;
9578
+ /**
9579
+ *
9580
+ * @type {string}
9581
+ * @memberof ReachV1FormsFormDetailsResource
9582
+ */
9583
+ 'created_at': string;
9584
+ /**
9585
+ *
9586
+ * @type {string}
9587
+ * @memberof ReachV1FormsFormDetailsResource
9588
+ */
9589
+ 'updated_at': string | null;
9590
+ }
9591
+ export declare const ReachV1FormsFormDetailsResourceStatusEnum: {
9592
+ readonly Active: "active";
9593
+ readonly Paused: "paused";
9594
+ readonly Draft: "draft";
9595
+ };
9596
+ export type ReachV1FormsFormDetailsResourceStatusEnum = typeof ReachV1FormsFormDetailsResourceStatusEnum[keyof typeof ReachV1FormsFormDetailsResourceStatusEnum];
9597
+ export declare const ReachV1FormsFormDetailsResourceTypeEnum: {
9598
+ readonly Form: "form";
9599
+ };
9600
+ export type ReachV1FormsFormDetailsResourceTypeEnum = typeof ReachV1FormsFormDetailsResourceTypeEnum[keyof typeof ReachV1FormsFormDetailsResourceTypeEnum];
9601
+ /**
9602
+ *
9603
+ * @export
9604
+ * @interface ReachV1FormsFormResource
9605
+ */
9606
+ export interface ReachV1FormsFormResource {
9607
+ /**
9608
+ *
9609
+ * @type {string}
9610
+ * @memberof ReachV1FormsFormResource
9611
+ */
9612
+ 'uuid': string;
9613
+ /**
9614
+ *
9615
+ * @type {string}
9616
+ * @memberof ReachV1FormsFormResource
9617
+ */
9618
+ 'name': string;
9619
+ /**
9620
+ * A `paused` form keeps its template online but stops accepting submissions.
9621
+ * @type {string}
9622
+ * @memberof ReachV1FormsFormResource
9623
+ */
9624
+ 'status': ReachV1FormsFormResourceStatusEnum;
9625
+ /**
9626
+ *
9627
+ * @type {string}
9628
+ * @memberof ReachV1FormsFormResource
9629
+ */
9630
+ 'type': ReachV1FormsFormResourceTypeEnum;
9631
+ /**
9632
+ *
9633
+ * @type {ReachV1FormsFormTemplateResource}
9634
+ * @memberof ReachV1FormsFormResource
9635
+ */
9636
+ 'template': ReachV1FormsFormTemplateResource;
9637
+ /**
9638
+ *
9639
+ * @type {string}
9640
+ * @memberof ReachV1FormsFormResource
9641
+ */
9642
+ 'created_at': string;
9643
+ /**
9644
+ *
9645
+ * @type {string}
9646
+ * @memberof ReachV1FormsFormResource
9647
+ */
9648
+ 'updated_at': string | null;
9649
+ }
9650
+ export declare const ReachV1FormsFormResourceStatusEnum: {
9651
+ readonly Active: "active";
9652
+ readonly Paused: "paused";
9653
+ readonly Draft: "draft";
9654
+ };
9655
+ export type ReachV1FormsFormResourceStatusEnum = typeof ReachV1FormsFormResourceStatusEnum[keyof typeof ReachV1FormsFormResourceStatusEnum];
9656
+ export declare const ReachV1FormsFormResourceTypeEnum: {
9657
+ readonly Form: "form";
9658
+ };
9659
+ export type ReachV1FormsFormResourceTypeEnum = typeof ReachV1FormsFormResourceTypeEnum[keyof typeof ReachV1FormsFormResourceTypeEnum];
9660
+ /**
9661
+ * A tag applied to every contact this form captures.
9662
+ * @export
9663
+ * @interface ReachV1FormsFormTagResource
9664
+ */
9665
+ export interface ReachV1FormsFormTagResource {
9666
+ /**
9667
+ *
9668
+ * @type {string}
9669
+ * @memberof ReachV1FormsFormTagResource
9670
+ */
9671
+ 'uuid': string;
9672
+ /**
9673
+ *
9674
+ * @type {string}
9675
+ * @memberof ReachV1FormsFormTagResource
9676
+ */
9677
+ 'value': string;
9678
+ /**
9679
+ * How the tag came about. `custom` covers the tags you create yourself, `import` the ones added by contact imports, and `form` and `system` the ones Reach creates on its own. Every form gets a `form:{name}` tag when it is created.
9680
+ * @type {string}
9681
+ * @memberof ReachV1FormsFormTagResource
9682
+ */
9683
+ 'type': ReachV1FormsFormTagResourceTypeEnum;
9684
+ }
9685
+ export declare const ReachV1FormsFormTagResourceTypeEnum: {
9686
+ readonly Form: "form";
9687
+ readonly Custom: "custom";
9688
+ readonly Import: "import";
9689
+ readonly System: "system";
9690
+ };
9691
+ export type ReachV1FormsFormTagResourceTypeEnum = typeof ReachV1FormsFormTagResourceTypeEnum[keyof typeof ReachV1FormsFormTagResourceTypeEnum];
9692
+ /**
9693
+ * The rendered form template. There is no ready-made embed snippet - either serve the HTML behind `url` or build your own embed around the form uuid. All fields stay null until the template has been generated.
9694
+ * @export
9695
+ * @interface ReachV1FormsFormTemplateDetailsResource
9696
+ */
9697
+ export interface ReachV1FormsFormTemplateDetailsResource {
9698
+ /**
9699
+ *
9700
+ * @type {string}
9701
+ * @memberof ReachV1FormsFormTemplateDetailsResource
9702
+ */
9703
+ 'uuid': string | null;
9704
+ /**
9705
+ * Storage path of the template HTML, relative to the storage directory of this profile. `url` already includes that prefix, so prefer it unless you resolve storage paths yourself.
9706
+ * @type {string}
9707
+ * @memberof ReachV1FormsFormTemplateDetailsResource
9708
+ */
9709
+ 'path': string | null;
9710
+ /**
9711
+ * Publicly reachable URL of the template HTML.
9712
+ * @type {string}
9713
+ * @memberof ReachV1FormsFormTemplateDetailsResource
9714
+ */
9715
+ 'url': string | null;
9716
+ }
9717
+ /**
9718
+ * The rendered form template. Both fields stay null until the template has been generated.
9719
+ * @export
9720
+ * @interface ReachV1FormsFormTemplateResource
9721
+ */
9722
+ export interface ReachV1FormsFormTemplateResource {
9723
+ /**
9724
+ *
9725
+ * @type {string}
9726
+ * @memberof ReachV1FormsFormTemplateResource
9727
+ */
9728
+ 'uuid': string | null;
9729
+ /**
9730
+ * Storage path of the template HTML, relative to the storage directory of this profile. Get the form details to receive a directly usable URL instead.
9731
+ * @type {string}
9732
+ * @memberof ReachV1FormsFormTemplateResource
9733
+ */
9734
+ 'path': string | null;
9735
+ }
9494
9736
  /**
9495
9737
  *
9496
9738
  * @export
@@ -9597,6 +9839,68 @@ export interface ReachV1ProfilesDomainsDnsStatusResource {
9597
9839
  */
9598
9840
  'dmarc': ReachV1ProfilesDomainsDnsRecordStatus;
9599
9841
  }
9842
+ /**
9843
+ * Allowance, consumption and headroom of a single plan limit for the current period.
9844
+ * @export
9845
+ * @interface ReachV1ProfilesPlanLimitUsageResource
9846
+ */
9847
+ export interface ReachV1ProfilesPlanLimitUsageResource {
9848
+ /**
9849
+ * The allowance for the current period.
9850
+ * @type {number}
9851
+ * @memberof ReachV1ProfilesPlanLimitUsageResource
9852
+ */
9853
+ 'limit': number;
9854
+ /**
9855
+ * How much of the allowance has been consumed so far.
9856
+ * @type {number}
9857
+ * @memberof ReachV1ProfilesPlanLimitUsageResource
9858
+ */
9859
+ 'used': number;
9860
+ /**
9861
+ * Headroom left. Floors at 0, so it never reports a negative overage.
9862
+ * @type {number}
9863
+ * @memberof ReachV1ProfilesPlanLimitUsageResource
9864
+ */
9865
+ 'remaining': number;
9866
+ }
9867
+ /**
9868
+ * What the plan allows and what is left of it for the current period. `emails` counts every email sent. `recipients` counts the distinct contacts emailed - it is not the size of the contact list, a contact emailed three times counts once and a contact never emailed does not count at all. `ai_credits` counts the AI generations used, and its limit includes any extra credits bought on top of the plan.
9869
+ * @export
9870
+ * @interface ReachV1ProfilesPlanLimitsResource
9871
+ */
9872
+ export interface ReachV1ProfilesPlanLimitsResource {
9873
+ /**
9874
+ *
9875
+ * @type {ReachV1ProfilesPlanLimitUsageResource}
9876
+ * @memberof ReachV1ProfilesPlanLimitsResource
9877
+ */
9878
+ 'emails': ReachV1ProfilesPlanLimitUsageResource;
9879
+ /**
9880
+ *
9881
+ * @type {ReachV1ProfilesPlanLimitUsageResource}
9882
+ * @memberof ReachV1ProfilesPlanLimitsResource
9883
+ */
9884
+ 'recipients': ReachV1ProfilesPlanLimitUsageResource;
9885
+ /**
9886
+ *
9887
+ * @type {ReachV1ProfilesPlanLimitUsageResource}
9888
+ * @memberof ReachV1ProfilesPlanLimitsResource
9889
+ */
9890
+ 'ai_credits': ReachV1ProfilesPlanLimitUsageResource;
9891
+ /**
9892
+ * Start of the current period. Periods are calendar months rather than billing anniversaries, so the counters reset at midnight UTC on the 1st no matter when the subscription started.
9893
+ * @type {string}
9894
+ * @memberof ReachV1ProfilesPlanLimitsResource
9895
+ */
9896
+ 'period_start': string;
9897
+ /**
9898
+ * End of the current period, that is the last moment of the calendar month.
9899
+ * @type {string}
9900
+ * @memberof ReachV1ProfilesPlanLimitsResource
9901
+ */
9902
+ 'period_end': string;
9903
+ }
9600
9904
  /**
9601
9905
  *
9602
9906
  * @export
@@ -21308,6 +21612,147 @@ export declare const ListProfileContactsV1SubscriptionStatusEnum: {
21308
21612
  readonly Pending: "pending";
21309
21613
  };
21310
21614
  export type ListProfileContactsV1SubscriptionStatusEnum = typeof ListProfileContactsV1SubscriptionStatusEnum[keyof typeof ListProfileContactsV1SubscriptionStatusEnum];
21615
+ /**
21616
+ * ReachFormsApi - axios parameter creator
21617
+ * @export
21618
+ */
21619
+ export declare const ReachFormsApiAxiosParamCreator: (configuration?: Configuration) => {
21620
+ /**
21621
+ * 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.
21622
+ * @summary Delete form
21623
+ * @param {string} profileUuid Profile uuid parameter
21624
+ * @param {string} formUuid Form uuid parameter
21625
+ * @param {*} [options] Override http request option.
21626
+ * @throws {RequiredError}
21627
+ */
21628
+ deleteFormV1: (profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
21629
+ /**
21630
+ * 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.
21631
+ * @summary Get form details
21632
+ * @param {string} profileUuid Profile uuid parameter
21633
+ * @param {string} formUuid Form uuid parameter
21634
+ * @param {*} [options] Override http request option.
21635
+ * @throws {RequiredError}
21636
+ */
21637
+ getFormDetailsV1: (profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
21638
+ /**
21639
+ * 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.
21640
+ * @summary List forms
21641
+ * @param {string} profileUuid Profile uuid parameter
21642
+ * @param {number} [page] Page number
21643
+ * @param {number} [perPage] Number of items per page
21644
+ * @param {*} [options] Override http request option.
21645
+ * @throws {RequiredError}
21646
+ */
21647
+ listFormsV1: (profileUuid: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
21648
+ };
21649
+ /**
21650
+ * ReachFormsApi - functional programming interface
21651
+ * @export
21652
+ */
21653
+ export declare const ReachFormsApiFp: (configuration?: Configuration) => {
21654
+ /**
21655
+ * 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.
21656
+ * @summary Delete form
21657
+ * @param {string} profileUuid Profile uuid parameter
21658
+ * @param {string} formUuid Form uuid parameter
21659
+ * @param {*} [options] Override http request option.
21660
+ * @throws {RequiredError}
21661
+ */
21662
+ deleteFormV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
21663
+ /**
21664
+ * 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.
21665
+ * @summary Get form details
21666
+ * @param {string} profileUuid Profile uuid parameter
21667
+ * @param {string} formUuid Form uuid parameter
21668
+ * @param {*} [options] Override http request option.
21669
+ * @throws {RequiredError}
21670
+ */
21671
+ getFormDetailsV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1FormsFormDetailsResource>>;
21672
+ /**
21673
+ * 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.
21674
+ * @summary List forms
21675
+ * @param {string} profileUuid Profile uuid parameter
21676
+ * @param {number} [page] Page number
21677
+ * @param {number} [perPage] Number of items per page
21678
+ * @param {*} [options] Override http request option.
21679
+ * @throws {RequiredError}
21680
+ */
21681
+ listFormsV1(profileUuid: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachListFormsV1200Response>>;
21682
+ };
21683
+ /**
21684
+ * ReachFormsApi - factory interface
21685
+ * @export
21686
+ */
21687
+ export declare const ReachFormsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
21688
+ /**
21689
+ * 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.
21690
+ * @summary Delete form
21691
+ * @param {string} profileUuid Profile uuid parameter
21692
+ * @param {string} formUuid Form uuid parameter
21693
+ * @param {*} [options] Override http request option.
21694
+ * @throws {RequiredError}
21695
+ */
21696
+ deleteFormV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
21697
+ /**
21698
+ * 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.
21699
+ * @summary Get form details
21700
+ * @param {string} profileUuid Profile uuid parameter
21701
+ * @param {string} formUuid Form uuid parameter
21702
+ * @param {*} [options] Override http request option.
21703
+ * @throws {RequiredError}
21704
+ */
21705
+ getFormDetailsV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1FormsFormDetailsResource>;
21706
+ /**
21707
+ * 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.
21708
+ * @summary List forms
21709
+ * @param {string} profileUuid Profile uuid parameter
21710
+ * @param {number} [page] Page number
21711
+ * @param {number} [perPage] Number of items per page
21712
+ * @param {*} [options] Override http request option.
21713
+ * @throws {RequiredError}
21714
+ */
21715
+ listFormsV1(profileUuid: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise<ReachListFormsV1200Response>;
21716
+ };
21717
+ /**
21718
+ * ReachFormsApi - object-oriented interface
21719
+ * @export
21720
+ * @class ReachFormsApi
21721
+ * @extends {BaseAPI}
21722
+ */
21723
+ export declare class ReachFormsApi extends BaseAPI {
21724
+ /**
21725
+ * 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.
21726
+ * @summary Delete form
21727
+ * @param {string} profileUuid Profile uuid parameter
21728
+ * @param {string} formUuid Form uuid parameter
21729
+ * @param {*} [options] Override http request option.
21730
+ * @throws {RequiredError}
21731
+ * @memberof ReachFormsApi
21732
+ */
21733
+ deleteFormV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
21734
+ /**
21735
+ * 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.
21736
+ * @summary Get form details
21737
+ * @param {string} profileUuid Profile uuid parameter
21738
+ * @param {string} formUuid Form uuid parameter
21739
+ * @param {*} [options] Override http request option.
21740
+ * @throws {RequiredError}
21741
+ * @memberof ReachFormsApi
21742
+ */
21743
+ getFormDetailsV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1FormsFormDetailsResource, any, {}, any>>;
21744
+ /**
21745
+ * 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.
21746
+ * @summary List forms
21747
+ * @param {string} profileUuid Profile uuid parameter
21748
+ * @param {number} [page] Page number
21749
+ * @param {number} [perPage] Number of items per page
21750
+ * @param {*} [options] Override http request option.
21751
+ * @throws {RequiredError}
21752
+ * @memberof ReachFormsApi
21753
+ */
21754
+ listFormsV1(profileUuid: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachListFormsV1200Response, any, {}, any>>;
21755
+ }
21311
21756
  /**
21312
21757
  * ReachProfilesApi - axios parameter creator
21313
21758
  * @export
@@ -21321,6 +21766,14 @@ export declare const ReachProfilesApiAxiosParamCreator: (configuration?: Configu
21321
21766
  * @throws {RequiredError}
21322
21767
  */
21323
21768
  getProfileDomainDNSStatusV1: (profileUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
21769
+ /**
21770
+ * 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.
21771
+ * @summary Get remaining plan limits
21772
+ * @param {string} profileUuid Profile uuid parameter
21773
+ * @param {*} [options] Override http request option.
21774
+ * @throws {RequiredError}
21775
+ */
21776
+ getRemainingPlanLimitsV1: (profileUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
21324
21777
  /**
21325
21778
  * This endpoint returns all profiles available to the client, including their basic information.
21326
21779
  * @summary List Profiles
@@ -21342,6 +21795,14 @@ export declare const ReachProfilesApiFp: (configuration?: Configuration) => {
21342
21795
  * @throws {RequiredError}
21343
21796
  */
21344
21797
  getProfileDomainDNSStatusV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1ProfilesDomainsDnsStatusResource>>;
21798
+ /**
21799
+ * 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.
21800
+ * @summary Get remaining plan limits
21801
+ * @param {string} profileUuid Profile uuid parameter
21802
+ * @param {*} [options] Override http request option.
21803
+ * @throws {RequiredError}
21804
+ */
21805
+ getRemainingPlanLimitsV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1ProfilesPlanLimitsResource>>;
21345
21806
  /**
21346
21807
  * This endpoint returns all profiles available to the client, including their basic information.
21347
21808
  * @summary List Profiles
@@ -21363,6 +21824,14 @@ export declare const ReachProfilesApiFactory: (configuration?: Configuration, ba
21363
21824
  * @throws {RequiredError}
21364
21825
  */
21365
21826
  getProfileDomainDNSStatusV1(profileUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1ProfilesDomainsDnsStatusResource>;
21827
+ /**
21828
+ * 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.
21829
+ * @summary Get remaining plan limits
21830
+ * @param {string} profileUuid Profile uuid parameter
21831
+ * @param {*} [options] Override http request option.
21832
+ * @throws {RequiredError}
21833
+ */
21834
+ getRemainingPlanLimitsV1(profileUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1ProfilesPlanLimitsResource>;
21366
21835
  /**
21367
21836
  * This endpoint returns all profiles available to the client, including their basic information.
21368
21837
  * @summary List Profiles
@@ -21387,6 +21856,15 @@ export declare class ReachProfilesApi extends BaseAPI {
21387
21856
  * @memberof ReachProfilesApi
21388
21857
  */
21389
21858
  getProfileDomainDNSStatusV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1ProfilesDomainsDnsStatusResource, any, {}, any>>;
21859
+ /**
21860
+ * 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.
21861
+ * @summary Get remaining plan limits
21862
+ * @param {string} profileUuid Profile uuid parameter
21863
+ * @param {*} [options] Override http request option.
21864
+ * @throws {RequiredError}
21865
+ * @memberof ReachProfilesApi
21866
+ */
21867
+ getRemainingPlanLimitsV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1ProfilesPlanLimitsResource, any, {}, any>>;
21390
21868
  /**
21391
21869
  * This endpoint returns all profiles available to the client, including their basic information.
21392
21870
  * @summary List Profiles