telnyx 7.27.0 → 7.29.0

package/resources/email/dedicated-ips/actions.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.mts","sourceRoot":"","sources":["../../../src/resources/email/dedicated-ips/actions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,eAAe,4BAAwB;AACnD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC,uBAAuB,CAAC;IAIzG;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC,uBAAuB,CAAC;IAItG;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC,uBAAuB,CAAC;IAIvG;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC,uBAAuB,CAAC;CAGvG"}

package/resources/email/dedicated-ips/actions.d.ts

@@ -0,0 +1,73 @@
+import { APIResource } from "../../../core/resource.js";
+import * as DedicatedIPsAPI from "./dedicated-ips.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+/**
+ * Purchase and manage dedicated sending IP addresses for your Telnyx email traffic.
+ */
+export declare class Actions extends APIResource {
+    /**
+     * Manually complete the warm-up ramp (`warming_up` to `active`), bypassing the
+     * schedule. Use only for an IP already warmed elsewhere. Completion sets
+     * `warmup.progress` to `100`, clears `warmup.daily_cap`, and applies the
+     * ramp-complete allowance to the current UTC day: `warmup.today.cap` becomes
+     * `100000000`, `warmup.today.granted` keeps the sends already released today, and
+     * `warmup.today.remaining` becomes `cap` minus `granted`. Once completion applies
+     * this allowance, an exhausted stage allowance does not block the next eligible
+     * first-attempt send. The response reports these values. On an `active` IP,
+     * `warmup.progress` and `warmup.daily_cap` are informational: they can keep
+     * earlier values after a suspension is lifted and do not limit sending.
+     *
+     * @example
+     * ```ts
+     * const dedicatedIPShowResponse =
+     *   await client.email.dedicatedIPs.actions.completeWarmup(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    completeWarmup(id: string, options?: RequestOptions): APIPromise<DedicatedIPsAPI.DedicatedIPShowResponse>;
+    /**
+     * Pause the warm-up ramp at its current stage. While paused, the IP releases no
+     * first-attempt sends from hold and the ramp does not advance. Only a `warming_up`
+     * IP can be paused; pausing an already paused IP refreshes `paused_at`.
+     *
+     * @example
+     * ```ts
+     * const dedicatedIPShowResponse =
+     *   await client.email.dedicatedIPs.actions.pauseWarmup(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    pauseWarmup(id: string, options?: RequestOptions): APIPromise<DedicatedIPsAPI.DedicatedIPShowResponse>;
+    /**
+     * Resume a paused warm-up ramp from its held stage. Only a `warming_up` IP can be
+     * resumed; resuming a ramp that is not paused returns the IP unchanged.
+     *
+     * @example
+     * ```ts
+     * const dedicatedIPShowResponse =
+     *   await client.email.dedicatedIPs.actions.resumeWarmup(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    resumeWarmup(id: string, options?: RequestOptions): APIPromise<DedicatedIPsAPI.DedicatedIPShowResponse>;
+    /**
+     * Start the warm-up ramp (`provisioning` to `warming_up`). The ramp never starts
+     * automatically. Only a `provisioning` IP can be started; a `suspended` IP returns
+     * `409`. Starting does not check DNS: the IP carries mail only while
+     * `dns_confirmed_at` is set and the IP is in a pool that routes mail.
+     *
+     * @example
+     * ```ts
+     * const dedicatedIPShowResponse =
+     *   await client.email.dedicatedIPs.actions.startWarmup(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    startWarmup(id: string, options?: RequestOptions): APIPromise<DedicatedIPsAPI.DedicatedIPShowResponse>;
+}
+//# sourceMappingURL=actions.d.ts.map

package/resources/email/dedicated-ips/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../src/resources/email/dedicated-ips/actions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,eAAe,2BAAwB;AACnD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC,uBAAuB,CAAC;IAIzG;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC,uBAAuB,CAAC;IAItG;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC,uBAAuB,CAAC;IAIvG;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC,uBAAuB,CAAC;CAGvG"}

package/resources/email/dedicated-ips/actions.js

@@ -0,0 +1,84 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Actions = void 0;
+const resource_1 = require("../../../core/resource.js");
+const path_1 = require("../../../internal/utils/path.js");
+/**
+ * Purchase and manage dedicated sending IP addresses for your Telnyx email traffic.
+ */
+class Actions extends resource_1.APIResource {
+    /**
+     * Manually complete the warm-up ramp (`warming_up` to `active`), bypassing the
+     * schedule. Use only for an IP already warmed elsewhere. Completion sets
+     * `warmup.progress` to `100`, clears `warmup.daily_cap`, and applies the
+     * ramp-complete allowance to the current UTC day: `warmup.today.cap` becomes
+     * `100000000`, `warmup.today.granted` keeps the sends already released today, and
+     * `warmup.today.remaining` becomes `cap` minus `granted`. Once completion applies
+     * this allowance, an exhausted stage allowance does not block the next eligible
+     * first-attempt send. The response reports these values. On an `active` IP,
+     * `warmup.progress` and `warmup.daily_cap` are informational: they can keep
+     * earlier values after a suspension is lifted and do not limit sending.
+     *
+     * @example
+     * ```ts
+     * const dedicatedIPShowResponse =
+     *   await client.email.dedicatedIPs.actions.completeWarmup(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    completeWarmup(id, options) {
+        return this._client.post((0, path_1.path) `/email/dedicated_ips/${id}/actions/complete_warmup`, options);
+    }
+    /**
+     * Pause the warm-up ramp at its current stage. While paused, the IP releases no
+     * first-attempt sends from hold and the ramp does not advance. Only a `warming_up`
+     * IP can be paused; pausing an already paused IP refreshes `paused_at`.
+     *
+     * @example
+     * ```ts
+     * const dedicatedIPShowResponse =
+     *   await client.email.dedicatedIPs.actions.pauseWarmup(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    pauseWarmup(id, options) {
+        return this._client.post((0, path_1.path) `/email/dedicated_ips/${id}/actions/pause_warmup`, options);
+    }
+    /**
+     * Resume a paused warm-up ramp from its held stage. Only a `warming_up` IP can be
+     * resumed; resuming a ramp that is not paused returns the IP unchanged.
+     *
+     * @example
+     * ```ts
+     * const dedicatedIPShowResponse =
+     *   await client.email.dedicatedIPs.actions.resumeWarmup(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    resumeWarmup(id, options) {
+        return this._client.post((0, path_1.path) `/email/dedicated_ips/${id}/actions/resume_warmup`, options);
+    }
+    /**
+     * Start the warm-up ramp (`provisioning` to `warming_up`). The ramp never starts
+     * automatically. Only a `provisioning` IP can be started; a `suspended` IP returns
+     * `409`. Starting does not check DNS: the IP carries mail only while
+     * `dns_confirmed_at` is set and the IP is in a pool that routes mail.
+     *
+     * @example
+     * ```ts
+     * const dedicatedIPShowResponse =
+     *   await client.email.dedicatedIPs.actions.startWarmup(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    startWarmup(id, options) {
+        return this._client.post((0, path_1.path) `/email/dedicated_ips/${id}/actions/start_warmup`, options);
+    }
+}
+exports.Actions = Actions;
+//# sourceMappingURL=actions.js.map

package/resources/email/dedicated-ips/actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../../src/resources/email/dedicated-ips/actions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAU,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAU,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAU,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,wBAAwB,EAAE,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;CACF;AA3ED,0BA2EC"}

package/resources/email/dedicated-ips/actions.mjs

@@ -0,0 +1,80 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+import { path } from "../../../internal/utils/path.mjs";
+/**
+ * Purchase and manage dedicated sending IP addresses for your Telnyx email traffic.
+ */
+export class Actions extends APIResource {
+    /**
+     * Manually complete the warm-up ramp (`warming_up` to `active`), bypassing the
+     * schedule. Use only for an IP already warmed elsewhere. Completion sets
+     * `warmup.progress` to `100`, clears `warmup.daily_cap`, and applies the
+     * ramp-complete allowance to the current UTC day: `warmup.today.cap` becomes
+     * `100000000`, `warmup.today.granted` keeps the sends already released today, and
+     * `warmup.today.remaining` becomes `cap` minus `granted`. Once completion applies
+     * this allowance, an exhausted stage allowance does not block the next eligible
+     * first-attempt send. The response reports these values. On an `active` IP,
+     * `warmup.progress` and `warmup.daily_cap` are informational: they can keep
+     * earlier values after a suspension is lifted and do not limit sending.
+     *
+     * @example
+     * ```ts
+     * const dedicatedIPShowResponse =
+     *   await client.email.dedicatedIPs.actions.completeWarmup(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    completeWarmup(id, options) {
+        return this._client.post(path `/email/dedicated_ips/${id}/actions/complete_warmup`, options);
+    }
+    /**
+     * Pause the warm-up ramp at its current stage. While paused, the IP releases no
+     * first-attempt sends from hold and the ramp does not advance. Only a `warming_up`
+     * IP can be paused; pausing an already paused IP refreshes `paused_at`.
+     *
+     * @example
+     * ```ts
+     * const dedicatedIPShowResponse =
+     *   await client.email.dedicatedIPs.actions.pauseWarmup(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    pauseWarmup(id, options) {
+        return this._client.post(path `/email/dedicated_ips/${id}/actions/pause_warmup`, options);
+    }
+    /**
+     * Resume a paused warm-up ramp from its held stage. Only a `warming_up` IP can be
+     * resumed; resuming a ramp that is not paused returns the IP unchanged.
+     *
+     * @example
+     * ```ts
+     * const dedicatedIPShowResponse =
+     *   await client.email.dedicatedIPs.actions.resumeWarmup(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    resumeWarmup(id, options) {
+        return this._client.post(path `/email/dedicated_ips/${id}/actions/resume_warmup`, options);
+    }
+    /**
+     * Start the warm-up ramp (`provisioning` to `warming_up`). The ramp never starts
+     * automatically. Only a `provisioning` IP can be started; a `suspended` IP returns
+     * `409`. Starting does not check DNS: the IP carries mail only while
+     * `dns_confirmed_at` is set and the IP is in a pool that routes mail.
+     *
+     * @example
+     * ```ts
+     * const dedicatedIPShowResponse =
+     *   await client.email.dedicatedIPs.actions.startWarmup(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    startWarmup(id, options) {
+        return this._client.post(path `/email/dedicated_ips/${id}/actions/start_warmup`, options);
+    }
+}
+//# sourceMappingURL=actions.mjs.map

package/resources/email/dedicated-ips/actions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.mjs","sourceRoot":"","sources":["../../../src/resources/email/dedicated-ips/actions.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAIrD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,CAAC,EAAU,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,wBAAwB,EAAE,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAU,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,wBAAwB,EAAE,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAU,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,wBAAwB,EAAE,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAU,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,wBAAwB,EAAE,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;CACF"}