cloudflare 4.5.0 → 5.1.0

package/src/resources/origin-post-quantum-encryption.ts

@@ -10,7 +10,7 @@ export class OriginPostQuantumEncryption extends APIResource {
    * send a Post-Quantum keyshare in the first message to the origin (for fastest
    * connections when the origin supports and prefers PQ), supported means that PQ
    * algorithms are advertised but only used when requested by the origin, and off
-   * means that PQ algorithms are not advertised
+   * means that PQ algorithms are not advertised.
    */
   update(
     params: OriginPostQuantumEncryptionUpdateParams,
@@ -31,7 +31,7 @@ export class OriginPostQuantumEncryption extends APIResource {
    * send a Post-Quantum keyshare in the first message to the origin (for fastest
    * connections when the origin supports and prefers PQ), supported means that PQ
    * algorithms are advertised but only used when requested by the origin, and off
-   * means that PQ algorithms are not advertised
+   * means that PQ algorithms are not advertised.
    */
   get(
     params: OriginPostQuantumEncryptionGetParams,
@@ -48,17 +48,17 @@ export class OriginPostQuantumEncryption extends APIResource {
 
 export interface OriginPostQuantumEncryptionUpdateResponse {
   /**
-   * Value of the zone setting.
+   * The identifier of the caching setting.
    */
   id: 'origin_pqe';
 
   /**
-   * Whether the setting is editable
+   * Whether the setting is editable.
    */
   editable: boolean;
 
   /**
-   * The value of the feature
+   * Value of the Origin Post Quantum Encryption Setting.
    */
   value: 'preferred' | 'supported' | 'off';
 
@@ -70,17 +70,17 @@ export interface OriginPostQuantumEncryptionUpdateResponse {
 
 export interface OriginPostQuantumEncryptionGetResponse {
   /**
-   * Value of the zone setting.
+   * The identifier of the caching setting.
    */
   id: 'origin_pqe';
 
   /**
-   * Whether the setting is editable
+   * Whether the setting is editable.
    */
   editable: boolean;
 
   /**
-   * The value of the feature
+   * Value of the Origin Post Quantum Encryption Setting.
    */
   value: 'preferred' | 'supported' | 'off';
 
@@ -92,7 +92,7 @@ export interface OriginPostQuantumEncryptionGetResponse {
 
 export interface OriginPostQuantumEncryptionUpdateParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   zone_id: string;
 
@@ -104,7 +104,7 @@ export interface OriginPostQuantumEncryptionUpdateParams {
 
 export interface OriginPostQuantumEncryptionGetParams {
   /**
-   * Identifier
+   * Identifier.
    */
   zone_id: string;
 }

package/src/resources/queues/consumers.ts

@@ -58,6 +58,33 @@ export class Consumers extends APIResource {
     )._thenUnwrap((obj) => obj.result);
   }
 
+  /**
+   * Returns the consumers for a Queue
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const consumer of client.queues.consumers.list(
+   *   '023e105f4ecef8ad9ca31a8372d0c353',
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    queueId: string,
+    params: ConsumerListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ConsumersSinglePage, Consumer> {
+    const { account_id } = params;
+    return this._client.getAPIList(
+      `/accounts/${account_id}/queues/${queueId}/consumers`,
+      ConsumersSinglePage,
+      options,
+    );
+  }
+
   /**
    * Deletes the consumer for a queue.
    *
@@ -81,30 +108,30 @@ export class Consumers extends APIResource {
   }
 
   /**
-   * Returns the consumers for a Queue
+   * Fetches the consumer for a queue by consumer id
    *
    * @example
    * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const consumer of client.queues.consumers.get(
+   * const consumer = await client.queues.consumers.get(
+   *   '023e105f4ecef8ad9ca31a8372d0c353',
    *   '023e105f4ecef8ad9ca31a8372d0c353',
    *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * )) {
-   *   // ...
-   * }
+   * );
    * ```
    */
   get(
     queueId: string,
+    consumerId: string,
     params: ConsumerGetParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ConsumersSinglePage, Consumer> {
+  ): Core.APIPromise<Consumer> {
     const { account_id } = params;
-    return this._client.getAPIList(
-      `/accounts/${account_id}/queues/${queueId}/consumers`,
-      ConsumersSinglePage,
-      options,
-    );
+    return (
+      this._client.get(
+        `/accounts/${account_id}/queues/${queueId}/consumers/${consumerId}`,
+        options,
+      ) as Core.APIPromise<{ result: Consumer }>
+    )._thenUnwrap((obj) => obj.result);
   }
 }
 
@@ -450,6 +477,13 @@ export declare namespace ConsumerUpdateParams {
   }
 }
 
+export interface ConsumerListParams {
+  /**
+   * A Resource identifier.
+   */
+  account_id: string;
+}
+
 export interface ConsumerDeleteParams {
   /**
    * A Resource identifier.
@@ -473,6 +507,7 @@ export declare namespace Consumers {
     ConsumersSinglePage as ConsumersSinglePage,
     type ConsumerCreateParams as ConsumerCreateParams,
     type ConsumerUpdateParams as ConsumerUpdateParams,
+    type ConsumerListParams as ConsumerListParams,
     type ConsumerDeleteParams as ConsumerDeleteParams,
     type ConsumerGetParams as ConsumerGetParams,
   };

package/src/resources/queues/index.ts

@@ -7,6 +7,7 @@ export {
   type ConsumerDeleteResponse,
   type ConsumerCreateParams,
   type ConsumerUpdateParams,
+  type ConsumerListParams,
   type ConsumerDeleteParams,
   type ConsumerGetParams,
 } from './consumers';
@@ -23,3 +24,15 @@ export {
 } from './messages';
 export { Purge, type PurgeStatusResponse, type PurgeStartParams, type PurgeStatusParams } from './purge';
 export { Queues } from './queues';
+export {
+  SubscriptionListResponsesV4PagePaginationArray,
+  Subscriptions,
+  type SubscriptionCreateResponse,
+  type SubscriptionUpdateResponse,
+  type SubscriptionListResponse,
+  type SubscriptionDeleteResponse,
+  type SubscriptionCreateParams,
+  type SubscriptionUpdateParams,
+  type SubscriptionListParams,
+  type SubscriptionDeleteParams,
+} from './subscriptions';

package/src/resources/queues/queues.ts

@@ -10,6 +10,7 @@ import {
   ConsumerDeleteParams,
   ConsumerDeleteResponse,
   ConsumerGetParams,
+  ConsumerListParams,
   ConsumerUpdateParams,
   Consumers,
   ConsumersSinglePage,
@@ -28,12 +29,26 @@ import {
 } from './messages';
 import * as PurgeAPI from './purge';
 import { Purge, PurgeStartParams, PurgeStatusParams, PurgeStatusResponse } from './purge';
+import * as SubscriptionsAPI from './subscriptions';
+import {
+  SubscriptionCreateParams,
+  SubscriptionCreateResponse,
+  SubscriptionDeleteParams,
+  SubscriptionDeleteResponse,
+  SubscriptionListParams,
+  SubscriptionListResponse,
+  SubscriptionListResponsesV4PagePaginationArray,
+  SubscriptionUpdateParams,
+  SubscriptionUpdateResponse,
+  Subscriptions,
+} from './subscriptions';
 import { SinglePage } from '../../pagination';
 
 export class Queues extends APIResource {
-  consumers: ConsumersAPI.Consumers = new ConsumersAPI.Consumers(this._client);
   messages: MessagesAPI.Messages = new MessagesAPI.Messages(this._client);
   purge: PurgeAPI.Purge = new PurgeAPI.Purge(this._client);
+  consumers: ConsumersAPI.Consumers = new ConsumersAPI.Consumers(this._client);
+  subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
 
   /**
    * Create a new queue
@@ -327,10 +342,12 @@ export interface QueueGetParams {
 }
 
 Queues.QueuesSinglePage = QueuesSinglePage;
-Queues.Consumers = Consumers;
-Queues.ConsumersSinglePage = ConsumersSinglePage;
 Queues.Messages = Messages;
 Queues.Purge = Purge;
+Queues.Consumers = Consumers;
+Queues.ConsumersSinglePage = ConsumersSinglePage;
+Queues.Subscriptions = Subscriptions;
+Queues.SubscriptionListResponsesV4PagePaginationArray = SubscriptionListResponsesV4PagePaginationArray;
 
 export declare namespace Queues {
   export {
@@ -345,17 +362,6 @@ export declare namespace Queues {
     type QueueGetParams as QueueGetParams,
   };
 
-  export {
-    Consumers as Consumers,
-    type Consumer as Consumer,
-    type ConsumerDeleteResponse as ConsumerDeleteResponse,
-    ConsumersSinglePage as ConsumersSinglePage,
-    type ConsumerCreateParams as ConsumerCreateParams,
-    type ConsumerUpdateParams as ConsumerUpdateParams,
-    type ConsumerDeleteParams as ConsumerDeleteParams,
-    type ConsumerGetParams as ConsumerGetParams,
-  };
-
   export {
     Messages as Messages,
     type MessageAckResponse as MessageAckResponse,
@@ -374,4 +380,29 @@ export declare namespace Queues {
     type PurgeStartParams as PurgeStartParams,
     type PurgeStatusParams as PurgeStatusParams,
   };
+
+  export {
+    Consumers as Consumers,
+    type Consumer as Consumer,
+    type ConsumerDeleteResponse as ConsumerDeleteResponse,
+    ConsumersSinglePage as ConsumersSinglePage,
+    type ConsumerCreateParams as ConsumerCreateParams,
+    type ConsumerUpdateParams as ConsumerUpdateParams,
+    type ConsumerListParams as ConsumerListParams,
+    type ConsumerDeleteParams as ConsumerDeleteParams,
+    type ConsumerGetParams as ConsumerGetParams,
+  };
+
+  export {
+    Subscriptions as Subscriptions,
+    type SubscriptionCreateResponse as SubscriptionCreateResponse,
+    type SubscriptionUpdateResponse as SubscriptionUpdateResponse,
+    type SubscriptionListResponse as SubscriptionListResponse,
+    type SubscriptionDeleteResponse as SubscriptionDeleteResponse,
+    SubscriptionListResponsesV4PagePaginationArray as SubscriptionListResponsesV4PagePaginationArray,
+    type SubscriptionCreateParams as SubscriptionCreateParams,
+    type SubscriptionUpdateParams as SubscriptionUpdateParams,
+    type SubscriptionListParams as SubscriptionListParams,
+    type SubscriptionDeleteParams as SubscriptionDeleteParams,
+  };
 }