cloudflare 3.0.0-beta.13 → 3.0.0-beta.14

package/resources/rulesets/rules.mjs

@@ -52,7 +52,7 @@ export class Rules extends APIResource {
         return this._client.delete(`/${accountOrZone}/${accountOrZoneId}/rulesets/${rulesetId}/rules/${ruleId}`, options)._thenUnwrap((obj) => obj.result);
     }
     /**
-     * Updates an existing rule in an account ruleset.
+     * Updates an existing rule in an account or zone ruleset.
      */
     edit(rulesetId, ruleId, params, options) {
         const { account_id, zone_id, ...body } = params;

package/src/index.ts

@@ -636,8 +636,11 @@ export namespace Cloudflare {
   export import WorkersQueue = API.WorkersQueue;
   export import WorkersQueueCreated = API.WorkersQueueCreated;
   export import WorkersQueueUpdated = API.WorkersQueueUpdated;
+  export import QueueCreateResponse = API.QueueCreateResponse;
+  export import QueueUpdateResponse = API.QueueUpdateResponse;
   export import QueueListResponse = API.QueueListResponse;
   export import QueueDeleteResponse = API.QueueDeleteResponse;
+  export import QueueGetResponse = API.QueueGetResponse;
   export import QueueCreateParams = API.QueueCreateParams;
   export import QueueUpdateParams = API.QueueUpdateParams;
   export import QueueListParams = API.QueueListParams;

package/src/resources/firewall/access-rules.ts

@@ -123,9 +123,9 @@ export class AccessRules extends APIResource {
   }
 
   /**
-   * Updates an IP Access rule defined at the account level.
+   * Updates an IP Access rule defined.
    *
-   * Note: This operation will affect all zones in the account.
+   * Note: This operation will affect all zones in the account or zone.
    */
   edit(
     identifier: unknown,

package/src/resources/index.ts

@@ -364,8 +364,11 @@ export {
   WorkersQueue,
   WorkersQueueCreated,
   WorkersQueueUpdated,
+  QueueCreateResponse,
+  QueueUpdateResponse,
   QueueListResponse,
   QueueDeleteResponse,
+  QueueGetResponse,
   QueueCreateParams,
   QueueUpdateParams,
   QueueListParams,

package/src/resources/queues/consumers.ts

@@ -9,16 +9,16 @@ export class Consumers extends APIResource {
    * Creates a new consumer for a queue.
    */
   create(
-    name: string,
+    queueId: string,
     params: ConsumerCreateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<WorkersConsumerCreated | null> {
+  ): Core.APIPromise<ConsumerCreateResponse | null> {
     const { account_id, body } = params;
     return (
-      this._client.post(`/accounts/${account_id}/workers/queues/${name}/consumers`, {
+      this._client.post(`/accounts/${account_id}/queues/${queueId}/consumers`, {
         body: body,
         ...options,
-      }) as Core.APIPromise<{ result: WorkersConsumerCreated | null }>
+      }) as Core.APIPromise<{ result: ConsumerCreateResponse | null }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -26,17 +26,17 @@ export class Consumers extends APIResource {
    * Updates the consumer for a queue, or creates one if it does not exist.
    */
   update(
-    name: string,
-    consumerName: string,
+    queueId: string,
+    consumerId: string,
     params: ConsumerUpdateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<WorkersConsumerUpdated | null> {
+  ): Core.APIPromise<ConsumerUpdateResponse | null> {
     const { account_id, body } = params;
     return (
-      this._client.put(`/accounts/${account_id}/workers/queues/${name}/consumers/${consumerName}`, {
+      this._client.put(`/accounts/${account_id}/queues/${queueId}/consumers/${consumerId}`, {
         body: body,
         ...options,
-      }) as Core.APIPromise<{ result: WorkersConsumerUpdated | null }>
+      }) as Core.APIPromise<{ result: ConsumerUpdateResponse | null }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -44,15 +44,15 @@ export class Consumers extends APIResource {
    * Deletes the consumer for a queue.
    */
   delete(
-    name: string,
-    consumerName: string,
+    queueId: string,
+    consumerId: string,
     params: ConsumerDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<ConsumerDeleteResponse | null> {
     const { account_id } = params;
     return (
       this._client.delete(
-        `/accounts/${account_id}/workers/queues/${name}/consumers/${consumerName}`,
+        `/accounts/${account_id}/queues/${queueId}/consumers/${consumerId}`,
         options,
       ) as Core.APIPromise<{ result: ConsumerDeleteResponse | null }>
     )._thenUnwrap((obj) => obj.result);
@@ -62,34 +62,38 @@ export class Consumers extends APIResource {
    * Returns the consumers for a queue.
    */
   get(
-    name: string,
+    queueId: string,
     params: ConsumerGetParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<ConsumerGetResponse | null> {
     const { account_id } = params;
     return (
-      this._client.get(
-        `/accounts/${account_id}/workers/queues/${name}/consumers`,
-        options,
-      ) as Core.APIPromise<{ result: ConsumerGetResponse | null }>
+      this._client.get(`/accounts/${account_id}/queues/${queueId}/consumers`, options) as Core.APIPromise<{
+        result: ConsumerGetResponse | null;
+      }>
     )._thenUnwrap((obj) => obj.result);
   }
 }
 
-export interface WorkersConsumer {
+export interface ConsumerCreateResponse {
   created_on?: unknown;
 
+  dead_letter_queue?: string;
+
   environment?: unknown;
 
   queue_name?: unknown;
 
-  service?: unknown;
+  script_name?: unknown;
 
-  settings?: WorkersConsumer.Settings;
+  settings?: ConsumerCreateResponse.Settings;
 }
 
-export namespace WorkersConsumer {
+export namespace ConsumerCreateResponse {
   export interface Settings {
+    /**
+     * The maximum number of messages to include in a batch
+     */
     batch_size?: number;
 
     max_retries?: number;
@@ -98,7 +102,7 @@ export namespace WorkersConsumer {
   }
 }
 
-export interface WorkersConsumerCreated {
+export interface ConsumerUpdateResponse {
   created_on?: unknown;
 
   dead_letter_queue?: string;
@@ -109,10 +113,10 @@ export interface WorkersConsumerCreated {
 
   script_name?: unknown;
 
-  settings?: WorkersConsumerCreated.Settings;
+  settings?: ConsumerUpdateResponse.Settings;
 }
 
-export namespace WorkersConsumerCreated {
+export namespace ConsumerUpdateResponse {
   export interface Settings {
     batch_size?: number;
 
@@ -122,34 +126,37 @@ export namespace WorkersConsumerCreated {
   }
 }
 
-export interface WorkersConsumerUpdated {
-  created_on?: unknown;
+export type ConsumerDeleteResponse = unknown | Array<unknown> | string;
 
-  dead_letter_queue?: string;
+export type ConsumerGetResponse = Array<ConsumerGetResponse.ConsumerGetResponseItem>;
 
-  environment?: unknown;
+export namespace ConsumerGetResponse {
+  export interface ConsumerGetResponseItem {
+    created_on?: unknown;
 
-  queue_name?: unknown;
+    environment?: unknown;
 
-  script_name?: unknown;
+    queue_name?: unknown;
 
-  settings?: WorkersConsumerUpdated.Settings;
-}
+    service?: unknown;
 
-export namespace WorkersConsumerUpdated {
-  export interface Settings {
-    batch_size?: number;
+    settings?: ConsumerGetResponseItem.Settings;
+  }
 
-    max_retries?: number;
+  export namespace ConsumerGetResponseItem {
+    export interface Settings {
+      /**
+       * The maximum number of messages to include in a batch
+       */
+      batch_size?: number;
 
-    max_wait_time_ms?: number;
+      max_retries?: number;
+
+      max_wait_time_ms?: number;
+    }
   }
 }
 
-export type ConsumerDeleteResponse = unknown | Array<unknown> | string;
-
-export type ConsumerGetResponse = Array<WorkersConsumer>;
-
 export interface ConsumerCreateParams {
   /**
    * Path param: Identifier
@@ -189,9 +196,8 @@ export interface ConsumerGetParams {
 }
 
 export namespace Consumers {
-  export import WorkersConsumer = ConsumersAPI.WorkersConsumer;
-  export import WorkersConsumerCreated = ConsumersAPI.WorkersConsumerCreated;
-  export import WorkersConsumerUpdated = ConsumersAPI.WorkersConsumerUpdated;
+  export import ConsumerCreateResponse = ConsumersAPI.ConsumerCreateResponse;
+  export import ConsumerUpdateResponse = ConsumersAPI.ConsumerUpdateResponse;
   export import ConsumerDeleteResponse = ConsumersAPI.ConsumerDeleteResponse;
   export import ConsumerGetResponse = ConsumersAPI.ConsumerGetResponse;
   export import ConsumerCreateParams = ConsumersAPI.ConsumerCreateParams;

package/src/resources/queues/index.ts

@@ -1,9 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
-  WorkersConsumer,
-  WorkersConsumerCreated,
-  WorkersConsumerUpdated,
+  ConsumerCreateResponse,
+  ConsumerUpdateResponse,
   ConsumerDeleteResponse,
   ConsumerGetResponse,
   ConsumerCreateParams,
@@ -12,12 +11,25 @@ export {
   ConsumerGetParams,
   Consumers,
 } from './consumers';
+export {
+  WorkersConsumer,
+  WorkersConsumerCreated,
+  WorkersConsumerUpdated,
+  MessageAckResponse,
+  MessagePullResponse,
+  MessageAckParams,
+  MessagePullParams,
+  Messages,
+} from './messages';
 export {
   WorkersQueue,
   WorkersQueueCreated,
   WorkersQueueUpdated,
+  QueueCreateResponse,
+  QueueUpdateResponse,
   QueueListResponse,
   QueueDeleteResponse,
+  QueueGetResponse,
   QueueCreateParams,
   QueueUpdateParams,
   QueueListParams,

package/src/resources/queues/messages.ts

@@ -0,0 +1,210 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import * as MessagesAPI from "./messages";
+
+export class Messages extends APIResource {
+  /**
+   * Acknowledge + Retry messages from a Queue.
+   */
+  ack(
+    queueId: string,
+    params: MessageAckParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MessageAckResponse | null> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(`/accounts/${account_id}/queues/${queueId}/messages/ack`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: MessageAckResponse | null }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Pull a batch of messages from a Queue.
+   */
+  pull(
+    queueId: string,
+    params: MessagePullParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MessagePullResponse | null> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(`/accounts/${account_id}/queues/${queueId}/messages/pull`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: MessagePullResponse | null }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export interface WorkersConsumer {
+  created_on?: unknown;
+
+  environment?: unknown;
+
+  queue_name?: unknown;
+
+  service?: unknown;
+
+  settings?: WorkersConsumer.Settings;
+}
+
+export namespace WorkersConsumer {
+  export interface Settings {
+    batch_size?: number;
+
+    max_retries?: number;
+
+    max_wait_time_ms?: number;
+  }
+}
+
+export interface WorkersConsumerCreated {
+  created_on?: unknown;
+
+  dead_letter_queue?: string;
+
+  environment?: unknown;
+
+  queue_name?: unknown;
+
+  script_name?: unknown;
+
+  settings?: WorkersConsumerCreated.Settings;
+}
+
+export namespace WorkersConsumerCreated {
+  export interface Settings {
+    batch_size?: number;
+
+    max_retries?: number;
+
+    max_wait_time_ms?: number;
+  }
+}
+
+export interface WorkersConsumerUpdated {
+  created_on?: unknown;
+
+  dead_letter_queue?: string;
+
+  environment?: unknown;
+
+  queue_name?: unknown;
+
+  script_name?: unknown;
+
+  settings?: WorkersConsumerUpdated.Settings;
+}
+
+export namespace WorkersConsumerUpdated {
+  export interface Settings {
+    batch_size?: number;
+
+    max_retries?: number;
+
+    max_wait_time_ms?: number;
+  }
+}
+
+export interface MessageAckResponse {
+  /**
+   * The number of messages that were succesfully acknowledged
+   */
+  ackCount?: number;
+
+  /**
+   * The number of messages that were succesfully retried
+   */
+  retryCount?: number;
+
+  warnings?: Array<string>;
+}
+
+export type MessagePullResponse = Array<MessagePullResponse.MessagePullResponseItem>;
+
+export namespace MessagePullResponse {
+  export interface MessagePullResponseItem {
+    id?: string;
+
+    attempts?: number;
+
+    body?: string;
+
+    lease_id?: string;
+
+    metadata?: unknown;
+
+    timestamp_ms?: number;
+  }
+}
+
+export interface MessageAckParams {
+  /**
+   * Path param: Identifier
+   */
+  account_id: string;
+
+  /**
+   * Body param:
+   */
+  acks?: Array<MessageAckParams.Ack>;
+
+  /**
+   * Body param:
+   */
+  retries?: Array<MessageAckParams.Retry>;
+}
+
+export namespace MessageAckParams {
+  export interface Ack {
+    /**
+     * Lease ID for a message to acknowledge.
+     */
+    lease_id?: string;
+  }
+
+  export interface Retry {
+    /**
+     * The number of seconds to delay before making the message available for another
+     * attempt.
+     */
+    delay_seconds?: number;
+
+    /**
+     * Lease ID for a message to retry.
+     */
+    lease_id?: string;
+  }
+}
+
+export interface MessagePullParams {
+  /**
+   * Path param: Identifier
+   */
+  account_id: string;
+
+  /**
+   * Body param: The maximum number of messages to include in a batch
+   */
+  batch_size?: number;
+
+  /**
+   * Body param: The number of milliseconds that a message is exclusively leased.
+   * After the timeout, the message becomes available for another attempt.
+   */
+  visibility_timeout_ms?: number;
+}
+
+export namespace Messages {
+  export import WorkersConsumer = MessagesAPI.WorkersConsumer;
+  export import WorkersConsumerCreated = MessagesAPI.WorkersConsumerCreated;
+  export import WorkersConsumerUpdated = MessagesAPI.WorkersConsumerUpdated;
+  export import MessageAckResponse = MessagesAPI.MessageAckResponse;
+  export import MessagePullResponse = MessagesAPI.MessagePullResponse;
+  export import MessageAckParams = MessagesAPI.MessageAckParams;
+  export import MessagePullParams = MessagesAPI.MessagePullParams;
+}

package/src/resources/queues/queues.ts

@@ -4,9 +4,11 @@ import * as Core from "../../core";
 import { APIResource } from "../../resource";
 import * as QueuesAPI from "./queues";
 import * as ConsumersAPI from "./consumers";
+import * as MessagesAPI from "./messages";
 
 export class Queues extends APIResource {
   consumers: ConsumersAPI.Consumers = new ConsumersAPI.Consumers(this._client);
+  messages: MessagesAPI.Messages = new MessagesAPI.Messages(this._client);
 
   /**
    * Creates a new queue.
@@ -14,13 +16,12 @@ export class Queues extends APIResource {
   create(
     params: QueueCreateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<WorkersQueueCreated | null> {
+  ): Core.APIPromise<QueueCreateResponse | null> {
     const { account_id, body } = params;
     return (
-      this._client.post(`/accounts/${account_id}/workers/queues`, {
-        body: body,
-        ...options,
-      }) as Core.APIPromise<{ result: WorkersQueueCreated | null }>
+      this._client.post(`/accounts/${account_id}/queues`, { body: body, ...options }) as Core.APIPromise<{
+        result: QueueCreateResponse | null;
+      }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -28,16 +29,16 @@ export class Queues extends APIResource {
    * Updates a queue.
    */
   update(
-    name: string,
+    queueId: string,
     params: QueueUpdateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<WorkersQueueUpdated | null> {
+  ): Core.APIPromise<QueueUpdateResponse | null> {
     const { account_id, body } = params;
     return (
-      this._client.put(`/accounts/${account_id}/workers/queues/${name}`, {
+      this._client.put(`/accounts/${account_id}/queues/${queueId}`, {
         body: body,
         ...options,
-      }) as Core.APIPromise<{ result: WorkersQueueUpdated | null }>
+      }) as Core.APIPromise<{ result: QueueUpdateResponse | null }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -47,7 +48,7 @@ export class Queues extends APIResource {
   list(params: QueueListParams, options?: Core.RequestOptions): Core.APIPromise<QueueListResponse | null> {
     const { account_id } = params;
     return (
-      this._client.get(`/accounts/${account_id}/workers/queues`, options) as Core.APIPromise<{
+      this._client.get(`/accounts/${account_id}/queues`, options) as Core.APIPromise<{
         result: QueueListResponse | null;
       }>
     )._thenUnwrap((obj) => obj.result);
@@ -57,13 +58,13 @@ export class Queues extends APIResource {
    * Deletes a queue.
    */
   delete(
-    name: string,
+    queueId: string,
     params: QueueDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<QueueDeleteResponse | null> {
     const { account_id } = params;
     return (
-      this._client.delete(`/accounts/${account_id}/workers/queues/${name}`, options) as Core.APIPromise<{
+      this._client.delete(`/accounts/${account_id}/queues/${queueId}`, options) as Core.APIPromise<{
         result: QueueDeleteResponse | null;
       }>
     )._thenUnwrap((obj) => obj.result);
@@ -73,14 +74,14 @@ export class Queues extends APIResource {
    * Get information about a specific queue.
    */
   get(
-    name: string,
+    queueId: string,
     params: QueueGetParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<WorkersQueue | null> {
+  ): Core.APIPromise<QueueGetResponse | null> {
     const { account_id } = params;
     return (
-      this._client.get(`/accounts/${account_id}/workers/queues/${name}`, options) as Core.APIPromise<{
-        result: WorkersQueue | null;
+      this._client.get(`/accounts/${account_id}/queues/${queueId}`, options) as Core.APIPromise<{
+        result: QueueGetResponse | null;
       }>
     )._thenUnwrap((obj) => obj.result);
   }
@@ -124,10 +125,68 @@ export interface WorkersQueueUpdated {
   queue_name?: string;
 }
 
-export type QueueListResponse = Array<WorkersQueue>;
+export interface QueueCreateResponse {
+  created_on?: unknown;
+
+  modified_on?: unknown;
+
+  queue_id?: unknown;
+
+  queue_name?: string;
+}
+
+export interface QueueUpdateResponse {
+  created_on?: unknown;
+
+  modified_on?: unknown;
+
+  queue_id?: unknown;
+
+  queue_name?: string;
+}
+
+export type QueueListResponse = Array<QueueListResponse.QueueListResponseItem>;
+
+export namespace QueueListResponse {
+  export interface QueueListResponseItem {
+    consumers?: unknown;
+
+    consumers_total_count?: unknown;
+
+    created_on?: unknown;
+
+    modified_on?: unknown;
+
+    producers?: unknown;
+
+    producers_total_count?: unknown;
+
+    queue_id?: string;
+
+    queue_name?: string;
+  }
+}
 
 export type QueueDeleteResponse = unknown | Array<unknown> | string;
 
+export interface QueueGetResponse {
+  consumers?: unknown;
+
+  consumers_total_count?: unknown;
+
+  created_on?: unknown;
+
+  modified_on?: unknown;
+
+  producers?: unknown;
+
+  producers_total_count?: unknown;
+
+  queue_id?: string;
+
+  queue_name?: string;
+}
+
 export interface QueueCreateParams {
   /**
    * Path param: Identifier
@@ -177,21 +236,31 @@ export namespace Queues {
   export import WorkersQueue = QueuesAPI.WorkersQueue;
   export import WorkersQueueCreated = QueuesAPI.WorkersQueueCreated;
   export import WorkersQueueUpdated = QueuesAPI.WorkersQueueUpdated;
+  export import QueueCreateResponse = QueuesAPI.QueueCreateResponse;
+  export import QueueUpdateResponse = QueuesAPI.QueueUpdateResponse;
   export import QueueListResponse = QueuesAPI.QueueListResponse;
   export import QueueDeleteResponse = QueuesAPI.QueueDeleteResponse;
+  export import QueueGetResponse = QueuesAPI.QueueGetResponse;
   export import QueueCreateParams = QueuesAPI.QueueCreateParams;
   export import QueueUpdateParams = QueuesAPI.QueueUpdateParams;
   export import QueueListParams = QueuesAPI.QueueListParams;
   export import QueueDeleteParams = QueuesAPI.QueueDeleteParams;
   export import QueueGetParams = QueuesAPI.QueueGetParams;
   export import Consumers = ConsumersAPI.Consumers;
-  export import WorkersConsumer = ConsumersAPI.WorkersConsumer;
-  export import WorkersConsumerCreated = ConsumersAPI.WorkersConsumerCreated;
-  export import WorkersConsumerUpdated = ConsumersAPI.WorkersConsumerUpdated;
+  export import ConsumerCreateResponse = ConsumersAPI.ConsumerCreateResponse;
+  export import ConsumerUpdateResponse = ConsumersAPI.ConsumerUpdateResponse;
   export import ConsumerDeleteResponse = ConsumersAPI.ConsumerDeleteResponse;
   export import ConsumerGetResponse = ConsumersAPI.ConsumerGetResponse;
   export import ConsumerCreateParams = ConsumersAPI.ConsumerCreateParams;
   export import ConsumerUpdateParams = ConsumersAPI.ConsumerUpdateParams;
   export import ConsumerDeleteParams = ConsumersAPI.ConsumerDeleteParams;
   export import ConsumerGetParams = ConsumersAPI.ConsumerGetParams;
+  export import Messages = MessagesAPI.Messages;
+  export import WorkersConsumer = MessagesAPI.WorkersConsumer;
+  export import WorkersConsumerCreated = MessagesAPI.WorkersConsumerCreated;
+  export import WorkersConsumerUpdated = MessagesAPI.WorkersConsumerUpdated;
+  export import MessageAckResponse = MessagesAPI.MessageAckResponse;
+  export import MessagePullResponse = MessagesAPI.MessagePullResponse;
+  export import MessageAckParams = MessagesAPI.MessageAckParams;
+  export import MessagePullParams = MessagesAPI.MessagePullParams;
 }