@ngrok/ngrok-api 0.17.0 → 0.19.0

package/src/datatypes.ts

@@ -12,6 +12,15 @@ export interface Paging {
   limit?: string;
 }
 
+export interface FilteredPaging {
+  /** Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. */
+  beforeId?: string;
+  /** Constrains the number of results in the dataset. See the [API Overview](https://ngrok.com/docs/api/index#pagination) for details. */
+  limit?: string;
+  /** A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as `id`, `metadata`, `created_at`, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering. */
+  filter?: string;
+}
+
 export interface ItemPaging {
   /** a resource identifier */
   id: string;
@@ -660,7 +669,7 @@ export interface CredentialCreate {
   metadata?: string;
   /** optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the `bind` rule. The `bind` rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule `bind:example.ngrok.io`. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of `bind:*.example.com` which will allow `x.example.com`, `y.example.com`, `*.example.com`, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of `bind:*=example` which will allow `x=example`, `y=example`, etc. A rule of `'*'` is equivalent to no acl at all and will explicitly permit all actions. */
   acl: Array<string>;
-  /** If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot. */
+  /** If supplied at credential creation, ownership will be assigned to the specified User or Service User. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Service User. Accepts one of: User ID, User email, or SCIM User ID. */
   ownerId?: string;
 }
 
@@ -689,7 +698,7 @@ export interface Credential {
   token?: string;
   /** optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the `bind` rule. The `bind` rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule `bind:example.ngrok.io`. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of `bind:*.example.com` which will allow `x.example.com`, `y.example.com`, `*.example.com`, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of `bind:*=example` which will allow `x=example`, `y=example`, etc. A rule of `'*'` is equivalent to no acl at all and will explicitly permit all actions. */
   acl: Array<string>;
-  /** If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot. */
+  /** If supplied at credential creation, ownership will be assigned to the specified User or Service User. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Service User. Accepts one of: User ID, User email, or SCIM User ID. */
   ownerId?: string;
 }
 
@@ -1451,7 +1460,7 @@ export interface Endpoint {
   createdAt?: Date;
   /** timestamp when the endpoint was updated in RFC 3339 format */
   updatedAt?: Date;
-  /** URL of the hostport served by this endpoint */
+  /** deprecated [replaced by URL]: URL of the hostport served by this endpoint */
   publicUrl: string;
   /** protocol served by this endpoint. one of `http`, `https`, `tcp`, or `tls` */
   proto: string;
@@ -1518,14 +1527,20 @@ export interface EndpointCreate {
   metadata?: string;
   /** the bindings associated with this endpoint */
   bindings?: Array<string>;
-  poolingEnabled: boolean;
+  poolingEnabled?: boolean;
 }
 
 export interface EndpointListArgs {
+  /** Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID. */
   beforeId?: string;
+  /** Constrains the number of results in the dataset. See the [API Overview](https://ngrok.com/docs/api/index#pagination) for details. */
   limit?: string;
+  /** Filter results by endpoint IDs. Deprecated: use `filter` instead. */
   id?: Array<string>;
+  /** Filter results by endpoint URLs. Deprecated: use `filter` instead. */
   url?: Array<string>;
+  /** A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as `id`, `metadata`, `created_at`, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering. */
+  filter?: string;
 }
 
 export interface EndpointUpdate {
@@ -1541,7 +1556,7 @@ export interface EndpointUpdate {
   metadata?: string;
   /** the bindings associated with this endpoint */
   bindings?: Array<string>;
-  poolingEnabled: boolean;
+  poolingEnabled?: boolean;
 }
 
 export interface EventDestinationCreate {
@@ -1966,6 +1981,8 @@ export interface ReservedDomainCreate {
   certificateId?: string;
   /** configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with `certificate_id`. */
   certificateManagementPolicy?: ReservedDomainCertPolicy;
+  /** DNS resolver targets configured for the reserved domain, or empty for "global" resolution. */
+  resolvesTo?: Array<ReservedDomainResolvesToEntry>;
 }
 
 export interface ReservedDomainUpdate {
@@ -1978,6 +1995,8 @@ export interface ReservedDomainUpdate {
   certificateId?: string;
   /** configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with `certificate_id`. */
   certificateManagementPolicy?: ReservedDomainCertPolicy;
+  /** DNS resolver targets configured for the reserved domain, or empty for "global" resolution. */
+  resolvesTo?: Array<ReservedDomainResolvesToEntry>;
 }
 
 export interface ReservedDomain {
@@ -2005,6 +2024,8 @@ export interface ReservedDomain {
   certificateManagementStatus?: ReservedDomainCertStatus;
   /** DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains. */
   acmeChallengeCnameTarget?: string;
+  /** DNS resolver targets configured for the reserved domain, or empty for "global" resolution. */
+  resolvesTo?: Array<ReservedDomainResolvesToEntry>;
 }
 
 export interface ReservedDomainList {
@@ -2041,6 +2062,11 @@ export interface ReservedDomainCertJob {
   retriesAt?: Date;
 }
 
+export interface ReservedDomainResolvesToEntry {
+  /** accepts an ngrok point-of-presence shortcode, or "global" */
+  value: string;
+}
+
 export interface SecretCreate {
   /** Name of secret */
   name: string;
@@ -2052,6 +2078,8 @@ export interface SecretCreate {
   description?: string;
   /** unique identifier of the referenced vault */
   vaultId: string;
+  /** name of the referenced vault */
+  vaultName?: string;
 }
 
 export interface SecretUpdate {
@@ -2088,6 +2116,8 @@ export interface Secret {
   lastUpdatedBy: Ref;
   /** Reference to the vault the secret is stored in */
   vault: Ref;
+  /** Name of the vault the secret is stored in */
+  vaultName?: string;
 }
 
 export interface SecretList {
@@ -2098,6 +2128,43 @@ export interface SecretList {
   nextPageUri?: string;
 }
 
+export interface ServiceUser {
+  /** unique API key resource identifier */
+  id: string;
+  /** URI to the API resource of this service user */
+  uri: string;
+  /** human-readable name used to identify the service */
+  name: string;
+  /** whether or not the service is active */
+  active: boolean;
+  /** timestamp when the api key was created, RFC 3339 format */
+  createdAt: Date;
+}
+
+export interface ServiceUserCreate {
+  /** human-readable name used to identify the service */
+  name: string;
+  /** whether or not the service is active */
+  active?: boolean;
+}
+
+export interface ServiceUserUpdate {
+  id: string;
+  /** human-readable name used to identify the service */
+  name?: string;
+  /** whether or not the service is active */
+  active?: boolean;
+}
+
+export interface ServiceUserList {
+  /** the list of all service users on this account */
+  serviceUsers: Array<ServiceUser>;
+  /** URI of the service users list API resource */
+  uri: string;
+  /** URI of the next page, or null if there is no next page */
+  nextPageUri?: string;
+}
+
 export interface SSHCertificateAuthorityCreate {
   /** human-readable description of this SSH Certificate Authority. optional, max 255 bytes. */
   description?: string;

package/src/services.ts

@@ -94,7 +94,7 @@ export class AgentIngresses {
   }
 
   private _pagedList(
-    arg: datatypes.Paging
+    arg: datatypes.FilteredPaging
   ): Promise<datatypes.AgentIngressList> {
     return this.httpClient
       .url(`/agent_ingresses`)
@@ -106,7 +106,7 @@ export class AgentIngresses {
 
   private async *_asyncList(beforeId: string, limit = '100') {
     let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
+    let page: datatypes.FilteredPaging = { limit: limit };
 
     if (beforeId) {
       page.beforeId = beforeId;
@@ -201,7 +201,9 @@ export class APIKeys {
     return array;
   }
 
-  private _pagedList(arg: datatypes.Paging): Promise<datatypes.APIKeyList> {
+  private _pagedList(
+    arg: datatypes.FilteredPaging
+  ): Promise<datatypes.APIKeyList> {
     return this.httpClient
       .url(`/api_keys`)
       .query(arg)
@@ -212,7 +214,7 @@ export class APIKeys {
 
   private async *_asyncList(beforeId: string, limit = '100') {
     let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
+    let page: datatypes.FilteredPaging = { limit: limit };
 
     if (beforeId) {
       page.beforeId = beforeId;
@@ -433,7 +435,7 @@ export class TunnelSessions {
   }
 
   private _pagedList(
-    arg: datatypes.Paging
+    arg: datatypes.FilteredPaging
   ): Promise<datatypes.TunnelSessionList> {
     return this.httpClient
       .url(`/tunnel_sessions`)
@@ -445,7 +447,7 @@ export class TunnelSessions {
 
   private async *_asyncList(beforeId: string, limit = '100') {
     let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
+    let page: datatypes.FilteredPaging = { limit: limit };
 
     if (beforeId) {
       page.beforeId = beforeId;
@@ -1164,7 +1166,7 @@ export class CertificateAuthorities {
       .then(f => f, util.onRejected);
   }
   /**
-   * Get detailed information about a certficate authority
+   * Get detailed information about a certificate authority
    */
   public get(id): Promise<datatypes.CertificateAuthority> {
     return this.httpClient
@@ -1188,7 +1190,7 @@ export class CertificateAuthorities {
   }
 
   private _pagedList(
-    arg: datatypes.Paging
+    arg: datatypes.FilteredPaging
   ): Promise<datatypes.CertificateAuthorityList> {
     return this.httpClient
       .url(`/certificate_authorities`)
@@ -1200,7 +1202,7 @@ export class CertificateAuthorities {
 
   private async *_asyncList(beforeId: string, limit = '100') {
     let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
+    let page: datatypes.FilteredPaging = { limit: limit };
 
     if (beforeId) {
       page.beforeId = beforeId;
@@ -1297,7 +1299,9 @@ export class Credentials {
     return array;
   }
 
-  private _pagedList(arg: datatypes.Paging): Promise<datatypes.CredentialList> {
+  private _pagedList(
+    arg: datatypes.FilteredPaging
+  ): Promise<datatypes.CredentialList> {
     return this.httpClient
       .url(`/credentials`)
       .query(arg)
@@ -1308,7 +1312,7 @@ export class Credentials {
 
   private async *_asyncList(beforeId: string, limit = '100') {
     let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
+    let page: datatypes.FilteredPaging = { limit: limit };
 
     if (beforeId) {
       page.beforeId = beforeId;
@@ -2607,7 +2611,7 @@ export class EventDestinations {
   }
 
   private _pagedList(
-    arg: datatypes.Paging
+    arg: datatypes.FilteredPaging
   ): Promise<datatypes.EventDestinationList> {
     return this.httpClient
       .url(`/event_destinations`)
@@ -2619,7 +2623,7 @@ export class EventDestinations {
 
   private async *_asyncList(beforeId: string, limit = '100') {
     let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
+    let page: datatypes.FilteredPaging = { limit: limit };
 
     if (beforeId) {
       page.beforeId = beforeId;
@@ -2710,7 +2714,7 @@ export class EventSubscriptions {
   }
 
   private _pagedList(
-    arg: datatypes.Paging
+    arg: datatypes.FilteredPaging
   ): Promise<datatypes.EventSubscriptionList> {
     return this.httpClient
       .url(`/event_subscriptions`)
@@ -2722,7 +2726,7 @@ export class EventSubscriptions {
 
   private async *_asyncList(beforeId: string, limit = '100') {
     let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
+    let page: datatypes.FilteredPaging = { limit: limit };
 
     if (beforeId) {
       page.beforeId = beforeId;
@@ -2881,7 +2885,9 @@ export class IPPolicies {
     return array;
   }
 
-  private _pagedList(arg: datatypes.Paging): Promise<datatypes.IPPolicyList> {
+  private _pagedList(
+    arg: datatypes.FilteredPaging
+  ): Promise<datatypes.IPPolicyList> {
     return this.httpClient
       .url(`/ip_policies`)
       .query(arg)
@@ -2892,7 +2898,7 @@ export class IPPolicies {
 
   private async *_asyncList(beforeId: string, limit = '100') {
     let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
+    let page: datatypes.FilteredPaging = { limit: limit };
 
     if (beforeId) {
       page.beforeId = beforeId;
@@ -2985,7 +2991,7 @@ export class IPPolicyRules {
   }
 
   private _pagedList(
-    arg: datatypes.Paging
+    arg: datatypes.FilteredPaging
   ): Promise<datatypes.IPPolicyRuleList> {
     return this.httpClient
       .url(`/ip_policy_rules`)
@@ -2997,7 +3003,7 @@ export class IPPolicyRules {
 
   private async *_asyncList(beforeId: string, limit = '100') {
     let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
+    let page: datatypes.FilteredPaging = { limit: limit };
 
     if (beforeId) {
       page.beforeId = beforeId;
@@ -3096,7 +3102,7 @@ export class IPRestrictions {
   }
 
   private _pagedList(
-    arg: datatypes.Paging
+    arg: datatypes.FilteredPaging
   ): Promise<datatypes.IPRestrictionList> {
     return this.httpClient
       .url(`/ip_restrictions`)
@@ -3108,7 +3114,7 @@ export class IPRestrictions {
 
   private async *_asyncList(beforeId: string, limit = '100') {
     let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
+    let page: datatypes.FilteredPaging = { limit: limit };
 
     if (beforeId) {
       page.beforeId = beforeId;
@@ -3204,7 +3210,7 @@ export class ReservedAddrs {
   }
 
   private _pagedList(
-    arg: datatypes.Paging
+    arg: datatypes.FilteredPaging
   ): Promise<datatypes.ReservedAddrList> {
     return this.httpClient
       .url(`/reserved_addrs`)
@@ -3216,7 +3222,7 @@ export class ReservedAddrs {
 
   private async *_asyncList(beforeId: string, limit = '100') {
     let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
+    let page: datatypes.FilteredPaging = { limit: limit };
 
     if (beforeId) {
       page.beforeId = beforeId;
@@ -3313,7 +3319,7 @@ export class ReservedDomains {
   }
 
   private _pagedList(
-    arg: datatypes.Paging
+    arg: datatypes.FilteredPaging
   ): Promise<datatypes.ReservedDomainList> {
     return this.httpClient
       .url(`/reserved_domains`)
@@ -3325,7 +3331,7 @@ export class ReservedDomains {
 
   private async *_asyncList(beforeId: string, limit = '100') {
     let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
+    let page: datatypes.FilteredPaging = { limit: limit };
 
     if (beforeId) {
       page.beforeId = beforeId;
@@ -3446,7 +3452,9 @@ export class Secrets {
     return array;
   }
 
-  private _pagedList(arg: datatypes.Paging): Promise<datatypes.SecretList> {
+  private _pagedList(
+    arg: datatypes.FilteredPaging
+  ): Promise<datatypes.SecretList> {
     return this.httpClient
       .url(`/vault_secrets`)
       .query(arg)
@@ -3457,7 +3465,7 @@ export class Secrets {
 
   private async *_asyncList(beforeId: string, limit = '100') {
     let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
+    let page: datatypes.FilteredPaging = { limit: limit };
 
     if (beforeId) {
       page.beforeId = beforeId;
@@ -3482,6 +3490,109 @@ export class Secrets {
   }
 }
 
+export class ServiceUsers {
+  private httpClient: Wretcher;
+
+  /** Do not construct this object directly, use the <code>serviceUsers</code> property of an <code>Ngrok</code> client object instead. */
+  public constructor(httpClient: Wretcher) {
+    this.httpClient = httpClient;
+  }
+  /**
+   * Create a new service user
+   */
+  public create(
+    arg: datatypes.ServiceUserCreate
+  ): Promise<datatypes.ServiceUser> {
+    return this.httpClient
+      .url(`/service_users`)
+      .post(util.serializeArgument(arg))
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+  /**
+   * Delete a service user by ID
+   */
+  public delete(id): Promise<void> {
+    return this.httpClient
+      .url(`/service_users/${id}`)
+      .delete()
+      .res()
+      .then(f => f, util.onRejected);
+  }
+  /**
+   * Get the details of a Bot User by ID.
+   */
+  public get(id): Promise<datatypes.ServiceUser> {
+    return this.httpClient
+      .url(`/service_users/${id}`)
+      .get()
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+  /**
+   * List all service users in this account.
+   */
+  public async list(
+    beforeId?: string,
+    limit?: string
+  ): Promise<Array<datatypes.ServiceUser>> {
+    const array: Array<datatypes.ServiceUser> = [];
+    for await (const item of this._asyncList(beforeId, limit)) {
+      array.push(item);
+    }
+    return array;
+  }
+
+  private _pagedList(
+    arg: datatypes.FilteredPaging
+  ): Promise<datatypes.ServiceUserList> {
+    return this.httpClient
+      .url(`/service_users`)
+      .query(arg)
+      .get()
+      .json(payload => util.deserializeResult(payload))
+      .then(util.onFulfilled, util.onRejected);
+  }
+
+  private async *_asyncList(beforeId: string, limit = '100') {
+    let nextPage = 'initial loop';
+    let page: datatypes.FilteredPaging = { limit: limit };
+
+    if (beforeId) {
+      page.beforeId = beforeId;
+    }
+
+    while (nextPage) {
+      const pagedList = await this._pagedList(page);
+      nextPage = pagedList.nextPageUri;
+      const items: datatypes.ServiceUser[] = pagedList.serviceUsers;
+
+      if (nextPage) {
+        page = {
+          beforeId: items[items.length - 1].id,
+          limit: limit,
+        };
+      }
+
+      for (const item of items) {
+        yield item;
+      }
+    }
+  }
+  /**
+   * Update attributes of a service user by ID.
+   */
+  public update(
+    arg: datatypes.ServiceUserUpdate
+  ): Promise<datatypes.ServiceUser> {
+    return this.httpClient
+      .url(`/service_users/${arg.id}`)
+      .patch(util.serializeArgument(arg))
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+}
+
 /**
  * An SSH Certificate Authority is a pair of an SSH Certificate and its private
  key that can be used to sign other SSH host and user certificates.
@@ -3516,7 +3627,7 @@ export class SSHCertificateAuthorities {
       .then(f => f, util.onRejected);
   }
   /**
-   * Get detailed information about an SSH Certficate Authority
+   * Get detailed information about an SSH Certificate Authority
    */
   public get(id): Promise<datatypes.SSHCertificateAuthority> {
     return this.httpClient
@@ -3540,7 +3651,7 @@ export class SSHCertificateAuthorities {
   }
 
   private _pagedList(
-    arg: datatypes.Paging
+    arg: datatypes.FilteredPaging
   ): Promise<datatypes.SSHCertificateAuthorityList> {
     return this.httpClient
       .url(`/ssh_certificate_authorities`)
@@ -3552,7 +3663,7 @@ export class SSHCertificateAuthorities {
 
   private async *_asyncList(beforeId: string, limit = '100') {
     let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
+    let page: datatypes.FilteredPaging = { limit: limit };
 
     if (beforeId) {
       page.beforeId = beforeId;
@@ -3648,7 +3759,7 @@ export class SSHCredentials {
   }
 
   private _pagedList(
-    arg: datatypes.Paging
+    arg: datatypes.FilteredPaging
   ): Promise<datatypes.SSHCredentialList> {
     return this.httpClient
       .url(`/ssh_credentials`)
@@ -3660,7 +3771,7 @@ export class SSHCredentials {
 
   private async *_asyncList(beforeId: string, limit = '100') {
     let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
+    let page: datatypes.FilteredPaging = { limit: limit };
 
     if (beforeId) {
       page.beforeId = beforeId;
@@ -3732,7 +3843,7 @@ export class SSHHostCertificates {
       .then(f => f, util.onRejected);
   }
   /**
-   * Get detailed information about an SSH Host Certficate
+   * Get detailed information about an SSH Host Certificate
    */
   public get(id): Promise<datatypes.SSHHostCertificate> {
     return this.httpClient
@@ -3841,7 +3952,7 @@ export class SSHUserCertificates {
       .then(f => f, util.onRejected);
   }
   /**
-   * Get detailed information about an SSH User Certficate
+   * Get detailed information about an SSH User Certificate
    */
   public get(id): Promise<datatypes.SSHUserCertificate> {
     return this.httpClient
@@ -3976,7 +4087,7 @@ export class TLSCertificates {
   }
 
   private _pagedList(
-    arg: datatypes.Paging
+    arg: datatypes.FilteredPaging
   ): Promise<datatypes.TLSCertificateList> {
     return this.httpClient
       .url(`/tls_certificates`)
@@ -3988,7 +4099,7 @@ export class TLSCertificates {
 
   private async *_asyncList(beforeId: string, limit = '100') {
     let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
+    let page: datatypes.FilteredPaging = { limit: limit };
 
     if (beforeId) {
       page.beforeId = beforeId;
@@ -4221,7 +4332,9 @@ export class Vaults {
     return array;
   }
 
-  private _pagedList(arg: datatypes.Paging): Promise<datatypes.VaultList> {
+  private _pagedList(
+    arg: datatypes.FilteredPaging
+  ): Promise<datatypes.VaultList> {
     return this.httpClient
       .url(`/vaults`)
       .query(arg)
@@ -4232,7 +4345,7 @@ export class Vaults {
 
   private async *_asyncList(beforeId: string, limit = '100') {
     let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
+    let page: datatypes.FilteredPaging = { limit: limit };
 
     if (beforeId) {
       page.beforeId = beforeId;