telnyx 7.28.0 → 7.29.0

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"}

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

@@ -0,0 +1,444 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as ActionsAPI from "./actions.mjs";
+import { Actions } from "./actions.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+/**
+ * Purchase and manage dedicated sending IP addresses for your Telnyx email traffic.
+ */
+export declare class DedicatedIPs extends APIResource {
+    actions: ActionsAPI.Actions;
+    /**
+     * List the dedicated sending IPs owned by the account, newest first. Narrow the
+     * list with `filter[status]`, `filter[pool_id]`, and `filter[region]`; supplied
+     * filters combine, so an IP must match every one. An empty value, or a nested or
+     * array value such as `filter[status][]=active`, applies no filter, and other
+     * `filter[...]` keys are ignored. A value that no IP can match (an unknown status,
+     * a `pool_id` that is not a UUID, or a value containing a NUL byte) returns an
+     * empty list, not an error.
+     *
+     * @example
+     * ```ts
+     * const dedicatedIPs = await client.email.dedicatedIPs.list();
+     * ```
+     */
+    list(query?: DedicatedIPListParams | null | undefined, options?: RequestOptions): APIPromise<DedicatedIPListResponse>;
+    /**
+     * Purchase a dedicated sending IP. Requires a verified, enterprise, or legacy
+     * account, and an `Idempotency-Key` header: a request without the header returns
+     * `400` (code `10015`) and allocates nothing. Telnyx allocates the next available
+     * IP from stock. The optional `region` and `ip_version` fields each restrict which
+     * stock IP is allocated; they never change the allocated IP's metadata. An omitted
+     * field applies no restriction for that field, and omitting the body applies
+     * neither restriction. An unsupported selector value returns `422`; a supported
+     * value that matches no available IP returns `429` and records the request on the
+     * waitlist. Billing: $14/month/IP, charged as a monthly recurring charge (MRC)
+     * from purchase. The IP is returned in `provisioning` status with a Telnyx-managed
+     * PTR hostname and carries no mail until you call `start_warmup` and add it to a
+     * pool that routes mail.
+     *
+     * @example
+     * ```ts
+     * const dedicatedIPShowResponse =
+     *   await client.email.dedicatedIPs.create({
+     *     'Idempotency-Key':
+     *       '8e03978e-40d5-43e8-bc93-6894a57f9326',
+     *     ip_version: 'ipv4',
+     *     region: 'ewr-nj1',
+     *   });
+     * ```
+     */
+    create(params: DedicatedIPCreateParams, options?: RequestOptions): APIPromise<DedicatedIPShowResponse>;
+    /**
+     * Release the dedicated IP to Telnyx. The IP stops carrying mail immediately,
+     * leaves its pool, and moves to `released`. Telnyx sets `quarantine_until` to 30
+     * days after release. Release requests that the MRC stop asynchronously. Check
+     * `billing`: `stopping` means the stop is pending, `stopped` means it completed,
+     * and `stop_failed` means the charge remains. If the charge was never created or
+     * its creation has not completed, `billing` keeps showing the creation status
+     * (`not_started`, `pending`, `in_progress`, or `failed`). Any status except
+     * `released` can be released. Releasing the last IP in a pool requires
+     * `force=true` and `drain=true`.
+     *
+     * @example
+     * ```ts
+     * const dedicatedIPShowResponse =
+     *   await client.email.dedicatedIPs.delete(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     {
+     *       query_reason: 'No longer needed',
+     *       body_reason: 'No longer needed',
+     *     },
+     *   );
+     * ```
+     */
+    delete(id: string, params?: DedicatedIPDeleteParams | null | undefined, options?: RequestOptions): APIPromise<DedicatedIPShowResponse>;
+    /**
+     * Retrieve a single dedicated IP by its identifier, including warm-up state,
+     * billing state, and the DNS/PTR provisioning checklist.
+     *
+     * @example
+     * ```ts
+     * const dedicatedIPShowResponse =
+     *   await client.email.dedicatedIPs.retrieve(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<DedicatedIPShowResponse>;
+    /**
+     * Move the IP to another pool, or pause/resume its warm-up ramp. One change
+     * applies per request. `pool_id` takes precedence over warm-up changes. Otherwise,
+     * use `warmup_paused` or `warmup.paused`; a Boolean `warmup_paused` takes
+     * precedence. Moving the last IP out of a pool requires `force: true` and
+     * `drain: true`. The PTR hostname is managed by Telnyx: a request that includes
+     * `ptr_hostname` returns `422` unless `pool_id` or a warm-up field is present, in
+     * which case `ptr_hostname` is ignored.
+     *
+     * @example
+     * ```ts
+     * const dedicatedIPShowResponse =
+     *   await client.email.dedicatedIPs.update(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     {
+     *       pool_id: '9b1c4d70-abcd-4e5f-8a9b-0c1d2e3f4a5b',
+     *       weight: 100,
+     *     },
+     *   );
+     * ```
+     */
+    update(id: string, body: DedicatedIPUpdateParams, options?: RequestOptions): APIPromise<DedicatedIPShowResponse>;
+}
+/**
+ * A dedicated sending IP address owned by the account.
+ */
+export interface DedicatedIP {
+    id?: string;
+    /**
+     * Monthly recurring charge (MRC) state for the IP's current allocation.
+     */
+    billing?: DedicatedIP.Billing;
+    created_at?: string;
+    /**
+     * When the PTR hostname was forward-confirmed (PTR → hostname → A record → this
+     * IP). The IP carries mail only while this is set.
+     */
+    dns_confirmed_at?: string | null;
+    /**
+     * The allocated IPv4/IPv6 address.
+     */
+    ip_address?: string;
+    ip_version?: 'ipv4' | 'ipv6';
+    pool_id?: string | null;
+    /**
+     * Read-only status of the Telnyx-managed PTR record. No customer action is
+     * required to complete it.
+     */
+    provisioning?: DedicatedIP.Provisioning;
+    /**
+     * Same value as `provisioning.dns_status`.
+     */
+    provisioning_status?: 'not_applicable' | 'pending_ptr' | 'pending_dns' | 'dns_confirmed' | 'dns_lost';
+    /**
+     * Telnyx-managed reverse DNS (PTR) hostname of the IP, in the form
+     * `mta-<a-b-c-d>.msgtelnyx.com`. Also used as the EHLO hostname when sending from
+     * the IP. Managed by Telnyx and cannot be changed through the API.
+     */
+    ptr_hostname?: string | null;
+    /**
+     * Set on release to 30 days after `released_at`. The address is not returned to
+     * stock before this time.
+     */
+    quarantine_until?: string | null;
+    record_type?: 'dedicated_ip';
+    /**
+     * Region label of the allocated IP (for example, `ewr-nj1`).
+     */
+    region?: string;
+    /**
+     * When the IP was released. Null until release.
+     */
+    released_at?: string | null;
+    /**
+     * Lifecycle status. `provisioning`: purchased and billed, carries no mail until
+     * `start_warmup`. `warming_up`: warm-up ramp in progress. `active`: ramp complete.
+     * `suspended`: suspended by Telnyx; carries no mail and is still billed.
+     * `released`: returned to Telnyx; carries no mail.
+     */
+    status?: 'provisioning' | 'warming_up' | 'active' | 'suspended' | 'released';
+    /**
+     * Reason Telnyx recorded when suspending the IP. Null unless `status` is
+     * `suspended`.
+     */
+    suspension_reason?: string | null;
+    updated_at?: string;
+    /**
+     * Warmup ramp state for a dedicated IP.
+     */
+    warmup?: DedicatedIP.Warmup;
+}
+export declare namespace DedicatedIP {
+    /**
+     * Monthly recurring charge (MRC) state for the IP's current allocation.
+     */
+    interface Billing {
+        /**
+         * True when `status` is `active`, `stopping`, or `stop_failed`. An IP carries mail
+         * only after its charge has been created.
+         */
+        charged?: boolean;
+        /**
+         * `not_started`: no charge recorded for the current allocation. `pending`: the
+         * charge is queued. `in_progress`: the charge is being created. `active`: the MRC
+         * is active. `stopping`: release requested; the MRC stop is being processed.
+         * `stopped`: the MRC has stopped. `stop_failed`: the MRC stop failed and the
+         * charge remains. `failed`: the charge could not be created.
+         */
+        status?: 'not_started' | 'pending' | 'in_progress' | 'active' | 'stopping' | 'stopped' | 'stop_failed' | 'failed';
+    }
+    /**
+     * Read-only status of the Telnyx-managed PTR record. No customer action is
+     * required to complete it.
+     */
+    interface Provisioning {
+        /**
+         * Informational progress flags for the Telnyx-managed PTR. They do not gate
+         * `start_warmup`; use `dns_status` to check whether the IP can carry mail.
+         */
+        checklist?: Provisioning.Checklist;
+        /**
+         * `dns_confirmed`: the PTR is forward-confirmed and `dns_confirmed_at` is set.
+         * `pending_ptr`: the PTR record is not yet in place. `pending_dns`: the PTR record
+         * is waiting for forward confirmation. `dns_lost`: a previously confirmed PTR no
+         * longer confirms, or the PTR request was abandoned before it ever confirmed
+         * (`ptr_request_state` is `abandoned`); the IP carries no mail until DNS is
+         * confirmed. `not_applicable`: the IP is released or has no PTR record on file.
+         */
+        dns_status?: 'not_applicable' | 'pending_ptr' | 'pending_dns' | 'dns_confirmed' | 'dns_lost';
+        /**
+         * Reference to the Telnyx PTR change request, when one exists. Informational.
+         */
+        ptr_request_pr_url?: string | null;
+        /**
+         * State of the Telnyx PTR change: `pending`, `pr_open`, `merged`, `confirmed`,
+         * `failed`, or `abandoned`. Informational.
+         */
+        ptr_request_state?: 'pending' | 'pr_open' | 'merged' | 'confirmed' | 'failed' | 'abandoned' | null;
+    }
+    namespace Provisioning {
+        /**
+         * Informational progress flags for the Telnyx-managed PTR. They do not gate
+         * `start_warmup`; use `dns_status` to check whether the IP can carry mail.
+         */
+        interface Checklist {
+            forward_confirmed?: boolean;
+            ptr_authored?: boolean;
+            ptr_merged?: boolean;
+            ptr_requested?: boolean;
+        }
+    }
+    /**
+     * Warmup ramp state for a dedicated IP.
+     */
+    interface Warmup {
+        /**
+         * Daily cap of the current ramp stage. Null until the scheduler arms the first
+         * stage, and cleared when the ramp completes, automatically or through
+         * `complete_warmup`. On an `active` IP this value is informational and can keep an
+         * earlier stage cap after a suspension is lifted; it does not limit sending.
+         */
+        daily_cap?: number | null;
+        /**
+         * True while the ramp is paused.
+         */
+        paused?: boolean;
+        /**
+         * When the ramp was paused. Null when not paused.
+         */
+        paused_at?: string | null;
+        /**
+         * Ramp progress (0-100): the share of the 28 send-day schedule completed. Only UTC
+         * days on which the IP sent mail count. Set to 100 when the ramp completes,
+         * automatically or through `complete_warmup`. On an `active` IP this value is
+         * informational and can keep an earlier value after a suspension is lifted.
+         */
+        progress?: number;
+        /**
+         * When `start_warmup` was called. Null before warm-up starts and after release.
+         */
+        started_at?: string | null;
+        /**
+         * Today's warmup allowance report card (current UTC day). Null outside the warmup
+         * window (before start_warmup, after release/suspension). `active` IPs report the
+         * ramp-complete allowance, except as described for `cap`.
+         */
+        today?: Warmup.Today | null;
+    }
+    namespace Warmup {
+        /**
+         * Today's warmup allowance report card (current UTC day). Null outside the warmup
+         * window (before start_warmup, after release/suspension). `active` IPs report the
+         * ramp-complete allowance, except as described for `cap`.
+         */
+        interface Today {
+            /**
+             * The day's allowance cap. Null when the ramp has not opened yet (day 0: the
+             * scheduler has not armed a stage cap) — distinct from a spent day, which reports
+             * the cap with remaining 0. `active` IPs report `100000000`, the ramp-complete
+             * cap; `complete_warmup` applies it to the current day immediately. A day's
+             * allowance created before the IP became `active` can keep its stored `cap` and
+             * `remaining` until the next first-attempt send refreshes them.
+             */
+            cap?: number | null;
+            /**
+             * The UTC day this snapshot describes (warmup caps reset at UTC midnight).
+             */
+            day?: string;
+            /**
+             * First-attempt sends released from warmup hold so far today. Delivery retries
+             * never lease allowance and are not counted.
+             */
+            granted?: number;
+            /**
+             * Headroom left today. A queued send held by the daily cap is explained by
+             * remaining == 0; null mirrors cap (ramp not open yet). On an `active` IP whose
+             * `cap` is below `100000000`, remaining == 0 is a stored allowance and does not
+             * block the next eligible first-attempt send.
+             */
+            remaining?: number | null;
+        }
+    }
+}
+export interface DedicatedIPShowResponse {
+    /**
+     * A dedicated sending IP address owned by the account.
+     */
+    data: DedicatedIP;
+}
+export interface DedicatedIPListResponse {
+    data: Array<DedicatedIP>;
+}
+export interface DedicatedIPListParams {
+    /**
+     * Return only IPs in this pool (exact match on `pool_id`). A value that is not a
+     * UUID returns an empty list. An empty value applies no filter.
+     */
+    'filter[pool_id]'?: string;
+    /**
+     * Return only IPs in this region (exact, case-sensitive match on `region`). An
+     * empty value applies no filter.
+     */
+    'filter[region]'?: string;
+    /**
+     * Return only IPs in this lifecycle status (exact match). Any other value returns
+     * an empty list. An empty value applies no filter.
+     */
+    'filter[status]'?: 'provisioning' | 'warming_up' | 'active' | 'suspended' | 'released';
+}
+export interface DedicatedIPCreateParams {
+    /**
+     * Header param: Required. Opaque, unquoted key for safely retrying the same
+     * purchase. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
+     * Generate a unique UUID v4 for each purchase and reuse it only when retrying that
+     * purchase with the same request. A missing header, or an invalid one —including
+     * duplicate, empty, malformed, or overlong values—returns 400 with error
+     * code 10015. A request already in progress with the same key returns 409; reusing
+     * the key with a different request returns 422. Only successful responses are
+     * replayed, for up to 24 hours. Do not include sensitive data in the key.
+     */
+    'Idempotency-Key': string;
+    /**
+     * Body param: Allocate an IP of this address family. Supported value: `ipv4`. Any
+     * other value, including `ipv6` or `null`, returns `422`.
+     */
+    ip_version?: 'ipv4';
+    /**
+     * Body param: Allocate an IP in this region. Supported value: `ewr-nj1`. Any other
+     * value, including an empty string or `null`, returns `422`.
+     */
+    region?: 'ewr-nj1';
+}
+export interface DedicatedIPDeleteParams {
+    /**
+     * Query param: Set together with `force=true` to release the last IP in a pool.
+     * Acknowledges that mail routed to the emptied pool is held until the pool has a
+     * sendable IP again. Also accepted in the JSON body.
+     */
+    query_drain?: boolean;
+    /**
+     * Query param: Set together with `drain=true` to release the last IP in a pool.
+     * Either flag alone has no effect. Also accepted in the JSON body.
+     */
+    query_force?: boolean;
+    /**
+     * Query param: Free-text reason recorded with the release. Also accepted in the
+     * JSON body.
+     */
+    query_reason?: string;
+    /**
+     * Body param: Set together with `force: true` to release the last IP in a pool.
+     * Acknowledges that mail routed to the emptied pool is held until the pool has a
+     * sendable IP again.
+     */
+    body_drain?: boolean;
+    /**
+     * Body param: Set together with `drain: true` to release the last IP in a pool.
+     * Either flag alone has no effect.
+     */
+    body_force?: boolean;
+    /**
+     * Body param: Free-text reason recorded with the release.
+     */
+    body_reason?: string;
+}
+export interface DedicatedIPUpdateParams {
+    /**
+     * Set together with `force: true` to move the last IP out of its current pool.
+     * Acknowledges that mail routed to the emptied pool is held. Used only with
+     * `pool_id`.
+     */
+    drain?: boolean;
+    /**
+     * Set together with `drain: true` to move the last IP out of its current pool.
+     * Used only with `pool_id`.
+     */
+    force?: boolean;
+    /**
+     * Move the IP to this pool, replacing its current membership. Use the IP's current
+     * pool to change only its weight. To take an IP out of a pool, use
+     * `DELETE /email/ip_pools/{id}/ips/{ip_id}`.
+     */
+    pool_id?: string;
+    /**
+     * Alias for `warmup_paused`.
+     */
+    warmup?: DedicatedIPUpdateParams.Warmup;
+    /**
+     * Pause (`true`) or resume (`false`) the warm-up ramp; equivalent to the
+     * `pause_warmup` and `resume_warmup` actions. A Boolean value takes precedence
+     * over `warmup.paused`. When a pause field is present and `pool_id` is absent,
+     * supplying neither pause field as a Boolean invokes resume.
+     */
+    warmup_paused?: boolean;
+    /**
+     * Routing weight in the target pool. Used only with `pool_id`.
+     */
+    weight?: number;
+}
+export declare namespace DedicatedIPUpdateParams {
+    /**
+     * Alias for `warmup_paused`.
+     */
+    interface Warmup {
+        /**
+         * Pause (`true`) or resume (`false`) the warm-up ramp. Used only when
+         * `warmup_paused` is not a Boolean.
+         */
+        paused?: boolean;
+    }
+}
+export declare namespace DedicatedIPs {
+    export { type DedicatedIP as DedicatedIP, type DedicatedIPShowResponse as DedicatedIPShowResponse, type DedicatedIPListResponse as DedicatedIPListResponse, type DedicatedIPListParams as DedicatedIPListParams, type DedicatedIPCreateParams as DedicatedIPCreateParams, type DedicatedIPDeleteParams as DedicatedIPDeleteParams, type DedicatedIPUpdateParams as DedicatedIPUpdateParams, };
+    export { Actions as Actions };
+}
+//# sourceMappingURL=dedicated-ips.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dedicated-ips.d.mts","sourceRoot":"","sources":["../../../src/resources/email/dedicated-ips/dedicated-ips.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EAAE,OAAO,EAAE,sBAAkB;AACpC,OAAO,EAAE,UAAU,EAAE,sCAAkC;AAEvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,MAAM,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAStG;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAStC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInF;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAGvC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE9B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAE7B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,YAAY,CAAC,EAAE,WAAW,CAAC,YAAY,CAAC;IAExC;;OAEG;IACH,mBAAmB,CAAC,EAAE,gBAAgB,GAAG,aAAa,GAAG,aAAa,GAAG,eAAe,GAAG,UAAU,CAAC;IAEtG;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,WAAW,CAAC,EAAE,cAAc,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,YAAY,GAAG,QAAQ,GAAG,WAAW,GAAG,UAAU,CAAC;IAE7E;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC;CAC7B;AAED,yBAAiB,WAAW,CAAC;IAC3B;;OAEG;IACH,UAAiB,OAAO;QACtB;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;;;;;WAMG;QACH,MAAM,CAAC,EACH,aAAa,GACb,SAAS,GACT,aAAa,GACb,QAAQ,GACR,UAAU,GACV,SAAS,GACT,aAAa,GACb,QAAQ,CAAC;KACd;IAED;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;;WAGG;QACH,SAAS,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;QAEnC;;;;;;;WAOG;QACH,UAAU,CAAC,EAAE,gBAAgB,GAAG,aAAa,GAAG,aAAa,GAAG,eAAe,GAAG,UAAU,CAAC;QAE7F;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnC;;;WAGG;QACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,IAAI,CAAC;KACpG;IAED,UAAiB,YAAY,CAAC;QAC5B;;;WAGG;QACH,UAAiB,SAAS;YACxB,iBAAiB,CAAC,EAAE,OAAO,CAAC;YAE5B,YAAY,CAAC,EAAE,OAAO,CAAC;YAEvB,UAAU,CAAC,EAAE,OAAO,CAAC;YAErB,aAAa,CAAC,EAAE,OAAO,CAAC;SACzB;KACF;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;;;;WAKG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;;;WAKG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC;KAC7B;IAED,UAAiB,MAAM,CAAC;QACtB;;;;WAIG;QACH,UAAiB,KAAK;YACpB;;;;;;;eAOG;YACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;YAEb;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;;;;eAKG;YACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC3B;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,cAAc,GAAG,YAAY,GAAG,QAAQ,GAAG,WAAW,GAAG,UAAU,CAAC;CACxF;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;;;;;;OASG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,uBAAuB,CAAC,MAAM,CAAC;IAExC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,MAAM;QACrB;;;WAGG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB;CACF;AAID,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;CAC/B"}