hostinger-api-sdk 1.32.0 → 1.33.0

package/base.ts

@@ -3,7 +3,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.34.0
+ * API Version: 1.35.0
  *
  * NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
  * If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api

package/common.ts

@@ -3,7 +3,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.34.0
+ * API Version: 1.35.0
  *
  * NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
  * If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api

package/configuration.ts

@@ -3,7 +3,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.34.0
+ * API Version: 1.35.0
  *
  * NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
  * If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
@@ -48,7 +48,7 @@ export class Configuration {
         this.baseOptions = {
             ...param.baseOptions,
             headers: {
-                'User-Agent': "hostinger-typescript-sdk/1.32.0",
+                'User-Agent': "hostinger-typescript-sdk/1.33.0",
                 ...param.baseOptions?.headers,
             },
         };

package/dist/api.d.ts

@@ -1,7 +1,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.34.0
+ * API Version: 1.35.0
  *
  * NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
  * If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
@@ -7671,6 +7671,25 @@ export interface ReachListContactsV1200Response {
      */
     'meta': CommonSchemaPaginationMetaSchema;
 }
+/**
+ *
+ * @export
+ * @interface ReachListFormsV1200Response
+ */
+export interface ReachListFormsV1200Response {
+    /**
+     * Array of [`Reach.V1.Forms.FormResource`](#model/reachv1formsformresource)
+     * @type {Array<ReachV1FormsFormResource>}
+     * @memberof ReachListFormsV1200Response
+     */
+    'data': Array<ReachV1FormsFormResource>;
+    /**
+     *
+     * @type {CommonSchemaPaginationMetaSchema}
+     * @memberof ReachListFormsV1200Response
+     */
+    'meta': CommonSchemaPaginationMetaSchema;
+}
 /**
  *
  * @export
@@ -9491,6 +9510,206 @@ export interface ReachV1ContactsUpdateRequestFieldsInner {
      */
     'selected_option_uuids': Array<string>;
 }
+/**
+ *
+ * @export
+ * @interface ReachV1FormsFormDetailsResource
+ */
+export interface ReachV1FormsFormDetailsResource {
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1FormsFormDetailsResource
+     */
+    'uuid': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1FormsFormDetailsResource
+     */
+    'name': string;
+    /**
+     * A `paused` form keeps its template online but stops accepting submissions.
+     * @type {string}
+     * @memberof ReachV1FormsFormDetailsResource
+     */
+    'status': ReachV1FormsFormDetailsResourceStatusEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1FormsFormDetailsResource
+     */
+    'type': ReachV1FormsFormDetailsResourceTypeEnum;
+    /**
+     *
+     * @type {ReachV1FormsFormTemplateDetailsResource}
+     * @memberof ReachV1FormsFormDetailsResource
+     */
+    'template': ReachV1FormsFormTemplateDetailsResource;
+    /**
+     * Tags applied to every contact this form captures.
+     * @type {Array<ReachV1FormsFormTagResource>}
+     * @memberof ReachV1FormsFormDetailsResource
+     */
+    'tags': Array<ReachV1FormsFormTagResource>;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1FormsFormDetailsResource
+     */
+    'created_at': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1FormsFormDetailsResource
+     */
+    'updated_at': string | null;
+}
+export declare const ReachV1FormsFormDetailsResourceStatusEnum: {
+    readonly Active: "active";
+    readonly Paused: "paused";
+    readonly Draft: "draft";
+};
+export type ReachV1FormsFormDetailsResourceStatusEnum = typeof ReachV1FormsFormDetailsResourceStatusEnum[keyof typeof ReachV1FormsFormDetailsResourceStatusEnum];
+export declare const ReachV1FormsFormDetailsResourceTypeEnum: {
+    readonly Form: "form";
+};
+export type ReachV1FormsFormDetailsResourceTypeEnum = typeof ReachV1FormsFormDetailsResourceTypeEnum[keyof typeof ReachV1FormsFormDetailsResourceTypeEnum];
+/**
+ *
+ * @export
+ * @interface ReachV1FormsFormResource
+ */
+export interface ReachV1FormsFormResource {
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1FormsFormResource
+     */
+    'uuid': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1FormsFormResource
+     */
+    'name': string;
+    /**
+     * A `paused` form keeps its template online but stops accepting submissions.
+     * @type {string}
+     * @memberof ReachV1FormsFormResource
+     */
+    'status': ReachV1FormsFormResourceStatusEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1FormsFormResource
+     */
+    'type': ReachV1FormsFormResourceTypeEnum;
+    /**
+     *
+     * @type {ReachV1FormsFormTemplateResource}
+     * @memberof ReachV1FormsFormResource
+     */
+    'template': ReachV1FormsFormTemplateResource;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1FormsFormResource
+     */
+    'created_at': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1FormsFormResource
+     */
+    'updated_at': string | null;
+}
+export declare const ReachV1FormsFormResourceStatusEnum: {
+    readonly Active: "active";
+    readonly Paused: "paused";
+    readonly Draft: "draft";
+};
+export type ReachV1FormsFormResourceStatusEnum = typeof ReachV1FormsFormResourceStatusEnum[keyof typeof ReachV1FormsFormResourceStatusEnum];
+export declare const ReachV1FormsFormResourceTypeEnum: {
+    readonly Form: "form";
+};
+export type ReachV1FormsFormResourceTypeEnum = typeof ReachV1FormsFormResourceTypeEnum[keyof typeof ReachV1FormsFormResourceTypeEnum];
+/**
+ * A tag applied to every contact this form captures.
+ * @export
+ * @interface ReachV1FormsFormTagResource
+ */
+export interface ReachV1FormsFormTagResource {
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1FormsFormTagResource
+     */
+    'uuid': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1FormsFormTagResource
+     */
+    'value': string;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof ReachV1FormsFormTagResource
+     */
+    'type': ReachV1FormsFormTagResourceTypeEnum;
+}
+export declare const ReachV1FormsFormTagResourceTypeEnum: {
+    readonly Form: "form";
+    readonly Custom: "custom";
+    readonly Import: "import";
+    readonly System: "system";
+};
+export type ReachV1FormsFormTagResourceTypeEnum = typeof ReachV1FormsFormTagResourceTypeEnum[keyof typeof ReachV1FormsFormTagResourceTypeEnum];
+/**
+ * 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.
+ * @export
+ * @interface ReachV1FormsFormTemplateDetailsResource
+ */
+export interface ReachV1FormsFormTemplateDetailsResource {
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1FormsFormTemplateDetailsResource
+     */
+    'uuid': string | null;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof ReachV1FormsFormTemplateDetailsResource
+     */
+    'path': string | null;
+    /**
+     * Publicly reachable URL of the template HTML.
+     * @type {string}
+     * @memberof ReachV1FormsFormTemplateDetailsResource
+     */
+    'url': string | null;
+}
+/**
+ * The rendered form template. Both fields stay null until the template has been generated.
+ * @export
+ * @interface ReachV1FormsFormTemplateResource
+ */
+export interface ReachV1FormsFormTemplateResource {
+    /**
+     *
+     * @type {string}
+     * @memberof ReachV1FormsFormTemplateResource
+     */
+    'uuid': string | null;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof ReachV1FormsFormTemplateResource
+     */
+    'path': string | null;
+}
 /**
  *
  * @export
@@ -9597,6 +9816,68 @@ export interface ReachV1ProfilesDomainsDnsStatusResource {
      */
     'dmarc': ReachV1ProfilesDomainsDnsRecordStatus;
 }
+/**
+ * Allowance, consumption and headroom of a single plan limit for the current period.
+ * @export
+ * @interface ReachV1ProfilesPlanLimitUsageResource
+ */
+export interface ReachV1ProfilesPlanLimitUsageResource {
+    /**
+     * The allowance for the current period.
+     * @type {number}
+     * @memberof ReachV1ProfilesPlanLimitUsageResource
+     */
+    'limit': number;
+    /**
+     * How much of the allowance has been consumed so far.
+     * @type {number}
+     * @memberof ReachV1ProfilesPlanLimitUsageResource
+     */
+    'used': number;
+    /**
+     * Headroom left. Floors at 0, so it never reports a negative overage.
+     * @type {number}
+     * @memberof ReachV1ProfilesPlanLimitUsageResource
+     */
+    'remaining': number;
+}
+/**
+ * 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.
+ * @export
+ * @interface ReachV1ProfilesPlanLimitsResource
+ */
+export interface ReachV1ProfilesPlanLimitsResource {
+    /**
+     *
+     * @type {ReachV1ProfilesPlanLimitUsageResource}
+     * @memberof ReachV1ProfilesPlanLimitsResource
+     */
+    'emails': ReachV1ProfilesPlanLimitUsageResource;
+    /**
+     *
+     * @type {ReachV1ProfilesPlanLimitUsageResource}
+     * @memberof ReachV1ProfilesPlanLimitsResource
+     */
+    'recipients': ReachV1ProfilesPlanLimitUsageResource;
+    /**
+     *
+     * @type {ReachV1ProfilesPlanLimitUsageResource}
+     * @memberof ReachV1ProfilesPlanLimitsResource
+     */
+    'ai_credits': ReachV1ProfilesPlanLimitUsageResource;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof ReachV1ProfilesPlanLimitsResource
+     */
+    'period_start': string;
+    /**
+     * End of the current period, that is the last moment of the calendar month.
+     * @type {string}
+     * @memberof ReachV1ProfilesPlanLimitsResource
+     */
+    'period_end': string;
+}
 /**
  *
  * @export
@@ -21308,6 +21589,147 @@ export declare const ListProfileContactsV1SubscriptionStatusEnum: {
     readonly Pending: "pending";
 };
 export type ListProfileContactsV1SubscriptionStatusEnum = typeof ListProfileContactsV1SubscriptionStatusEnum[keyof typeof ListProfileContactsV1SubscriptionStatusEnum];
+/**
+ * ReachFormsApi - axios parameter creator
+ * @export
+ */
+export declare const ReachFormsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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.
+     * @summary Delete form
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} formUuid Form uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteFormV1: (profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Get form details
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} formUuid Form uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFormDetailsV1: (profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary List forms
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {number} [page] Page number
+     * @param {number} [perPage] Number of items per page
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFormsV1: (profileUuid: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ReachFormsApi - functional programming interface
+ * @export
+ */
+export declare const ReachFormsApiFp: (configuration?: Configuration) => {
+    /**
+     * 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.
+     * @summary Delete form
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} formUuid Form uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteFormV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
+    /**
+     * 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.
+     * @summary Get form details
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} formUuid Form uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFormDetailsV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1FormsFormDetailsResource>>;
+    /**
+     * 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.
+     * @summary List forms
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {number} [page] Page number
+     * @param {number} [perPage] Number of items per page
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFormsV1(profileUuid: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachListFormsV1200Response>>;
+};
+/**
+ * ReachFormsApi - factory interface
+ * @export
+ */
+export declare const ReachFormsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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.
+     * @summary Delete form
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} formUuid Form uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteFormV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
+    /**
+     * 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.
+     * @summary Get form details
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} formUuid Form uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFormDetailsV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1FormsFormDetailsResource>;
+    /**
+     * 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.
+     * @summary List forms
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {number} [page] Page number
+     * @param {number} [perPage] Number of items per page
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFormsV1(profileUuid: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise<ReachListFormsV1200Response>;
+};
+/**
+ * ReachFormsApi - object-oriented interface
+ * @export
+ * @class ReachFormsApi
+ * @extends {BaseAPI}
+ */
+export declare class ReachFormsApi extends BaseAPI {
+    /**
+     * 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.
+     * @summary Delete form
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} formUuid Form uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReachFormsApi
+     */
+    deleteFormV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
+    /**
+     * 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.
+     * @summary Get form details
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {string} formUuid Form uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReachFormsApi
+     */
+    getFormDetailsV1(profileUuid: string, formUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1FormsFormDetailsResource, any, {}, any>>;
+    /**
+     * 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.
+     * @summary List forms
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {number} [page] Page number
+     * @param {number} [perPage] Number of items per page
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReachFormsApi
+     */
+    listFormsV1(profileUuid: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachListFormsV1200Response, any, {}, any>>;
+}
 /**
  * ReachProfilesApi - axios parameter creator
  * @export
@@ -21321,6 +21743,14 @@ export declare const ReachProfilesApiAxiosParamCreator: (configuration?: Configu
      * @throws {RequiredError}
      */
     getProfileDomainDNSStatusV1: (profileUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Get remaining plan limits
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRemainingPlanLimitsV1: (profileUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * This endpoint returns all profiles available to the client, including their basic information.
      * @summary List Profiles
@@ -21342,6 +21772,14 @@ export declare const ReachProfilesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getProfileDomainDNSStatusV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1ProfilesDomainsDnsStatusResource>>;
+    /**
+     * 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.
+     * @summary Get remaining plan limits
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRemainingPlanLimitsV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReachV1ProfilesPlanLimitsResource>>;
     /**
      * This endpoint returns all profiles available to the client, including their basic information.
      * @summary List Profiles
@@ -21363,6 +21801,14 @@ export declare const ReachProfilesApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     getProfileDomainDNSStatusV1(profileUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1ProfilesDomainsDnsStatusResource>;
+    /**
+     * 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.
+     * @summary Get remaining plan limits
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRemainingPlanLimitsV1(profileUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ReachV1ProfilesPlanLimitsResource>;
     /**
      * This endpoint returns all profiles available to the client, including their basic information.
      * @summary List Profiles
@@ -21387,6 +21833,15 @@ export declare class ReachProfilesApi extends BaseAPI {
      * @memberof ReachProfilesApi
      */
     getProfileDomainDNSStatusV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1ProfilesDomainsDnsStatusResource, any, {}, any>>;
+    /**
+     * 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.
+     * @summary Get remaining plan limits
+     * @param {string} profileUuid Profile uuid parameter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReachProfilesApi
+     */
+    getRemainingPlanLimitsV1(profileUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReachV1ProfilesPlanLimitsResource, any, {}, any>>;
     /**
      * This endpoint returns all profiles available to the client, including their basic information.
      * @summary List Profiles