def iterate_projects(
slug,
limit: nil,
offset: nil,
search: nil,
order: nil,
timeout: nil,
&block
)def iterate_projects: (
String slug,
?limit: Integer?,
?offset: Integer?,
?search: (String | Symbol)?,
?order: ("name" | "asc" | "desc")?,
?timeout: seconds?
) -> Enumerator[project_resource, nil]
| (
String slug,
?limit: Integer?,
?offset: Integer?,
?search: (String | Symbol)?,
?order: ("name" | "asc" | "desc")?,
?timeout: seconds?
) { (project_resource) -> void } -> nilAn Enumerator over the projects in a product, yielding one row at a time and fetching the next page only when the current one runs out. Break out of the loop to stop the walk.
Because the walk moves by offset, projects created or deleted mid-iteration can shift the window and cause a row to repeat or be missed. The scope requirement is the same as the page read: the key needs both products:read and projects:read.
Example
require "envless/sdk"
Envless.products.iterate_projects("billing") do |project|
puts project[:slug]
endParameters
| Parameter | Type | Required | Description |
|---|---|---|---|
slug | String | Yes | Product slug, or the product uniqueId when the value is UUID shaped. |
limit: | Integer | No | Page size for each underlying request, capped at 100. |
offset: | Integer | No | Row to start the walk from. |
search: | String | Symbol | No | Case-insensitive substring match against project name and slug. |
order: | "name" | "asc" | "desc" | No | Defaults to name, which sorts A to Z. Pass asc for oldest first or desc for newest first on createdAt. |
timeout: | Integer | Float | Rational | No | Seconds each attempt of this call may take, redirects and the response body included, before it raises Envless::NetworkError with timeout? set. Overrides the client's timeout for this call, and 0 turns the limit off. |
Returns
An Enumerator[project_resource, nil] that yields each project in the product.
Reads the projects collection. list returns one page as an Envless::Page with items and pagination, list_all collects every page into an array, and iterate yields one item at a time to a block, fetching the next page only when it gets there. Without a block, iterate returns an Enumerator.
Worth knowing
- The first request is not sent until the loop starts, so an unreachable product surfaces on the first iteration and not at call time.
Required scopes
products:read and projects:read
Underlying endpoint
GET /products/{slug}/projects
Request and response schema, every error code, and a live playground.
In TypeScript
envless.products.iterateProjects()
The same method in @goenvless/sdk, with the same request, retries and errors.