cloudflare 4.2.0 → 4.4.0

package/resources/custom-certificates/custom-certificates.mjs

@@ -10,6 +10,18 @@ export class CustomCertificates extends APIResource {
     }
     /**
      * Upload a new SSL certificate for a zone.
+     *
+     * @example
+     * ```ts
+     * const customCertificate =
+     *   await client.customCertificates.create({
+     *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+     *     certificate:
+     *       '-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n',
+     *     private_key:
+     *       '-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n',
+     *   });
+     * ```
      */
     create(params, options) {
         const { zone_id, ...body } = params;
@@ -19,6 +31,16 @@ export class CustomCertificates extends APIResource {
      * List, search, and filter all of your custom SSL certificates. The higher
      * priority will break ties across overlapping 'legacy_custom' certificates, but
      * 'legacy_custom' certificates will always supercede 'sni_custom' certificates.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customCertificate of client.customCertificates.list(
+     *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     list(params, options) {
         const { zone_id, ...query } = params;
@@ -26,6 +48,15 @@ export class CustomCertificates extends APIResource {
     }
     /**
      * Remove a SSL certificate from a zone.
+     *
+     * @example
+     * ```ts
+     * const customCertificate =
+     *   await client.customCertificates.delete(
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+     *   );
+     * ```
      */
     delete(customCertificateId, params, options) {
         const { zone_id } = params;
@@ -35,6 +66,15 @@ export class CustomCertificates extends APIResource {
      * Upload a new private key and/or PEM/CRT for the SSL certificate. Note: PATCHing
      * a configuration for sni_custom certificates will result in a new resource id
      * being returned, and the previous one being deleted.
+     *
+     * @example
+     * ```ts
+     * const customCertificate =
+     *   await client.customCertificates.edit(
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+     *   );
+     * ```
      */
     edit(customCertificateId, params, options) {
         const { zone_id, ...body } = params;
@@ -45,6 +85,15 @@ export class CustomCertificates extends APIResource {
     }
     /**
      * SSL Configuration Details
+     *
+     * @example
+     * ```ts
+     * const customCertificate =
+     *   await client.customCertificates.get(
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+     *   );
+     * ```
      */
     get(customCertificateId, params, options) {
         const { zone_id } = params;
@@ -55,5 +104,6 @@ export class CustomCertificatesV4PagePaginationArray extends V4PagePaginationArr
 }
 export class CustomCertificatesSinglePage extends SinglePage {
 }
+CustomCertificates.CustomCertificatesV4PagePaginationArray = CustomCertificatesV4PagePaginationArray;
 CustomCertificates.Prioritize = Prioritize;
 //# sourceMappingURL=custom-certificates.mjs.map

package/resources/custom-certificates/custom-certificates.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"custom-certificates.mjs","sourceRoot":"","sources":["../../src/resources/custom-certificates/custom-certificates.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,aAAa;OAClB,EAAE,UAAU,EAA0B;OAEtC,EAAE,UAAU,EAAE,qBAAqB,EAAoC;AAE9E,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IAAnD;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsFpF,CAAC;IApFC;;OAEG;IACH,MAAM,CACJ,MAAqC,EACrC,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OACE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,OAAO,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAGhF,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,IAAI,CACF,MAAmC,EACnC,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,UAAU,OAAO,sBAAsB,EACvC,uCAAuC,EACvC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,mBAA2B,EAC3B,MAAqC,EACrC,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OACE,IAAI,CAAC,OAAO,CAAC,MAAM,CACjB,UAAU,OAAO,wBAAwB,mBAAmB,EAAE,EAC9D,OAAO,CAEV,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,IAAI,CACF,mBAA2B,EAC3B,MAAmC,EACnC,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OACE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,OAAO,wBAAwB,mBAAmB,EAAE,EAAE;YACjF,IAAI;YACJ,GAAG,OAAO;SACX,CACF,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,GAAG,CACD,mBAA2B,EAC3B,MAAkC,EAClC,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OACE,IAAI,CAAC,OAAO,CAAC,GAAG,CACd,UAAU,OAAO,wBAAwB,mBAAmB,EAAE,EAC9D,OAAO,CAEV,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;CACF;AAED,MAAM,OAAO,uCAAwC,SAAQ,qBAAwC;CAAG;AAExG,MAAM,OAAO,4BAA6B,SAAQ,UAA6B;CAAG;AAsQlF,kBAAkB,CAAC,UAAU,GAAG,UAAU,CAAC"}
+{"version":3,"file":"custom-certificates.mjs","sourceRoot":"","sources":["../../src/resources/custom-certificates/custom-certificates.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,aAAa;OAClB,EAAE,UAAU,EAA0B;OAEtC,EAAE,UAAU,EAAE,qBAAqB,EAAoC;AAE9E,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IAAnD;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuIpF,CAAC;IArIC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,MAAqC,EACrC,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OACE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,OAAO,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAGhF,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,MAAmC,EACnC,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,UAAU,OAAO,sBAAsB,EACvC,uCAAuC,EACvC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,mBAA2B,EAC3B,MAAqC,EACrC,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OACE,IAAI,CAAC,OAAO,CAAC,MAAM,CACjB,UAAU,OAAO,wBAAwB,mBAAmB,EAAE,EAC9D,OAAO,CAEV,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,mBAA2B,EAC3B,MAAmC,EACnC,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OACE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,OAAO,wBAAwB,mBAAmB,EAAE,EAAE;YACjF,IAAI;YACJ,GAAG,OAAO;SACX,CACF,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,GAAG,CACD,mBAA2B,EAC3B,MAAkC,EAClC,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OACE,IAAI,CAAC,OAAO,CAAC,GAAG,CACd,UAAU,OAAO,wBAAwB,mBAAmB,EAAE,EAC9D,OAAO,CAEV,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;CACF;AAED,MAAM,OAAO,uCAAwC,SAAQ,qBAAwC;CAAG;AAExG,MAAM,OAAO,4BAA6B,SAAQ,UAA6B;CAAG;AAsQlF,kBAAkB,CAAC,uCAAuC,GAAG,uCAAuC,CAAC;AACrG,kBAAkB,CAAC,UAAU,GAAG,UAAU,CAAC"}

package/resources/custom-certificates/prioritize.d.ts

@@ -7,12 +7,25 @@ export declare class Prioritize extends APIResource {
      * If a zone has multiple SSL certificates, you can set the order in which they
      * should be used during a request. The higher priority will break ties across
      * overlapping 'legacy_custom' certificates.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customCertificate of client.customCertificates.prioritize.update(
+     *   {
+     *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+     *     certificates: [{}, {}],
+     *   },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     update(params: PrioritizeUpdateParams, options?: Core.RequestOptions): Core.PagePromise<CustomCertificatesSinglePage, CustomCertificatesAPI.CustomCertificate>;
 }
 export interface PrioritizeUpdateParams {
     /**
-     * Path param: Identifier
+     * Path param: Identifier.
      */
     zone_id: string;
     /**
@@ -23,7 +36,7 @@ export interface PrioritizeUpdateParams {
 export declare namespace PrioritizeUpdateParams {
     interface Certificate {
         /**
-         * Identifier
+         * Identifier.
          */
         id?: string;
         /**

package/resources/custom-certificates/prioritize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prioritize.d.ts","sourceRoot":"","sources":["../../src/resources/custom-certificates/prioritize.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,qBAAqB,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAC;AAErE,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;OAIG;IACH,MAAM,CACJ,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE,qBAAqB,CAAC,iBAAiB,CAAC;CAQ3F;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;CACzD;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;;;;WAKG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EAAE,KAAK,sBAAsB,IAAI,sBAAsB,EAAE,CAAC;CAClE;AAED,OAAO,EAAE,4BAA4B,EAAE,CAAC"}
+{"version":3,"file":"prioritize.d.ts","sourceRoot":"","sources":["../../src/resources/custom-certificates/prioritize.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,qBAAqB,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAC;AAErE,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE,qBAAqB,CAAC,iBAAiB,CAAC;CAQ3F;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;CACzD;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;;;;WAKG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EAAE,KAAK,sBAAsB,IAAI,sBAAsB,EAAE,CAAC;CAClE;AAED,OAAO,EAAE,4BAA4B,EAAE,CAAC"}

package/resources/custom-certificates/prioritize.js

@@ -10,6 +10,19 @@ class Prioritize extends resource_1.APIResource {
      * If a zone has multiple SSL certificates, you can set the order in which they
      * should be used during a request. The higher priority will break ties across
      * overlapping 'legacy_custom' certificates.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customCertificate of client.customCertificates.prioritize.update(
+     *   {
+     *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+     *     certificates: [{}, {}],
+     *   },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     update(params, options) {
         const { zone_id, ...body } = params;

package/resources/custom-certificates/prioritize.js.map

@@ -1 +1 @@
-{"version":3,"file":"prioritize.js","sourceRoot":"","sources":["../../src/resources/custom-certificates/prioritize.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,kEAAqE;AAsD5D,6GAtDA,kDAA4B,OAsDA;AApDrC,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;OAIG;IACH,MAAM,CACJ,MAA8B,EAC9B,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,UAAU,OAAO,iCAAiC,EAClD,kDAA4B,EAC5B,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACpC,CAAC;IACJ,CAAC;CACF;AAjBD,gCAiBC"}
+{"version":3,"file":"prioritize.js","sourceRoot":"","sources":["../../src/resources/custom-certificates/prioritize.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,kEAAqE;AAmE5D,6GAnEA,kDAA4B,OAmEA;AAjErC,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,MAA8B,EAC9B,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,UAAU,OAAO,iCAAiC,EAClD,kDAA4B,EAC5B,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACpC,CAAC;IACJ,CAAC;CACF;AA9BD,gCA8BC"}

package/resources/custom-certificates/prioritize.mjs

@@ -6,6 +6,19 @@ export class Prioritize extends APIResource {
      * If a zone has multiple SSL certificates, you can set the order in which they
      * should be used during a request. The higher priority will break ties across
      * overlapping 'legacy_custom' certificates.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customCertificate of client.customCertificates.prioritize.update(
+     *   {
+     *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+     *     certificates: [{}, {}],
+     *   },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     update(params, options) {
         const { zone_id, ...body } = params;

package/resources/custom-certificates/prioritize.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"prioritize.mjs","sourceRoot":"","sources":["../../src/resources/custom-certificates/prioritize.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,4BAA4B,EAAE;AAEvC,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;OAIG;IACH,MAAM,CACJ,MAA8B,EAC9B,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,UAAU,OAAO,iCAAiC,EAClD,4BAA4B,EAC5B,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACpC,CAAC;IACJ,CAAC;CACF;AAmCD,OAAO,EAAE,4BAA4B,EAAE,CAAC"}
+{"version":3,"file":"prioritize.mjs","sourceRoot":"","sources":["../../src/resources/custom-certificates/prioritize.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,4BAA4B,EAAE;AAEvC,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,MAA8B,EAC9B,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,UAAU,OAAO,iCAAiC,EAClD,4BAA4B,EAC5B,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACpC,CAAC;IACJ,CAAC;CACF;AAmCD,OAAO,EAAE,4BAA4B,EAAE,CAAC"}

package/resources/custom-hostnames/certificate-pack/certificates.d.ts

@@ -8,6 +8,23 @@ export declare class Certificates extends APIResource {
      * bundled certificates. The replacement must adhere to the following constraints.
      * You can only replace an RSA certificate with another RSA certificate or an ECDSA
      * certificate with another ECDSA certificate.
+     *
+     * @example
+     * ```ts
+     * const certificate =
+     *   await client.customHostnames.certificatePack.certificates.update(
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     {
+     *       zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+     *       custom_certificate:
+     *         '-----BEGIN CERTIFICATE-----\nMIIDdjCCAl6gAwIBAgIJAPnMg0Fs+/B0MA0GCSqGSIb3DQEBCwUAMFsx...\n-----END CERTIFICATE-----\n',
+     *       custom_key:
+     *         '-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC/SCB5...\n-----END PRIVATE KEY-----\n',
+     *     },
+     *   );
+     * ```
      */
     update(customHostnameId: string, certificatePackId: string, certificateId: string, params: CertificateUpdateParams, options?: Core.RequestOptions): Core.APIPromise<CertificateUpdateResponse>;
     /**
@@ -15,12 +32,23 @@ export declare class Certificates extends APIResource {
      * bundled certificates. Deletion is subject to the following constraints. You
      * cannot delete a certificate if it is the only remaining certificate in the pack.
      * At least one certificate must remain in the pack.
+     *
+     * @example
+     * ```ts
+     * const certificate =
+     *   await client.customHostnames.certificatePack.certificates.delete(
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+     *   );
+     * ```
      */
     delete(customHostnameId: string, certificatePackId: string, certificateId: string, params: CertificateDeleteParams, options?: Core.RequestOptions): Core.APIPromise<CertificateDeleteResponse>;
 }
 export interface CertificateUpdateResponse {
     /**
-     * Identifier
+     * Identifier.
      */
     id: string;
     /**
@@ -238,13 +266,13 @@ export declare namespace CertificateUpdateResponse {
 }
 export interface CertificateDeleteResponse {
     /**
-     * Identifier
+     * Identifier.
      */
     id?: string;
 }
 export interface CertificateUpdateParams {
     /**
-     * Path param: Identifier
+     * Path param: Identifier.
      */
     zone_id: string;
     /**
@@ -258,7 +286,7 @@ export interface CertificateUpdateParams {
 }
 export interface CertificateDeleteParams {
     /**
-     * Identifier
+     * Identifier.
      */
     zone_id: string;
 }

package/resources/custom-hostnames/certificate-pack/certificates.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"certificates.d.ts","sourceRoot":"","sources":["../../../src/resources/custom-hostnames/certificate-pack/certificates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,kBAAkB,MAAM,qBAAqB,CAAC;AAE1D,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;OAKG;IACH,MAAM,CACJ,gBAAgB,EAAE,MAAM,EACxB,iBAAiB,EAAE,MAAM,EACzB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAU7C;;;;;OAKG;IACH,MAAM,CACJ,gBAAgB,EAAE,MAAM,EACxB,iBAAiB,EAAE,MAAM,EACzB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;CAO9C;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,GAAG,EAAE,yBAAyB,CAAC,GAAG,CAAC;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEzC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,sBAAsB,CAAC,EAAE,yBAAyB,CAAC,qBAAqB,CAAC;IAEzE;;;OAGG;IACH,2BAA2B,CAAC,EAAE,yBAAyB,CAAC,yBAAyB,CAAC;IAElF;;OAEG;IACH,MAAM,CAAC,EACH,QAAQ,GACR,SAAS,GACT,oBAAoB,GACpB,OAAO,GACP,kBAAkB,GAClB,SAAS,GACT,iBAAiB,GACjB,mBAAmB,GACnB,qBAAqB,GACrB,cAAc,GACd,aAAa,GACb,kBAAkB,GAClB,cAAc,GACd,aAAa,GACb,aAAa,GACb,SAAS,CAAC;IAEd;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,GAAG;QAClB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;;;;WAKG;QACH,aAAa,CAAC,EAAE,kBAAkB,CAAC,YAAY,CAAC;QAEhD;;WAEG;QACH,qBAAqB,CAAC,EAAE,MAAM,CAAC,aAAa,CAAC;QAE7C;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,MAAM,CAAC,EAAE,kBAAkB,CAAC,SAAS,CAAC;QAEtC;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,QAAQ,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC;QAExB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,MAAM,CAAC,EACH,cAAc,GACd,oBAAoB,GACpB,SAAS,GACT,kBAAkB,GAClB,oBAAoB,GACpB,kBAAkB,GAClB,oBAAoB,GACpB,SAAS,GACT,QAAQ,GACR,wBAAwB,GACxB,sBAAsB,GACtB,oBAAoB,GACpB,sBAAsB,GACtB,oBAAoB,GACpB,iBAAiB,GACjB,oBAAoB,GACpB,gBAAgB,GAChB,cAAc,GACd,UAAU,GACV,eAAe,GACf,oBAAoB,CAAC;QAEzB;;;WAGG;QACH,IAAI,CAAC,EAAE,kBAAkB,CAAC,oBAAoB,CAAC;QAE/C;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAE/C,kBAAkB,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAEjD;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED,UAAiB,GAAG,CAAC;QACnB,UAAiB,QAAQ;YACvB;;;eAGG;YACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAExB;;eAEG;YACH,WAAW,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC;YAE3B;;eAEG;YACH,KAAK,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC;YAErB;;eAEG;YACH,eAAe,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;YAEhD;;eAEG;YACH,OAAO,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC;SACxB;QAED,UAAiB,eAAe;YAC9B;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB;QAED,UAAiB,gBAAgB;YAC/B;;;eAGG;YACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEvB;;;eAGG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;;eAGG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB;KACF;IAED;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,KAAK,CAAC;QAEb;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;;OAGG;IACH,UAAiB,yBAAyB;QACxC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
+{"version":3,"file":"certificates.d.ts","sourceRoot":"","sources":["../../../src/resources/custom-hostnames/certificate-pack/certificates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,kBAAkB,MAAM,qBAAqB,CAAC;AAE1D,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CACJ,gBAAgB,EAAE,MAAM,EACxB,iBAAiB,EAAE,MAAM,EACzB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAU7C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,gBAAgB,EAAE,MAAM,EACxB,iBAAiB,EAAE,MAAM,EACzB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;CAO9C;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,GAAG,EAAE,yBAAyB,CAAC,GAAG,CAAC;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEzC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,sBAAsB,CAAC,EAAE,yBAAyB,CAAC,qBAAqB,CAAC;IAEzE;;;OAGG;IACH,2BAA2B,CAAC,EAAE,yBAAyB,CAAC,yBAAyB,CAAC;IAElF;;OAEG;IACH,MAAM,CAAC,EACH,QAAQ,GACR,SAAS,GACT,oBAAoB,GACpB,OAAO,GACP,kBAAkB,GAClB,SAAS,GACT,iBAAiB,GACjB,mBAAmB,GACnB,qBAAqB,GACrB,cAAc,GACd,aAAa,GACb,kBAAkB,GAClB,cAAc,GACd,aAAa,GACb,aAAa,GACb,SAAS,CAAC;IAEd;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,GAAG;QAClB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;;;;WAKG;QACH,aAAa,CAAC,EAAE,kBAAkB,CAAC,YAAY,CAAC;QAEhD;;WAEG;QACH,qBAAqB,CAAC,EAAE,MAAM,CAAC,aAAa,CAAC;QAE7C;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,MAAM,CAAC,EAAE,kBAAkB,CAAC,SAAS,CAAC;QAEtC;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,QAAQ,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC;QAExB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,MAAM,CAAC,EACH,cAAc,GACd,oBAAoB,GACpB,SAAS,GACT,kBAAkB,GAClB,oBAAoB,GACpB,kBAAkB,GAClB,oBAAoB,GACpB,SAAS,GACT,QAAQ,GACR,wBAAwB,GACxB,sBAAsB,GACtB,oBAAoB,GACpB,sBAAsB,GACtB,oBAAoB,GACpB,iBAAiB,GACjB,oBAAoB,GACpB,gBAAgB,GAChB,cAAc,GACd,UAAU,GACV,eAAe,GACf,oBAAoB,CAAC;QAEzB;;;WAGG;QACH,IAAI,CAAC,EAAE,kBAAkB,CAAC,oBAAoB,CAAC;QAE/C;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAE/C,kBAAkB,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAEjD;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED,UAAiB,GAAG,CAAC;QACnB,UAAiB,QAAQ;YACvB;;;eAGG;YACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAExB;;eAEG;YACH,WAAW,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC;YAE3B;;eAEG;YACH,KAAK,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC;YAErB;;eAEG;YACH,eAAe,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;YAEhD;;eAEG;YACH,OAAO,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC;SACxB;QAED,UAAiB,eAAe;YAC9B;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB;QAED,UAAiB,gBAAgB;YAC/B;;;eAGG;YACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEvB;;;eAGG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;;eAGG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB;KACF;IAED;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,KAAK,CAAC;QAEb;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;;OAGG;IACH,UAAiB,yBAAyB;QACxC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/custom-hostnames/certificate-pack/certificates.js

@@ -9,6 +9,23 @@ class Certificates extends resource_1.APIResource {
      * bundled certificates. The replacement must adhere to the following constraints.
      * You can only replace an RSA certificate with another RSA certificate or an ECDSA
      * certificate with another ECDSA certificate.
+     *
+     * @example
+     * ```ts
+     * const certificate =
+     *   await client.customHostnames.certificatePack.certificates.update(
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     {
+     *       zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+     *       custom_certificate:
+     *         '-----BEGIN CERTIFICATE-----\nMIIDdjCCAl6gAwIBAgIJAPnMg0Fs+/B0MA0GCSqGSIb3DQEBCwUAMFsx...\n-----END CERTIFICATE-----\n',
+     *       custom_key:
+     *         '-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC/SCB5...\n-----END PRIVATE KEY-----\n',
+     *     },
+     *   );
+     * ```
      */
     update(customHostnameId, certificatePackId, certificateId, params, options) {
         const { zone_id, ...body } = params;
@@ -19,6 +36,17 @@ class Certificates extends resource_1.APIResource {
      * bundled certificates. Deletion is subject to the following constraints. You
      * cannot delete a certificate if it is the only remaining certificate in the pack.
      * At least one certificate must remain in the pack.
+     *
+     * @example
+     * ```ts
+     * const certificate =
+     *   await client.customHostnames.certificatePack.certificates.delete(
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+     *   );
+     * ```
      */
     delete(customHostnameId, certificatePackId, certificateId, params, options) {
         const { zone_id } = params;

package/resources/custom-hostnames/certificate-pack/certificates.js.map

@@ -1 +1 @@
-{"version":3,"file":"certificates.js","sourceRoot":"","sources":["../../../src/resources/custom-hostnames/certificate-pack/certificates.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAKhD,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;OAKG;IACH,MAAM,CACJ,gBAAwB,EACxB,iBAAyB,EACzB,aAAqB,EACrB,MAA+B,EAC/B,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OACE,IAAI,CAAC,OAAO,CAAC,GAAG,CACd,UAAU,OAAO,qBAAqB,gBAAgB,qBAAqB,iBAAiB,iBAAiB,aAAa,EAAE,EAC5H,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAEvB,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CACJ,gBAAwB,EACxB,iBAAyB,EACzB,aAAqB,EACrB,MAA+B,EAC/B,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CACxB,UAAU,OAAO,qBAAqB,gBAAgB,qBAAqB,iBAAiB,iBAAiB,aAAa,EAAE,EAC5H,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AA1CD,oCA0CC"}
+{"version":3,"file":"certificates.js","sourceRoot":"","sources":["../../../src/resources/custom-hostnames/certificate-pack/certificates.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAKhD,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CACJ,gBAAwB,EACxB,iBAAyB,EACzB,aAAqB,EACrB,MAA+B,EAC/B,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OACE,IAAI,CAAC,OAAO,CAAC,GAAG,CACd,UAAU,OAAO,qBAAqB,gBAAgB,qBAAqB,iBAAiB,iBAAiB,aAAa,EAAE,EAC5H,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAEvB,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,gBAAwB,EACxB,iBAAyB,EACzB,aAAqB,EACrB,MAA+B,EAC/B,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CACxB,UAAU,OAAO,qBAAqB,gBAAgB,qBAAqB,iBAAiB,iBAAiB,aAAa,EAAE,EAC5H,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAtED,oCAsEC"}

package/resources/custom-hostnames/certificate-pack/certificates.mjs

@@ -6,6 +6,23 @@ export class Certificates extends APIResource {
      * bundled certificates. The replacement must adhere to the following constraints.
      * You can only replace an RSA certificate with another RSA certificate or an ECDSA
      * certificate with another ECDSA certificate.
+     *
+     * @example
+     * ```ts
+     * const certificate =
+     *   await client.customHostnames.certificatePack.certificates.update(
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     {
+     *       zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+     *       custom_certificate:
+     *         '-----BEGIN CERTIFICATE-----\nMIIDdjCCAl6gAwIBAgIJAPnMg0Fs+/B0MA0GCSqGSIb3DQEBCwUAMFsx...\n-----END CERTIFICATE-----\n',
+     *       custom_key:
+     *         '-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC/SCB5...\n-----END PRIVATE KEY-----\n',
+     *     },
+     *   );
+     * ```
      */
     update(customHostnameId, certificatePackId, certificateId, params, options) {
         const { zone_id, ...body } = params;
@@ -16,6 +33,17 @@ export class Certificates extends APIResource {
      * bundled certificates. Deletion is subject to the following constraints. You
      * cannot delete a certificate if it is the only remaining certificate in the pack.
      * At least one certificate must remain in the pack.
+     *
+     * @example
+     * ```ts
+     * const certificate =
+     *   await client.customHostnames.certificatePack.certificates.delete(
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     '023e105f4ecef8ad9ca31a8372d0c353',
+     *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+     *   );
+     * ```
      */
     delete(customHostnameId, certificatePackId, certificateId, params, options) {
         const { zone_id } = params;

package/resources/custom-hostnames/certificate-pack/certificates.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"certificates.mjs","sourceRoot":"","sources":["../../../src/resources/custom-hostnames/certificate-pack/certificates.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;OAKG;IACH,MAAM,CACJ,gBAAwB,EACxB,iBAAyB,EACzB,aAAqB,EACrB,MAA+B,EAC/B,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OACE,IAAI,CAAC,OAAO,CAAC,GAAG,CACd,UAAU,OAAO,qBAAqB,gBAAgB,qBAAqB,iBAAiB,iBAAiB,aAAa,EAAE,EAC5H,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAEvB,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CACJ,gBAAwB,EACxB,iBAAyB,EACzB,aAAqB,EACrB,MAA+B,EAC/B,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CACxB,UAAU,OAAO,qBAAqB,gBAAgB,qBAAqB,iBAAiB,iBAAiB,aAAa,EAAE,EAC5H,OAAO,CACR,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"certificates.mjs","sourceRoot":"","sources":["../../../src/resources/custom-hostnames/certificate-pack/certificates.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CACJ,gBAAwB,EACxB,iBAAyB,EACzB,aAAqB,EACrB,MAA+B,EAC/B,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OACE,IAAI,CAAC,OAAO,CAAC,GAAG,CACd,UAAU,OAAO,qBAAqB,gBAAgB,qBAAqB,iBAAiB,iBAAiB,aAAa,EAAE,EAC5H,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAEvB,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,gBAAwB,EACxB,iBAAyB,EACzB,aAAqB,EACrB,MAA+B,EAC/B,OAA6B;QAE7B,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CACxB,UAAU,OAAO,qBAAqB,gBAAgB,qBAAqB,iBAAiB,iBAAiB,aAAa,EAAE,EAC5H,OAAO,CACR,CAAC;IACJ,CAAC;CACF"}

package/resources/custom-hostnames/custom-hostnames.d.ts

@@ -21,14 +21,41 @@ export declare class CustomHostnames extends APIResource {
      * certificates using the custom_cert_bundle field. The bundling process requires
      * the following condition One certificate in the bundle must use an RSA, and the
      * other must use an ECDSA.
+     *
+     * @example
+     * ```ts
+     * const customHostname = await client.customHostnames.create({
+     *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+     *   hostname: 'app.example.com',
+     *   ssl: {},
+     * });
+     * ```
      */
     create(params: CustomHostnameCreateParams, options?: Core.RequestOptions): Core.APIPromise<CustomHostnameCreateResponse>;
     /**
      * List, search, sort, and filter all of your custom hostnames.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customHostnameListResponse of client.customHostnames.list(
+     *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     list(params: CustomHostnameListParams, options?: Core.RequestOptions): Core.PagePromise<CustomHostnameListResponsesV4PagePaginationArray, CustomHostnameListResponse>;
     /**
      * Delete Custom Hostname (and any issued SSL certificates)
+     *
+     * @example
+     * ```ts
+     * const customHostname = await client.customHostnames.delete(
+     *   '023e105f4ecef8ad9ca31a8372d0c353',
+     *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+     * );
+     * ```
      */
     delete(customHostnameId: string, params: CustomHostnameDeleteParams, options?: Core.RequestOptions): Core.APIPromise<CustomHostnameDeleteResponse>;
     /**
@@ -39,10 +66,26 @@ export declare class CustomHostnames extends APIResource {
      * using the "custom_cert_bundle" field. The bundling process supports combining
      * certificates as long as the following condition is met. One certificate must use
      * the RSA algorithm, and the other must use the ECDSA algorithm.
+     *
+     * @example
+     * ```ts
+     * const response = await client.customHostnames.edit(
+     *   '023e105f4ecef8ad9ca31a8372d0c353',
+     *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+     * );
+     * ```
      */
     edit(customHostnameId: string, params: CustomHostnameEditParams, options?: Core.RequestOptions): Core.APIPromise<CustomHostnameEditResponse>;
     /**
      * Custom Hostname Details
+     *
+     * @example
+     * ```ts
+     * const customHostname = await client.customHostnames.get(
+     *   '023e105f4ecef8ad9ca31a8372d0c353',
+     *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+     * );
+     * ```
      */
     get(customHostnameId: string, params: CustomHostnameGetParams, options?: Core.RequestOptions): Core.APIPromise<CustomHostnameGetResponse>;
 }
@@ -64,7 +107,7 @@ export type BundleMethod = 'ubiquitous' | 'optimal' | 'force';
 export type BundleMethodParam = 'ubiquitous' | 'optimal' | 'force';
 export interface CustomHostname {
     /**
-     * Identifier
+     * Identifier.
      */
     id: string;
     /**
@@ -300,7 +343,7 @@ export type DomainValidationType = 'dv';
 export type DomainValidationTypeParam = 'dv';
 export interface CustomHostnameCreateResponse {
     /**
-     * Identifier
+     * Identifier.
      */
     id: string;
     /**
@@ -518,7 +561,7 @@ export declare namespace CustomHostnameCreateResponse {
 }
 export interface CustomHostnameListResponse {
     /**
-     * Identifier
+     * Identifier.
      */
     id: string;
     /**
@@ -736,13 +779,13 @@ export declare namespace CustomHostnameListResponse {
 }
 export interface CustomHostnameDeleteResponse {
     /**
-     * Identifier
+     * Identifier.
      */
     id?: string;
 }
 export interface CustomHostnameEditResponse {
     /**
-     * Identifier
+     * Identifier.
      */
     id: string;
     /**
@@ -960,7 +1003,7 @@ export declare namespace CustomHostnameEditResponse {
 }
 export interface CustomHostnameGetResponse {
     /**
-     * Identifier
+     * Identifier.
      */
     id: string;
     /**
@@ -1178,7 +1221,7 @@ export declare namespace CustomHostnameGetResponse {
 }
 export interface CustomHostnameCreateParams {
     /**
-     * Path param: Identifier
+     * Path param: Identifier.
      */
     zone_id: string;
     /**
@@ -1287,7 +1330,7 @@ export declare namespace CustomHostnameCreateParams {
 }
 export interface CustomHostnameListParams extends V4PagePaginationArrayParams {
     /**
-     * Path param: Identifier
+     * Path param: Identifier.
      */
     zone_id: string;
     /**
@@ -1316,13 +1359,13 @@ export interface CustomHostnameListParams extends V4PagePaginationArrayParams {
 }
 export interface CustomHostnameDeleteParams {
     /**
-     * Identifier
+     * Identifier.
      */
     zone_id: string;
 }
 export interface CustomHostnameEditParams {
     /**
-     * Path param: Identifier
+     * Path param: Identifier.
      */
     zone_id: string;
     /**
@@ -1440,11 +1483,12 @@ export declare namespace CustomHostnameEditParams {
 }
 export interface CustomHostnameGetParams {
     /**
-     * Identifier
+     * Identifier.
      */
     zone_id: string;
 }
 export declare namespace CustomHostnames {
+    export { type BundleMethod as BundleMethod, type CustomHostname as CustomHostname, type DCVMethod as DCVMethod, type DomainValidationType as DomainValidationType, type CustomHostnameCreateResponse as CustomHostnameCreateResponse, type CustomHostnameListResponse as CustomHostnameListResponse, type CustomHostnameDeleteResponse as CustomHostnameDeleteResponse, type CustomHostnameEditResponse as CustomHostnameEditResponse, type CustomHostnameGetResponse as CustomHostnameGetResponse, CustomHostnameListResponsesV4PagePaginationArray as CustomHostnameListResponsesV4PagePaginationArray, type CustomHostnameCreateParams as CustomHostnameCreateParams, type CustomHostnameListParams as CustomHostnameListParams, type CustomHostnameDeleteParams as CustomHostnameDeleteParams, type CustomHostnameEditParams as CustomHostnameEditParams, type CustomHostnameGetParams as CustomHostnameGetParams, };
     export { FallbackOrigin as FallbackOrigin, type FallbackOriginUpdateResponse as FallbackOriginUpdateResponse, type FallbackOriginDeleteResponse as FallbackOriginDeleteResponse, type FallbackOriginGetResponse as FallbackOriginGetResponse, type FallbackOriginUpdateParams as FallbackOriginUpdateParams, type FallbackOriginDeleteParams as FallbackOriginDeleteParams, type FallbackOriginGetParams as FallbackOriginGetParams, };
     export { CertificatePack as CertificatePack };
 }