feat: Updated models with new accepted page options

TriPSs · TriPSs · commit 0e25786687fa · 2024-07-29T18:12:25.000+02:00
`waitForMilliseconds`, `waitForSelector` and `waitForFunction` have been added
diff --git a/src/generated/index.ts b/src/generated/index.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
@@ -14,6 +14,10 @@ export type { InternalServerErrorResponse } from './models/InternalServerErrorRe
 export type { PageAuthentication } from './models/PageAuthentication';
 export { PageCookie } from './models/PageCookie';
 export { PageOptions } from './models/PageOptions';
+export type { PageWaitForFunction } from './models/PageWaitForFunction';
+export type { PageWaitForFunctionOptions } from './models/PageWaitForFunctionOptions';
+export type { PageWaitForSelector } from './models/PageWaitForSelector';
+export type { PageWaitForSelectorOptions } from './models/PageWaitForSelectorOptions';
 export type { PayloadTooLargeResponse } from './models/PayloadTooLargeResponse';
 export type { PDFMargin } from './models/PDFMargin';
 export { PdfOptions } from './models/PdfOptions';
diff --git a/src/generated/models/AsyncJob.ts b/src/generated/models/AsyncJob.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/AsyncPdf.ts b/src/generated/models/AsyncPdf.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/AsyncScreenshot.ts b/src/generated/models/AsyncScreenshot.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/BadRequestResponse.ts b/src/generated/models/BadRequestResponse.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/CreatePdf.ts b/src/generated/models/CreatePdf.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/CreateScreenshot.ts b/src/generated/models/CreateScreenshot.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/ForbiddenResponse.ts b/src/generated/models/ForbiddenResponse.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/InternalServerErrorResponse.ts b/src/generated/models/InternalServerErrorResponse.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/PDFMargin.ts b/src/generated/models/PDFMargin.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/PageAuthentication.ts b/src/generated/models/PageAuthentication.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/PageCookie.ts b/src/generated/models/PageCookie.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
@@ -16,7 +16,7 @@ export type PageCookie = {
      */
     domain: string;
     /**
-     * The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie.
+     * The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie. Should include the scheme, e.g. `https://`
      */
     url?: string | null;
     /**
diff --git a/src/generated/models/PageOptions.ts b/src/generated/models/PageOptions.ts
@@ -1,12 +1,14 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
 import type { PageAuthentication } from './PageAuthentication';
 import type { PageCookie } from './PageCookie';
+import type { PageWaitForFunction } from './PageWaitForFunction';
+import type { PageWaitForSelector } from './PageWaitForSelector';
 export type PageOptions = {
     /**
-     * URL to go to.
+     * URL to go to. Should include the scheme, e.g. `https://`
      */
     url?: string | null;
     /**
@@ -30,6 +32,18 @@ export type PageOptions = {
      * - `networkidle2` waits till there are no more than 2 network connections for at least `500` ms.
      */
     waitUntil?: PageOptions.waitUntil;
+    /**
+     * Wait for a certain amount of milliseconds before the request continues.
+     */
+    waitForMilliseconds?: number | null;
+    /**
+     * Wait for the [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors) to appear in page. If the [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors) doesn't appear after the `timeout` milliseconds of waiting, the request will continue.
+     */
+    waitForSelector?: PageWaitForSelector | null;
+    /**
+     * Wait for the `pageFunction` to execute in the page. If the `pageFunction` doesn't execute successfully after the `timeout` milliseconds of waiting, the request will continue.
+     */
+    waitForFunction?: PageWaitForFunction | null;
     /**
      * An object containing additional HTTP headers to be sent with every request. All header values must be strings.
      */
diff --git a/src/generated/models/PageWaitForFunction.ts b/src/generated/models/PageWaitForFunction.ts
@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { PageWaitForFunctionOptions } from './PageWaitForFunctionOptions';
+export type PageWaitForFunction = {
+    /**
+     * Function to be evaluated in browser context until it returns a truthy value.
+     */
+    pageFunction: string;
+    /**
+     * Options for configuring waiting behavior.
+     */
+    options?: PageWaitForFunctionOptions | null;
+};
+
diff --git a/src/generated/models/PageWaitForFunctionOptions.ts b/src/generated/models/PageWaitForFunctionOptions.ts
@@ -0,0 +1,17 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PageWaitForFunctionOptions = {
+    /**
+     * An interval at which the `pageFunction` is executed, defaults to `raf`. If `polling` is a number, then it is treated as an interval in milliseconds at which the function would be executed. If `polling` is a string, then it can be one of the following values:
+     * - `raf` to constantly execute `pageFunction` in `requestAnimationFrame` callback. This is the tightest polling mode which is suitable to observe styling changes.
+     * - `mutation` to execute `pageFunction` on every DOM mutation.
+     */
+    polling?: ('raf' | 'mutation' | number);
+    /**
+     * Maximum time to wait in milliseconds.
+     */
+    timeout?: number;
+};
+
diff --git a/src/generated/models/PageWaitForSelector.ts b/src/generated/models/PageWaitForSelector.ts
@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { PageWaitForSelectorOptions } from './PageWaitForSelectorOptions';
+export type PageWaitForSelector = {
+    /**
+     * The [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors) of an element to wait for.
+     */
+    selector: string;
+    /**
+     * Options for configuring waiting behavior.
+     */
+    options?: PageWaitForSelectorOptions | null;
+};
+
diff --git a/src/generated/models/PageWaitForSelectorOptions.ts b/src/generated/models/PageWaitForSelectorOptions.ts
@@ -0,0 +1,25 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PageWaitForSelectorOptions = {
+    /**
+     * Wait for the selected element to be present in DOM and to be visibleAn element is considered to be visible if all of the following is true:
+     * - the element has [computed styles](https://developer.mozilla.org/en-US/docs/Web/API/Window/getComputedStyle)
+     * - the element has a non-empty [bounding client rect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect)
+     * - the element's [visibility](https://developer.mozilla.org/en-US/docs/Web/CSS/visibility) is not `hidden` or `collapse`
+     */
+    visible?: boolean;
+    /**
+     * Wait for the selected element to not be found in the DOM or to be hidden.An element is considered to be hidden if at least one of the following is true:
+     * - the element has no [computed styles](https://developer.mozilla.org/en-US/docs/Web/API/Window/getComputedStyle)
+     * - the element has an empty [bounding client rect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect)
+     * - the element's [visibility](https://developer.mozilla.org/en-US/docs/Web/CSS/visibility) is `hidden` or `collapse`
+     */
+    hidden?: boolean;
+    /**
+     * Maximum time to wait in milliseconds.
+     */
+    timeout?: number;
+};
+
diff --git a/src/generated/models/PayloadTooLargeResponse.ts b/src/generated/models/PayloadTooLargeResponse.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/PdfOptions.ts b/src/generated/models/PdfOptions.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
@@ -75,7 +75,7 @@ export type PdfOptions = {
     omitBackground?: boolean;
     /**
      * Generate document outline.
-     * If this is enabled the PDF will also be tagged (accessible)
+     * If this is enabled the PDF will also be tagged (accessible).
      */
     outline?: boolean;
     /**
diff --git a/src/generated/models/ScreenshotClip.ts b/src/generated/models/ScreenshotClip.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/ScreenshotOptions.ts b/src/generated/models/ScreenshotOptions.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
@@ -41,7 +41,7 @@ export type ScreenshotOptions = {
      */
     clip?: ScreenshotClip | null;
     /**
-     * It captures the DOM element matching the given CSS selector. This will overwrite the `clip` property and set `fullPage` to `false`.
+     * It captures the DOM element matching the given CSS [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors). This will overwrite the `clip` property and set `fullPage` to `false`.
      */
     element?: string | null;
     /**
diff --git a/src/generated/models/ScreenshotOverlay.ts b/src/generated/models/ScreenshotOverlay.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/ScreenshotViewport.ts b/src/generated/models/ScreenshotViewport.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/StorageOptions.ts b/src/generated/models/StorageOptions.ts
@@ -1,10 +1,10 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
 export type StorageOptions = {
     /**
-     * Pre-signed url to upload the generated pdf/screenshot to.
+     * Pre-signed url to upload the generated pdf/screenshot to. Should include the scheme, e.g. `https://`
      */
     preSignedUrl: string;
 };
diff --git a/src/generated/models/SubscriptionLimitReachedResponse.ts b/src/generated/models/SubscriptionLimitReachedResponse.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/SyncJob.ts b/src/generated/models/SyncJob.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
@@ -12,7 +12,7 @@ export type SyncJob = {
      */
     status: SyncJob.status;
     /**
-     * URL to the generated file (will be null if `storage.signedUrl` is used). This url is valid for 1 hour, after that the file will be deleted from our storage.
+     * URL to the generated file (will be `null` if `storage.signedUrl` is used). This url is valid for 1 hour, after that the file will be deleted from our storage.
      */
     fileUrl?: string | null;
     /**
diff --git a/src/generated/models/SyncPdf.ts b/src/generated/models/SyncPdf.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/SyncScreenshot.ts b/src/generated/models/SyncScreenshot.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/TooManyRequestsResponse.ts b/src/generated/models/TooManyRequestsResponse.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/UnauthorizedResponse.ts b/src/generated/models/UnauthorizedResponse.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
diff --git a/src/generated/models/WebhookEvent.ts b/src/generated/models/WebhookEvent.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
@@ -12,7 +12,7 @@ export type WebhookEvent = {
      */
     status: WebhookEvent.status;
     /**
-     * URL to the generated file (will be null if `storage.signedUrl` is used). This url is valid for 1 hour, after that the file will be deleted from our storage.
+     * URL to the generated file (will be `null` if `storage.signedUrl` is used). This url is valid for 1 hour, after that the file will be deleted from our storage.
      */
     fileUrl?: string | null;
     /**
@@ -23,7 +23,7 @@ export type WebhookEvent = {
      */
     signedUrlStatus?: string | null;
     /**
-     * The generated file base64 encoded (will be null if `storage.signedUrl` is used).
+     * The generated file base64 encoded (will be `null` if `storage.signedUrl` is used).
      */
     fileBase64?: string | null;
     /**
diff --git a/src/generated/models/WebhookOptions.ts b/src/generated/models/WebhookOptions.ts
@@ -1,4 +1,4 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
@@ -10,7 +10,7 @@ export type WebhookOptions = {
      */
     receiveType?: WebhookOptions.receiveType;
     /**
-     * The webhook's URL.
+     * The webhook's URL. Should include the scheme, e.g. `https://`
      */
     url: string;
     /**

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/* generated using openapi-typescript-codegen -- do no edit */`
	`1`	`+/* generated using openapi-typescript-codegen -- do not edit */`
`2`	`2`	`/* istanbul ignore file */`
`3`	`3`	`/* tslint:disable */`
`4`	`4`	`/* eslint-disable */`