telnyx 7.27.0 → 7.29.0

package/resources/number-lookup.d.ts

@@ -15,12 +15,22 @@ export interface NumberLookupRetrieveResponse {
 }
 export declare namespace NumberLookupRetrieveResponse {
     interface Data {
+        /**
+         * Identity information for the phone number's owner, including name and postal
+         * address. Populated when `type=caller-identity` is requested.
+         */
+        caller_identity?: Data.CallerIdentity;
         caller_name?: Data.CallerName;
         carrier?: Data.Carrier;
         /**
          * Region code that matches the specific country calling code
          */
         country_code?: string;
+        /**
+         * Enhanced caller name for the phone number's owner. Populated when
+         * `type=enhanced-caller-name` is requested.
+         */
+        enhanced_caller_name?: Data.EnhancedCallerName;
         /**
          * Unused
          */
@@ -30,6 +40,11 @@ export declare namespace NumberLookupRetrieveResponse {
          * (NDC), with a 0 prefix, if an NDC is found
          */
         national_format?: string;
+        /**
+         * Network number ID (NNID) override for the phone number, when one applies
+         * (available only to accounts enabled for NNID); otherwise null.
+         */
+        nnid_override?: Data.NnidOverride | null;
         /**
          * E164-formatted phone number
          */
@@ -39,8 +54,74 @@ export declare namespace NumberLookupRetrieveResponse {
          * Identifies the type of record
          */
         record_type?: string;
+        /**
+         * Indicates whether the phone number is valid.
+         */
+        valid_number?: boolean;
     }
     namespace Data {
+        /**
+         * Identity information for the phone number's owner, including name and postal
+         * address. Populated when `type=caller-identity` is requested.
+         */
+        interface CallerIdentity {
+            /**
+             * Postal address associated with the phone number's owner.
+             */
+            address?: CallerIdentity.Address;
+            /**
+             * How strongly the phone number is linked to the returned name, on a scale of 50
+             * to 90 (higher means more supporting signals). Reflects signal strength, not
+             * probability: 70 indicates stronger, more consistent evidence than 60, not a 70%
+             * chance of being correct. As a guide, 70+ is high confidence, 60 moderate, and 50
+             * limited. Below 50 no name is returned, so scores under 50 are never present.
+             */
+            confidence_score?: number | null;
+            /**
+             * A lookup-specific error code if the identity could not be resolved; otherwise
+             * null.
+             */
+            error_code?: string | null;
+            /**
+             * The name associated with the phone number.
+             */
+            name?: string | null;
+        }
+        namespace CallerIdentity {
+            /**
+             * Postal address associated with the phone number's owner.
+             */
+            interface Address {
+                /**
+                 * City.
+                 */
+                city?: string | null;
+                /**
+                 * Two-letter ISO 3166-1 country code.
+                 */
+                country_code?: string | null;
+                /**
+                 * Postal or ZIP code.
+                 */
+                postal_code?: string | null;
+                /**
+                 * Two-letter state or province code.
+                 */
+                state_code?: string | null;
+                /**
+                 * First line of the street address.
+                 */
+                street_line_1?: string | null;
+                /**
+                 * Second line of the street address, if any.
+                 */
+                street_line_2?: string | null;
+                /**
+                 * ZIP+4 extension, if available.
+                 */
+                zip4?: string | null;
+            }
+        }
         interface CallerName {
             /**
              * The name of the requested phone number's owner as per the CNAM database
@@ -82,6 +163,39 @@ export declare namespace NumberLookupRetrieveResponse {
              */
             type?: 'fixed line' | 'mobile' | 'voip' | 'fixed line or mobile' | 'toll free' | 'premium rate' | 'shared cost' | 'personal number' | 'pager' | 'uan' | 'voicemail' | 'unknown';
         }
+        /**
+         * Enhanced caller name for the phone number's owner. Populated when
+         * `type=enhanced-caller-name` is requested.
+         */
+        interface EnhancedCallerName {
+            /**
+             * The name associated with the phone number.
+             */
+            caller_name?: string | null;
+            /**
+             * A lookup-specific error code if the enhanced caller name could not be resolved;
+             * otherwise null.
+             */
+            error_code?: string | null;
+        }
+        /**
+         * Network number ID (NNID) override for the phone number, when one applies
+         * (available only to accounts enabled for NNID); otherwise null.
+         */
+        interface NnidOverride {
+            /**
+             * Name associated with the NNID.
+             */
+            name?: string;
+            /**
+             * The network number ID.
+             */
+            nnid?: string;
+            /**
+             * The NNID type.
+             */
+            type?: string;
+        }
         interface Portability {
             /**
              * Alternative SPID (Service Provider ID). Often used when a carrier is using a
@@ -102,9 +216,10 @@ export declare namespace NumberLookupRetrieveResponse {
              */
             city?: string;
             /**
-             * Type of number
+             * The line type of the phone number. Uses the same value set as carrier.type; see
+             * the API reference for the full list.
              */
-            line_type?: string;
+            line_type?: 'fixed line' | 'mobile' | 'voip' | 'fixed line or mobile' | 'toll free' | 'premium rate' | 'shared cost' | 'personal number' | 'pager' | 'uan' | 'voicemail' | 'unknown';
             /**
              * Local Routing Number, if assigned to the requested phone number
              */
@@ -140,9 +255,12 @@ export declare namespace NumberLookupRetrieveResponse {
 }
 export interface NumberLookupRetrieveParams {
     /**
-     * Specifies the type of number lookup to be performed
+     * Specifies the type of number lookup to be performed. May be supplied more than
+     * once to request several data sources in a single call (for example,
+     * `?type=carrier&type=enhanced-caller-name`). Each requested type populates the
+     * corresponding object in the response.
      */
-    type?: 'carrier' | 'caller-name';
+    type?: 'carrier' | 'caller-name' | 'caller-identity' | 'enhanced-caller-name';
 }
 export declare namespace NumberLookup {
     export { type NumberLookupRetrieveResponse as NumberLookupRetrieveResponse, type NumberLookupRetrieveParams as NumberLookupRetrieveParams, };

package/resources/number-lookup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"number-lookup.d.ts","sourceRoot":"","sources":["../src/resources/number-lookup.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;CAG5C;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,4BAA4B,CAAC,IAAI,CAAC;CAC1C;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,IAAI;QACnB,WAAW,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC;QAE9B,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;QAEvB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,WAAW,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC;QAE/B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,UAAU;YACzB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;;eAGG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB;QAED,UAAiB,OAAO;YACtB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;;eAGG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAE7B;;;eAGG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAE7B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAE5B;;;eAGG;YACH,IAAI,CAAC,EACD,YAAY,GACZ,QAAQ,GACR,MAAM,GACN,sBAAsB,GACtB,WAAW,GACX,cAAc,GACd,aAAa,GACb,iBAAiB,GACjB,OAAO,GACP,KAAK,GACL,WAAW,GACX,SAAS,CAAC;SACf;QAED,UAAiB,WAAW;YAC1B;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAE9B;;eAEG;YACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAE9B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;YAEb;;;eAGG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,EAAE,CAAC;YAE/B;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,aAAa,CAAC;CAClC;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
+{"version":3,"file":"number-lookup.d.ts","sourceRoot":"","sources":["../src/resources/number-lookup.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;CAG5C;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,4BAA4B,CAAC,IAAI,CAAC;CAC1C;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,IAAI;QACnB;;;WAGG;QACH,eAAe,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC;QAEtC,WAAW,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC;QAE9B,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;QAEvB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,oBAAoB,CAAC,EAAE,IAAI,CAAC,kBAAkB,CAAC;QAE/C;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;;WAGG;QACH,aAAa,CAAC,EAAE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAEzC;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,WAAW,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC;QAE/B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB;IAED,UAAiB,IAAI,CAAC;QACpB;;;WAGG;QACH,UAAiB,cAAc;YAC7B;;eAEG;YACH,OAAO,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC;YAEjC;;;;;;eAMG;YACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEjC;;;eAGG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;QAED,UAAiB,cAAc,CAAC;YAC9B;;eAEG;YACH,UAAiB,OAAO;gBACtB;;mBAEG;gBACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAErB;;mBAEG;gBACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE7B;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE5B;;mBAEG;gBACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE3B;;mBAEG;gBACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE9B;;mBAEG;gBACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE9B;;mBAEG;gBACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aACtB;SACF;QAED,UAAiB,UAAU;YACzB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;;eAGG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB;QAED,UAAiB,OAAO;YACtB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;;eAGG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAE7B;;;eAGG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAE7B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAE5B;;;eAGG;YACH,IAAI,CAAC,EACD,YAAY,GACZ,QAAQ,GACR,MAAM,GACN,sBAAsB,GACtB,WAAW,GACX,cAAc,GACd,aAAa,GACb,iBAAiB,GACjB,OAAO,GACP,KAAK,GACL,WAAW,GACX,SAAS,CAAC;SACf;QAED;;;WAGG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;;eAGG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC5B;QAED;;;WAGG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,WAAW;YAC1B;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAE9B;;eAEG;YACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAE9B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,SAAS,CAAC,EACN,YAAY,GACZ,QAAQ,GACR,MAAM,GACN,sBAAsB,GACtB,WAAW,GACX,cAAc,GACd,aAAa,GACb,iBAAiB,GACjB,OAAO,GACP,KAAK,GACL,WAAW,GACX,SAAS,CAAC;YAEd;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;YAEb;;;eAGG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,EAAE,CAAC;YAE/B;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,iBAAiB,GAAG,sBAAsB,CAAC;CAC/E;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}

package/resources/pay-connectors.d.mts

@@ -0,0 +1,378 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { EmailBracketCursorPagination, type EmailBracketCursorPaginationParams, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Generic payment connector configuration.
+ */
+export declare class PayConnectors extends APIResource {
+    /**
+     * List connectors belonging to the authenticated organization, including
+     * connectors created by other users in that organization. Set filter[type]=generic
+     * to restrict results to the type covered here. Results default to newest
+     * created_at first. Use meta.end_cursor as page[after] for the next page, or
+     * meta.start_cursor as page[before] for the preceding page. Omit both cursors for
+     * the first page; if both are supplied, page[after] takes precedence. Responses
+     * omit passwords and tokens.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const payConnector of client.payConnectors.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: PayConnectorListParams | null | undefined, options?: RequestOptions): PagePromise<PayConnectorsEmailBracketCursorPagination, PayConnector>;
+    /**
+     * Create a generic payment connector in the authenticated organization. The name
+     * must be unique in that organization. Authentication supplies ownership; do not
+     * send user_id or organization_id. Config is encrypted at rest; passwords and
+     * tokens are omitted from responses. This operation stores configuration and does
+     * not initiate a payment. See the
+     * [processor contract](/docs/voice/programmable-voice/pay#request-sent-to-the-payment-processor).
+     *
+     * @example
+     * ```ts
+     * const payConnectorResponse =
+     *   await client.payConnectors.create({
+     *     config: {
+     *       endpoint_url: 'https://processor.example.com/pay',
+     *       auth_type: 'none',
+     *     },
+     *     name: 'my-payment-connector',
+     *     mode: 'test',
+     *     type: 'generic',
+     *   });
+     * ```
+     */
+    create(body: PayConnectorCreateParams, options?: RequestOptions): APIPromise<PayConnectorResponse>;
+    /**
+     * Delete a connector by name in the authenticated organization. Both test and live
+     * connectors can be deleted. Returns no response body on success; a missing name
+     * or a connector in another organization returns 404.
+     *
+     * @example
+     * ```ts
+     * await client.payConnectors.delete('my-payment-connector');
+     * ```
+     */
+    delete(name: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Retrieve a connector by name within the authenticated organization. Password and
+     * token are omitted. A missing name or a connector owned by another organization
+     * returns 404.
+     *
+     * @example
+     * ```ts
+     * const payConnectorResponse =
+     *   await client.payConnectors.retrieve(
+     *     'my-payment-connector',
+     *   );
+     * ```
+     */
+    retrieve(name: string, options?: RequestOptions): APIPromise<PayConnectorResponse>;
+    /**
+     * Update a generic connector by name in the authenticated organization. Both test
+     * and live connectors can be updated through the API. Omitted fields remain
+     * unchanged. Supplying config replaces the entire config; it does not merge keys.
+     * Include endpoint_url and the credentials required for the selected auth_type on
+     * every config replacement. Omitting config preserves existing credentials,
+     * allowing a mode-only update. The path name cannot be renamed. Public updates use
+     * PATCH.
+     *
+     * @example
+     * ```ts
+     * const payConnectorResponse =
+     *   await client.payConnectors.update(
+     *     'my-payment-connector',
+     *     { mode: 'live' },
+     *   );
+     * ```
+     */
+    update(name: string, body: PayConnectorUpdateParams, options?: RequestOptions): APIPromise<PayConnectorResponse>;
+}
+export type PayConnectorsEmailBracketCursorPagination = EmailBracketCursorPagination<PayConnector>;
+/**
+ * Configuration for a generic connector. A config update replaces the complete
+ * object, not individual keys. Unknown config keys are discarded. Authentication
+ * credentials must be nonblank strings when required by the selected auth_type.
+ */
+export type GenericPayConnectorConfig = GenericPayConnectorConfig.BasicAuthenticationAlsoTheValidationDefault | GenericPayConnectorConfig.BearerAuthentication | GenericPayConnectorConfig.NoProcessorAuthentication;
+export declare namespace GenericPayConnectorConfig {
+    interface BasicAuthenticationAlsoTheValidationDefault {
+        /**
+         * Basic password.
+         */
+        password: string;
+        /**
+         * Basic username.
+         */
+        username: string;
+        /**
+         * Nonblank string required for bearer authentication. Write-only; omitted from
+         * responses. Re-send when replacing a bearer-auth config.
+         */
+        token?: unknown;
+        auth_type?: 'basic';
+        /**
+         * HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in
+         * transit.
+         */
+        endpoint_url?: string;
+        /**
+         * Processor HTTP timeout in milliseconds. Omitted or null uses 10000; null is
+         * removed before storage. Not the IVR digit-gather timeout.
+         */
+        timeout?: number | null;
+    }
+    interface BearerAuthentication {
+        /**
+         * Processor bearer token.
+         */
+        token: string;
+        auth_type: 'bearer';
+        /**
+         * HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in
+         * transit.
+         */
+        endpoint_url?: string;
+        /**
+         * Nonblank string required for basic authentication. Write-only; omitted from
+         * responses. Re-send when replacing a basic-auth config.
+         */
+        password?: unknown;
+        /**
+         * Processor HTTP timeout in milliseconds. Omitted or null uses 10000; null is
+         * removed before storage. Not the IVR digit-gather timeout.
+         */
+        timeout?: number | null;
+        /**
+         * Nonblank string required for basic authentication. Returned in connector
+         * responses.
+         */
+        username?: unknown;
+    }
+    interface NoProcessorAuthentication {
+        auth_type: 'none';
+        /**
+         * Nonblank string required for bearer authentication. Write-only; omitted from
+         * responses. Re-send when replacing a bearer-auth config.
+         */
+        token?: unknown;
+        /**
+         * HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in
+         * transit.
+         */
+        endpoint_url?: string;
+        /**
+         * Nonblank string required for basic authentication. Write-only; omitted from
+         * responses. Re-send when replacing a basic-auth config.
+         */
+        password?: unknown;
+        /**
+         * Processor HTTP timeout in milliseconds. Omitted or null uses 10000; null is
+         * removed before storage. Not the IVR digit-gather timeout.
+         */
+        timeout?: number | null;
+        /**
+         * Nonblank string required for basic authentication. Returned in connector
+         * responses.
+         */
+        username?: unknown;
+    }
+}
+/**
+ * Organization-owned connector. Examples and config properties here describe
+ * generic connectors; listing is not restricted to that type unless
+ * filter[type]=generic is supplied. Passwords and bearer tokens are omitted, not
+ * masked. Defaults for auth_type and timeout need not appear in stored config.
+ */
+export interface PayConnector {
+    /**
+     * Connector identifier.
+     */
+    id?: string;
+    /**
+     * Redacted stored configuration. Generic connector fields are shown here. Unknown
+     * config keys are discarded. Password and token are never returned.
+     */
+    config?: PayConnector.Config;
+    /**
+     * Creation time.
+     */
+    created_at?: string;
+    /**
+     * Configured mode.
+     */
+    mode?: 'test' | 'live';
+    /**
+     * Connector name used for retrieval, update, deletion and Pay.
+     */
+    name?: string;
+    /**
+     * Owning organization; assigned from authentication, not request input.
+     */
+    organization_id?: string;
+    /**
+     * Resource type.
+     */
+    record_type?: 'pay_connector';
+    /**
+     * Connector type; generic is covered by this reference. Other types may appear in
+     * unfiltered lists.
+     */
+    type?: string;
+    /**
+     * Last update time.
+     */
+    updated_at?: string;
+    /**
+     * Creating user; assigned from authentication, not request input.
+     */
+    user_id?: string;
+}
+export declare namespace PayConnector {
+    /**
+     * Redacted stored configuration. Generic connector fields are shown here. Unknown
+     * config keys are discarded. Password and token are never returned.
+     */
+    interface Config {
+        /**
+         * Stored processor authentication selection. Omitted if it was not explicitly
+         * configured.
+         */
+        auth_type?: 'none' | 'basic' | 'bearer';
+        /**
+         * HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in
+         * transit.
+         */
+        endpoint_url?: string;
+        /**
+         * Stored processor HTTP timeout in milliseconds. Omitted when no timeout was
+         * configured; the effective runtime default is 10000.
+         */
+        timeout?: number;
+        /**
+         * Stored username, when supplied. Required to be a nonblank string for basic
+         * authentication.
+         */
+        username?: unknown;
+    }
+}
+export interface PayConnectorResponse {
+    /**
+     * Organization-owned connector. Examples and config properties here describe
+     * generic connectors; listing is not restricted to that type unless
+     * filter[type]=generic is supplied. Passwords and bearer tokens are omitted, not
+     * masked. Defaults for auth_type and timeout need not appear in stored config.
+     */
+    data?: PayConnector;
+}
+export interface PayConnectorListParams extends EmailBracketCursorPaginationParams {
+    /**
+     * Equal to this created_at timestamp.
+     */
+    'filter[created_at][eq]'?: string;
+    /**
+     * After this created_at timestamp.
+     */
+    'filter[created_at][gt]'?: string;
+    /**
+     * At or after this created_at timestamp.
+     */
+    'filter[created_at][gte]'?: string;
+    /**
+     * Before this created_at timestamp.
+     */
+    'filter[created_at][lt]'?: string;
+    /**
+     * At or before this created_at timestamp.
+     */
+    'filter[created_at][lte]'?: string;
+    /**
+     * Exact match on mode.
+     */
+    'filter[mode]'?: string;
+    /**
+     * Exact match on name.
+     */
+    'filter[name]'?: string;
+    /**
+     * Exact match on type.
+     */
+    'filter[type]'?: string;
+    /**
+     * Equal to this updated_at timestamp.
+     */
+    'filter[updated_at][eq]'?: string;
+    /**
+     * After this updated_at timestamp.
+     */
+    'filter[updated_at][gt]'?: string;
+    /**
+     * At or after this updated_at timestamp.
+     */
+    'filter[updated_at][gte]'?: string;
+    /**
+     * Before this updated_at timestamp.
+     */
+    'filter[updated_at][lt]'?: string;
+    /**
+     * At or before this updated_at timestamp.
+     */
+    'filter[updated_at][lte]'?: string;
+    /**
+     * Opaque cursor from meta.start_cursor.
+     */
+    'page[before]'?: string;
+    /**
+     * Comma-separated created_at or updated_at fields, optionally prefixed with - for
+     * descending order.
+     */
+    sort?: string;
+}
+export interface PayConnectorCreateParams {
+    /**
+     * Configuration for a generic connector. A config update replaces the complete
+     * object, not individual keys. Unknown config keys are discarded. Authentication
+     * credentials must be nonblank strings when required by the selected auth_type.
+     */
+    config: GenericPayConnectorConfig;
+    /**
+     * Unique within the authenticated organization. Used in resource paths and as
+     * connector_name in the Call Control Pay request. Cannot be renamed by update.
+     */
+    name: string;
+    /**
+     * Defaults to test on creation. Test restricts collected card numbers but still
+     * contacts the configured processor; use a processor sandbox URL and sandbox
+     * credentials. Live removes the test-card restriction. Neither mode locks API
+     * updates.
+     */
+    mode?: 'test' | 'live';
+    /**
+     * Connector type covered by this reference.
+     */
+    type?: 'generic';
+}
+export interface PayConnectorUpdateParams {
+    /**
+     * Configuration for a generic connector. A config update replaces the complete
+     * object, not individual keys. Unknown config keys are discarded. Authentication
+     * credentials must be nonblank strings when required by the selected auth_type.
+     */
+    config?: GenericPayConnectorConfig;
+    /**
+     * Omit to preserve the existing mode. Use an explicit test or live value.
+     */
+    mode?: 'test' | 'live';
+    /**
+     * Generic connector type. Omit to preserve the existing value.
+     */
+    type?: 'generic';
+}
+export declare namespace PayConnectors {
+    export { type GenericPayConnectorConfig as GenericPayConnectorConfig, type PayConnector as PayConnector, type PayConnectorResponse as PayConnectorResponse, type PayConnectorsEmailBracketCursorPagination as PayConnectorsEmailBracketCursorPagination, type PayConnectorListParams as PayConnectorListParams, type PayConnectorCreateParams as PayConnectorCreateParams, type PayConnectorUpdateParams as PayConnectorUpdateParams, };
+}
+//# sourceMappingURL=pay-connectors.d.mts.map

package/resources/pay-connectors.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pay-connectors.d.mts","sourceRoot":"","sources":["../src/resources/pay-connectors.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EACL,4BAA4B,EAC5B,KAAK,kCAAkC,EACvC,WAAW,EACZ,+BAA2B;AAE5B,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yCAAyC,EAAE,YAAY,CAAC;IAOvE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAIlG;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOhE;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAIlF;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;CAGpC;AAED,MAAM,MAAM,yCAAyC,GAAG,4BAA4B,CAAC,YAAY,CAAC,CAAC;AAEnG;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GACjC,yBAAyB,CAAC,2CAA2C,GACrE,yBAAyB,CAAC,oBAAoB,GAC9C,yBAAyB,CAAC,yBAAyB,CAAC;AAExD,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,2CAA2C;QAC1D;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB,SAAS,CAAC,EAAE,OAAO,CAAC;QAEpB;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED,UAAiB,oBAAoB;QACnC;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd,SAAS,EAAE,QAAQ,CAAC;QAEpB;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED,UAAiB,yBAAyB;QACxC,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;CACF;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC;IAE7B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;IAE9B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,YAAY,CAAC;IAC5B;;;OAGG;IACH,UAAiB,MAAM;QACrB;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;QAExC;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,YAAY,CAAC;CACrB;AAED,MAAM,WAAW,sBAAuB,SAAQ,kCAAkC;IAChF;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAElC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,MAAM,CAAC,EAAE,yBAAyB,CAAC;IAEnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}