@revenexx/node 0.0.1 → 0.1.0

package/dist/services/sites.d.mts

@@ -0,0 +1,915 @@
+import { Client, UploadProgress } from '../client.mjs';
+import { Models } from '../models.mjs';
+import { BuildRuntime } from '../enums/build-runtime.mjs';
+import { Framework } from '../enums/framework.mjs';
+import { Adapter } from '../enums/adapter.mjs';
+import { SitesCreateTemplateDeploymentType } from '../enums/sites-create-template-deployment-type.mjs';
+import { AppsGetDeploymentDownloadType } from '../enums/apps-get-deployment-download-type.mjs';
+import '../query.mjs';
+import '../enums/address-type-row-tone.mjs';
+import '../enums/address-type-row-create-request-tone.mjs';
+import '../enums/address-type-row-update-request-tone.mjs';
+import '../enums/assets-source.mjs';
+import '../enums/attribute-value-bucket.mjs';
+import '../enums/auth-mail-source.mjs';
+import '../enums/recovery-mail-source.mjs';
+import '../enums/registration-status.mjs';
+import '../enums/budget-change-reason.mjs';
+import '../enums/budget-movement-result-status.mjs';
+import '../enums/cart-status.mjs';
+import '../enums/cart-merge-strategy.mjs';
+import '../enums/cart-price-snapshot-mode.mjs';
+import '../enums/cart-io-format.mjs';
+import '../enums/cart-export-format.mjs';
+import '../enums/cart-item-type.mjs';
+import '../enums/cart-vocabulary-tone.mjs';
+import '../enums/cart-vocabulary-name.mjs';
+import '../enums/cart-vocabulary-source.mjs';
+import '../enums/cart-vocabulary-ref-name.mjs';
+import '../enums/categories-rule-match.mjs';
+import '../enums/category-rule-operator.mjs';
+import '../enums/category-rule-match.mjs';
+import '../enums/channel-status.mjs';
+import '../enums/channel-unassigned-visibility.mjs';
+import '../enums/channel-unresolved-reason.mjs';
+import '../enums/channel-context-source.mjs';
+import '../enums/channel-inactive-behavior.mjs';
+import '../enums/channel-policy-source.mjs';
+import '../enums/channel-policy-tenant-default.mjs';
+import '../enums/channel-unassigned-policy.mjs';
+import '../enums/channel-type-tone.mjs';
+import '../enums/channel-visibility-reason.mjs';
+import '../enums/channel-vocabulary-tone.mjs';
+import '../enums/channel-vocabulary-name.mjs';
+import '../enums/channel-vocabulary-source.mjs';
+import '../enums/channel-vocabulary-ref-name.mjs';
+import '../enums/contact-registration-status.mjs';
+import '../enums/contact-status.mjs';
+import '../enums/contact-activity-kind.mjs';
+import '../enums/contact-create-request-registration-status.mjs';
+import '../enums/contact-event-kind-tone.mjs';
+import '../enums/contact-event-kind-create-request-tone.mjs';
+import '../enums/contact-event-kind-update-request-tone.mjs';
+import '../enums/contact-update-request-registration-status.mjs';
+import '../enums/cost-center-budget-type.mjs';
+import '../enums/cost-center-restriction-type.mjs';
+import '../enums/cost-center-restriction-create-request-type.mjs';
+import '../enums/cost-center-restriction-update-request-type.mjs';
+import '../enums/payment-fee-type.mjs';
+import '../enums/payment-method-kind.mjs';
+import '../enums/form-status.mjs';
+import '../enums/form-submission-status.mjs';
+import '../enums/form-notify-source.mjs';
+import '../enums/form-submission-prune-request-status.mjs';
+import '../enums/forms-vocabulary-tone.mjs';
+import '../enums/forms-vocabulary-name.mjs';
+import '../enums/forms-vocabulary-summary-name.mjs';
+import '../enums/inventory-vocabulary-default-tone.mjs';
+import '../enums/inventory-vocabulary-source.mjs';
+import '../enums/cart-io-apply-mode.mjs';
+import '../enums/cart-io-direction.mjs';
+import '../enums/cart-io-entity.mjs';
+import '../enums/io-profile-resource-apply-mode.mjs';
+import '../enums/io-profile-resource-direction.mjs';
+import '../enums/lifecycle-stage-tone.mjs';
+import '../enums/lifecycle-stage-create-request-tone.mjs';
+import '../enums/lifecycle-stage-update-request-tone.mjs';
+import '../enums/location-type.mjs';
+import '../enums/market-status.mjs';
+import '../enums/market-default-locale-source.mjs';
+import '../enums/market-locale-fallback.mjs';
+import '../enums/market-locale-granularity.mjs';
+import '../enums/market-pricing-source.mjs';
+import '../enums/market-tax-basis.mjs';
+import '../enums/market-readiness-check-id.mjs';
+import '../enums/market-readiness-severity.mjs';
+import '../enums/markets-vocabulary-tone.mjs';
+import '../enums/markets-vocabulary-name.mjs';
+import '../enums/markets-vocabulary-source.mjs';
+import '../enums/markets-vocabulary-summary-name.mjs';
+import '../enums/order-fulfillment-status.mjs';
+import '../enums/order-payment-status.mjs';
+import '../enums/order-status.mjs';
+import '../enums/order-cancellation-scope.mjs';
+import '../enums/order-comment-visibility.mjs';
+import '../enums/order-item-type.mjs';
+import '../enums/order-list-kind-tone.mjs';
+import '../enums/order-list-kind-row-tone.mjs';
+import '../enums/order-list-cart-mode.mjs';
+import '../enums/order-list-vocabulary-default-tone.mjs';
+import '../enums/order-list-vocabulary-name.mjs';
+import '../enums/order-list-vocabulary-source.mjs';
+import '../enums/order-list-vocabulary-tone.mjs';
+import '../enums/order-return-status.mjs';
+import '../enums/order-return-settlement.mjs';
+import '../enums/order-return-refusal.mjs';
+import '../enums/order-vocabulary-tone.mjs';
+import '../enums/order-vocabulary-name.mjs';
+import '../enums/order-vocabulary-source.mjs';
+import '../enums/order-vocabulary-summary-name.mjs';
+import '../enums/order-resolution-stage.mjs';
+import '../enums/organization-status.mjs';
+import '../enums/page-status.mjs';
+import '../enums/pages-vocabulary-app.mjs';
+import '../enums/pages-vocabulary-tone.mjs';
+import '../enums/pages-vocabulary-name.mjs';
+import '../enums/pages-vocabulary-source.mjs';
+import '../enums/pages-vocabulary-index-app.mjs';
+import '../enums/payment-dunning-stage.mjs';
+import '../enums/payment-failure-code.mjs';
+import '../enums/payment-status.mjs';
+import '../enums/payment-term-tone.mjs';
+import '../enums/payment-term-create-request-tone.mjs';
+import '../enums/payment-term-update-request-tone.mjs';
+import '../enums/payment-vocabulary-tone.mjs';
+import '../enums/price-ending-rule.mjs';
+import '../enums/price-entries-adjust-response-rounding.mjs';
+import '../enums/price-entries-adjust-response-rounding-mode.mjs';
+import '../enums/price-entries-bulk-mode.mjs';
+import '../enums/price-rounding-mode.mjs';
+import '../enums/price-entry-type.mjs';
+import '../enums/price-list-status.mjs';
+import '../enums/price-list-tax-basis.mjs';
+import '../enums/price-currency-source.mjs';
+import '../enums/price-list-tiebreak.mjs';
+import '../enums/price-tax-inclusive-default.mjs';
+import '../enums/price-tax-unresolved-reason.mjs';
+import '../enums/price-tax-market-source.mjs';
+import '../enums/price-vocabulary-tone.mjs';
+import '../enums/price-vocabulary-name.mjs';
+import '../enums/price-vocabulary-source.mjs';
+import '../enums/price-vocabulary-ref-name.mjs';
+import '../enums/product-categories-source.mjs';
+import '../enums/product-grid-column-source.mjs';
+import '../enums/product-label-source.mjs';
+import '../enums/product-label-attribute-source.mjs';
+import '../enums/products-kind.mjs';
+import '../enums/reorder-point-source.mjs';
+import '../enums/reservation-status.mjs';
+import '../enums/price-on-request-reason.mjs';
+import '../enums/price-tax-basis.mjs';
+import '../enums/price-tax-basis-source.mjs';
+import '../enums/role-catalog-response-source.mjs';
+import '../enums/segment-rule-match.mjs';
+import '../enums/segment-member-source.mjs';
+import '../enums/segment-rule-operator.mjs';
+import '../enums/segment-rule-preview-request-rule-match.mjs';
+import '../enums/segment-rule-preview-request-target.mjs';
+import '../enums/segment-rule-preview-response-rule-match.mjs';
+import '../enums/segment-rule-preview-response-target.mjs';
+import '../enums/segment-rules-target.mjs';
+import '../enums/shipping-carrier-status.mjs';
+import '../enums/shipping-method-matrix-basis.mjs';
+import '../enums/shipping-method-pricing-type.mjs';
+import '../enums/shipping-carrier-source.mjs';
+import '../enums/shipping-rate-pricing-type.mjs';
+import '../enums/shipping-tax-source.mjs';
+import '../enums/shipping-free-above-basis.mjs';
+import '../enums/shipping-rates-basis-matrix-basis-default.mjs';
+import '../enums/shipping-service-level-create-request-tone.mjs';
+import '../enums/shipping-service-level-row-tone.mjs';
+import '../enums/shipping-service-level-update-request-tone.mjs';
+import '../enums/shipping-tax-unresolved-reason.mjs';
+import '../enums/shipping-tax-market-source.mjs';
+import '../enums/shipping-tax-context-via.mjs';
+import '../enums/shipping-tracking-carrier-status.mjs';
+import '../enums/shipping-vocabulary-default-tone.mjs';
+import '../enums/shipping-vocabulary-source.mjs';
+import '../enums/shipping-vocabulary-tone.mjs';
+import '../enums/shipping-weight-unit-create-request-tone.mjs';
+import '../enums/shipping-weight-unit-row-tone.mjs';
+import '../enums/shipping-weight-unit-update-request-tone.mjs';
+import '../enums/stock-movement-type.mjs';
+import '../enums/store-asset-request-visibility.mjs';
+import '../enums/validation-failed-response-status.mjs';
+import '../enums/vocabulary-default-tone.mjs';
+import '../enums/vocabulary-source.mjs';
+import '../enums/vocabulary-tone.mjs';
+import '../enums/attribute-boolean-status.mjs';
+import '../enums/attribute-datetime-status.mjs';
+import '../enums/attribute-email-status.mjs';
+import '../enums/attribute-enum-status.mjs';
+import '../enums/attribute-float-status.mjs';
+import '../enums/attribute-integer-status.mjs';
+import '../enums/attribute-ip-status.mjs';
+import '../enums/attribute-line-status.mjs';
+import '../enums/attribute-longtext-status.mjs';
+import '../enums/attribute-mediumtext-status.mjs';
+import '../enums/attribute-point-status.mjs';
+import '../enums/attribute-polygon-status.mjs';
+import '../enums/attribute-relationship-status.mjs';
+import '../enums/attribute-string-status.mjs';
+import '../enums/attribute-text-status.mjs';
+import '../enums/attribute-url-status.mjs';
+import '../enums/attribute-varchar-status.mjs';
+import '../enums/column-boolean-status.mjs';
+import '../enums/column-datetime-status.mjs';
+import '../enums/column-email-status.mjs';
+import '../enums/column-enum-status.mjs';
+import '../enums/column-float-status.mjs';
+import '../enums/column-integer-status.mjs';
+import '../enums/column-ip-status.mjs';
+import '../enums/column-line-status.mjs';
+import '../enums/column-longtext-status.mjs';
+import '../enums/column-mediumtext-status.mjs';
+import '../enums/column-point-status.mjs';
+import '../enums/column-polygon-status.mjs';
+import '../enums/column-relationship-status.mjs';
+import '../enums/column-string-status.mjs';
+import '../enums/column-text-status.mjs';
+import '../enums/column-url-status.mjs';
+import '../enums/column-varchar-status.mjs';
+import '../enums/database-type.mjs';
+import '../enums/deployment-status.mjs';
+import '../enums/execution-status.mjs';
+import '../enums/execution-trigger.mjs';
+import '../enums/health-antivirus-status.mjs';
+import '../enums/health-status-status.mjs';
+import '../enums/index-status.mjs';
+import '../enums/message-2-status.mjs';
+
+declare class Sites {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * Get a list of all the project's sites. You can use the query params to filter your results.
+     *
+     * @param {string[]} params.queries - Result filters, paging and ordering. Repeat the parameter once per query — `?queries=…&queries=…` — and make each value a JSON object, e.g. `{"method":"limit","values":[25]}`. The bracketed spellings `queries[]=` and `queries[0]=` are accepted too; the `limit(25)` call syntax is not. See “Query parameters” in this document's introduction. Filterable attributes, besides `$id`, `$createdAt`, `$updatedAt` and `$sequence`: name, enabled, framework, deploymentId, buildCommand, installCommand, outputDirectory, installationId
+     * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.SiteList>}
+     */
+    sitesList(params?: {
+        queries?: string[];
+        search?: string;
+        total?: boolean;
+    }): Promise<Models.SiteList>;
+    /**
+     * Get a list of all the project's sites. You can use the query params to filter your results.
+     *
+     * @param {string[]} queries - Result filters, paging and ordering. Repeat the parameter once per query — `?queries=…&queries=…` — and make each value a JSON object, e.g. `{"method":"limit","values":[25]}`. The bracketed spellings `queries[]=` and `queries[0]=` are accepted too; the `limit(25)` call syntax is not. See “Query parameters” in this document's introduction. Filterable attributes, besides `$id`, `$createdAt`, `$updatedAt` and `$sequence`: name, enabled, framework, deploymentId, buildCommand, installCommand, outputDirectory, installationId
+     * @param {string} search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.SiteList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesList(queries?: string[], search?: string, total?: boolean): Promise<Models.SiteList>;
+    /**
+     * Create a new site.
+     *
+     * @param {BuildRuntime} params.buildRuntime - Runtime to use during build step.
+     * @param {Framework} params.framework - Sites framework.
+     * @param {string} params.name - Site name. Max length: 128 chars.
+     * @param {string} params.siteId - Site ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+     * @param {Adapter} params.adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
+     * @param {string} params.buildCommand - Build Command.
+     * @param {boolean} params.enabled - Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.
+     * @param {string} params.fallbackFile - Fallback file for single page application sites.
+     * @param {string} params.installCommand - Install Command.
+     * @param {string} params.installationId - Installation ID of the platform's VCS (Version Control System) integration to deploy from.
+     * @param {boolean} params.logging - When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
+     * @param {string} params.outputDirectory - Output Directory for site.
+     * @param {string} params.providerBranch - Production branch for the repo linked to the site.
+     * @param {string} params.providerRepositoryId - Repository ID of the repo linked to the site.
+     * @param {string} params.providerRootDirectory - Path to site code in the linked repo.
+     * @param {boolean} params.providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
+     * @param {string} params.specification - Framework specification for the site and builds.
+     * @param {number} params.timeout - Maximum request time in seconds.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Site>}
+     */
+    sitesCreate(params: {
+        buildRuntime: BuildRuntime;
+        framework: Framework;
+        name: string;
+        siteId: string;
+        adapter?: Adapter;
+        buildCommand?: string;
+        enabled?: boolean;
+        fallbackFile?: string;
+        installCommand?: string;
+        installationId?: string;
+        logging?: boolean;
+        outputDirectory?: string;
+        providerBranch?: string;
+        providerRepositoryId?: string;
+        providerRootDirectory?: string;
+        providerSilentMode?: boolean;
+        specification?: string;
+        timeout?: number;
+    }): Promise<Models.Site>;
+    /**
+     * Create a new site.
+     *
+     * @param {BuildRuntime} buildRuntime - Runtime to use during build step.
+     * @param {Framework} framework - Sites framework.
+     * @param {string} name - Site name. Max length: 128 chars.
+     * @param {string} siteId - Site ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+     * @param {Adapter} adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
+     * @param {string} buildCommand - Build Command.
+     * @param {boolean} enabled - Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.
+     * @param {string} fallbackFile - Fallback file for single page application sites.
+     * @param {string} installCommand - Install Command.
+     * @param {string} installationId - Installation ID of the platform's VCS (Version Control System) integration to deploy from.
+     * @param {boolean} logging - When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
+     * @param {string} outputDirectory - Output Directory for site.
+     * @param {string} providerBranch - Production branch for the repo linked to the site.
+     * @param {string} providerRepositoryId - Repository ID of the repo linked to the site.
+     * @param {string} providerRootDirectory - Path to site code in the linked repo.
+     * @param {boolean} providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
+     * @param {string} specification - Framework specification for the site and builds.
+     * @param {number} timeout - Maximum request time in seconds.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Site>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesCreate(buildRuntime: BuildRuntime, framework: Framework, name: string, siteId: string, adapter?: Adapter, buildCommand?: string, enabled?: boolean, fallbackFile?: string, installCommand?: string, installationId?: string, logging?: boolean, outputDirectory?: string, providerBranch?: string, providerRepositoryId?: string, providerRootDirectory?: string, providerSilentMode?: boolean, specification?: string, timeout?: number): Promise<Models.Site>;
+    /**
+     * Get a list of all frameworks that are currently available on the server instance.
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.FrameworkList>}
+     */
+    sitesListFrameworks(): Promise<Models.FrameworkList>;
+    /**
+     * List allowed site specifications for this instance.
+     *
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.SpecificationList>}
+     */
+    sitesListSpecifications(): Promise<Models.SpecificationList>;
+    /**
+     * Delete a site by its unique ID.
+     *
+     * @param {string} params.siteId - Site ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    sitesDelete(params: {
+        siteId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a site by its unique ID.
+     *
+     * @param {string} siteId - Site ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesDelete(siteId: string): Promise<{}>;
+    /**
+     * Get a site by its unique ID.
+     *
+     * @param {string} params.siteId - Site ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Site>}
+     */
+    sitesGet(params: {
+        siteId: string;
+    }): Promise<Models.Site>;
+    /**
+     * Get a site by its unique ID.
+     *
+     * @param {string} siteId - Site ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Site>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesGet(siteId: string): Promise<Models.Site>;
+    /**
+     * Update site by its unique ID.
+     *
+     * @param {string} params.siteId - Site ID.
+     * @param {Framework} params.framework - Sites framework.
+     * @param {string} params.name - Site name. Max length: 128 chars.
+     * @param {Adapter} params.adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
+     * @param {string} params.buildCommand - Build Command.
+     * @param {BuildRuntime} params.buildRuntime - Runtime to use during build step.
+     * @param {boolean} params.enabled - Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.
+     * @param {string} params.fallbackFile - Fallback file for single page application sites.
+     * @param {string} params.installCommand - Install Command.
+     * @param {string} params.installationId - Installation ID of the platform's VCS (Version Control System) integration to deploy from.
+     * @param {boolean} params.logging - When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
+     * @param {string} params.outputDirectory - Output Directory for site.
+     * @param {string} params.providerBranch - Production branch for the repo linked to the site.
+     * @param {string} params.providerRepositoryId - Repository ID of the repo linked to the site.
+     * @param {string} params.providerRootDirectory - Path to site code in the linked repo.
+     * @param {boolean} params.providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
+     * @param {string} params.specification - Framework specification for the site and builds.
+     * @param {number} params.timeout - Maximum request time in seconds.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Site>}
+     */
+    sitesUpdate(params: {
+        siteId: string;
+        framework: Framework;
+        name: string;
+        adapter?: Adapter;
+        buildCommand?: string;
+        buildRuntime?: BuildRuntime;
+        enabled?: boolean;
+        fallbackFile?: string;
+        installCommand?: string;
+        installationId?: string;
+        logging?: boolean;
+        outputDirectory?: string;
+        providerBranch?: string;
+        providerRepositoryId?: string;
+        providerRootDirectory?: string;
+        providerSilentMode?: boolean;
+        specification?: string;
+        timeout?: number;
+    }): Promise<Models.Site>;
+    /**
+     * Update site by its unique ID.
+     *
+     * @param {string} siteId - Site ID.
+     * @param {Framework} framework - Sites framework.
+     * @param {string} name - Site name. Max length: 128 chars.
+     * @param {Adapter} adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
+     * @param {string} buildCommand - Build Command.
+     * @param {BuildRuntime} buildRuntime - Runtime to use during build step.
+     * @param {boolean} enabled - Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.
+     * @param {string} fallbackFile - Fallback file for single page application sites.
+     * @param {string} installCommand - Install Command.
+     * @param {string} installationId - Installation ID of the platform's VCS (Version Control System) integration to deploy from.
+     * @param {boolean} logging - When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
+     * @param {string} outputDirectory - Output Directory for site.
+     * @param {string} providerBranch - Production branch for the repo linked to the site.
+     * @param {string} providerRepositoryId - Repository ID of the repo linked to the site.
+     * @param {string} providerRootDirectory - Path to site code in the linked repo.
+     * @param {boolean} providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
+     * @param {string} specification - Framework specification for the site and builds.
+     * @param {number} timeout - Maximum request time in seconds.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Site>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesUpdate(siteId: string, framework: Framework, name: string, adapter?: Adapter, buildCommand?: string, buildRuntime?: BuildRuntime, enabled?: boolean, fallbackFile?: string, installCommand?: string, installationId?: string, logging?: boolean, outputDirectory?: string, providerBranch?: string, providerRepositoryId?: string, providerRootDirectory?: string, providerSilentMode?: boolean, specification?: string, timeout?: number): Promise<Models.Site>;
+    /**
+     * Update the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.
+     *
+     * @param {string} params.siteId - Site ID.
+     * @param {string} params.deploymentId - Deployment ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Site>}
+     */
+    sitesUpdateSiteDeployment(params: {
+        siteId: string;
+        deploymentId: string;
+    }): Promise<Models.Site>;
+    /**
+     * Update the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.
+     *
+     * @param {string} siteId - Site ID.
+     * @param {string} deploymentId - Deployment ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Site>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesUpdateSiteDeployment(siteId: string, deploymentId: string): Promise<Models.Site>;
+    /**
+     * Get a list of all the site's code deployments. You can use the query params to filter your results.
+     *
+     * @param {string} params.siteId - Site ID.
+     * @param {string[]} params.queries - Result filters, paging and ordering. Repeat the parameter once per query — `?queries=…&queries=…` — and make each value a JSON object, e.g. `{"method":"limit","values":[25]}`. The bracketed spellings `queries[]=` and `queries[0]=` are accepted too; the `limit(25)` call syntax is not. See “Query parameters” in this document's introduction. Filterable attributes, besides `$id`, `$createdAt`, `$updatedAt` and `$sequence`: buildSize, sourceSize, totalSize, buildDuration, status, activate, type
+     * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.DeploymentList>}
+     */
+    sitesListDeployments(params: {
+        siteId: string;
+        queries?: string[];
+        search?: string;
+        total?: boolean;
+    }): Promise<Models.DeploymentList>;
+    /**
+     * Get a list of all the site's code deployments. You can use the query params to filter your results.
+     *
+     * @param {string} siteId - Site ID.
+     * @param {string[]} queries - Result filters, paging and ordering. Repeat the parameter once per query — `?queries=…&queries=…` — and make each value a JSON object, e.g. `{"method":"limit","values":[25]}`. The bracketed spellings `queries[]=` and `queries[0]=` are accepted too; the `limit(25)` call syntax is not. See “Query parameters” in this document's introduction. Filterable attributes, besides `$id`, `$createdAt`, `$updatedAt` and `$sequence`: buildSize, sourceSize, totalSize, buildDuration, status, activate, type
+     * @param {string} search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.DeploymentList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesListDeployments(siteId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.DeploymentList>;
+    /**
+     * Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the site's deployment to use your new deployment ID.
+     *
+     * @param {string} params.siteId - Site ID.
+     * @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
+     * @param {File} params.code - Your source directory packaged as a gzipped tar archive (`.tar.gz`), sent as the file part of the multipart request.
+     * @param {string} params.buildCommand - Build Commands.
+     * @param {string} params.installCommand - Install Commands.
+     * @param {string} params.outputDirectory - Output Directory.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Deployment>}
+     */
+    sitesCreateDeployment(params: {
+        siteId: string;
+        activate: boolean;
+        code: File;
+        buildCommand?: string;
+        installCommand?: string;
+        outputDirectory?: string;
+        onProgress?: (progress: UploadProgress) => void;
+    }): Promise<Models.Deployment>;
+    /**
+     * Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the site's deployment to use your new deployment ID.
+     *
+     * @param {string} siteId - Site ID.
+     * @param {boolean} activate - Automatically activate the deployment when it is finished building.
+     * @param {File} code - Your source directory packaged as a gzipped tar archive (`.tar.gz`), sent as the file part of the multipart request.
+     * @param {string} buildCommand - Build Commands.
+     * @param {string} installCommand - Install Commands.
+     * @param {string} outputDirectory - Output Directory.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Deployment>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesCreateDeployment(siteId: string, activate: boolean, code: File, buildCommand?: string, installCommand?: string, outputDirectory?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
+    /**
+     * Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.
+     *
+     * @param {string} params.siteId - Site ID.
+     * @param {string} params.deploymentId - Deployment ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Deployment>}
+     */
+    sitesCreateDuplicateDeployment(params: {
+        siteId: string;
+        deploymentId: string;
+    }): Promise<Models.Deployment>;
+    /**
+     * Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.
+     *
+     * @param {string} siteId - Site ID.
+     * @param {string} deploymentId - Deployment ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Deployment>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesCreateDuplicateDeployment(siteId: string, deploymentId: string): Promise<Models.Deployment>;
+    /**
+     * Create a deployment based on a template.
+     *
+     * Unlike app templates, site templates have no listing on this API — that catalogue is the vendor's and is not reproduced here. Take `repository`, `owner`, `rootDirectory` and `reference` from wherever the template is published.
+     *
+     * @param {string} params.siteId - Site ID.
+     * @param {string} params.owner - The name of the owner of the template.
+     * @param {string} params.reference - Reference value, can be a commit hash, branch name, or release tag
+     * @param {string} params.repository - Repository name of the template.
+     * @param {string} params.rootDirectory - Path to site code in the template repo.
+     * @param {SitesCreateTemplateDeploymentType} params.type - Type for the reference provided. Can be commit, branch, or tag
+     * @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Deployment>}
+     */
+    sitesCreateTemplateDeployment(params: {
+        siteId: string;
+        owner: string;
+        reference: string;
+        repository: string;
+        rootDirectory: string;
+        type: SitesCreateTemplateDeploymentType;
+        activate?: boolean;
+    }): Promise<Models.Deployment>;
+    /**
+     * Create a deployment based on a template.
+     *
+     * Unlike app templates, site templates have no listing on this API — that catalogue is the vendor's and is not reproduced here. Take `repository`, `owner`, `rootDirectory` and `reference` from wherever the template is published.
+     *
+     * @param {string} siteId - Site ID.
+     * @param {string} owner - The name of the owner of the template.
+     * @param {string} reference - Reference value, can be a commit hash, branch name, or release tag
+     * @param {string} repository - Repository name of the template.
+     * @param {string} rootDirectory - Path to site code in the template repo.
+     * @param {SitesCreateTemplateDeploymentType} type - Type for the reference provided. Can be commit, branch, or tag
+     * @param {boolean} activate - Automatically activate the deployment when it is finished building.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Deployment>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesCreateTemplateDeployment(siteId: string, owner: string, reference: string, repository: string, rootDirectory: string, type: SitesCreateTemplateDeploymentType, activate?: boolean): Promise<Models.Deployment>;
+    /**
+     * Create a deployment when a site is connected to VCS.
+     *
+     * This endpoint lets you create deployment from a branch, commit, or a tag.
+     *
+     * @param {string} params.siteId - Site ID.
+     * @param {string} params.reference - VCS reference to create deployment from. Depending on type this can be: branch name, commit hash
+     * @param {SitesCreateTemplateDeploymentType} params.type - Type of reference passed. Allowed values are: branch, commit
+     * @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Deployment>}
+     */
+    sitesCreateVcsDeployment(params: {
+        siteId: string;
+        reference: string;
+        type: SitesCreateTemplateDeploymentType;
+        activate?: boolean;
+    }): Promise<Models.Deployment>;
+    /**
+     * Create a deployment when a site is connected to VCS.
+     *
+     * This endpoint lets you create deployment from a branch, commit, or a tag.
+     *
+     * @param {string} siteId - Site ID.
+     * @param {string} reference - VCS reference to create deployment from. Depending on type this can be: branch name, commit hash
+     * @param {SitesCreateTemplateDeploymentType} type - Type of reference passed. Allowed values are: branch, commit
+     * @param {boolean} activate - Automatically activate the deployment when it is finished building.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Deployment>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesCreateVcsDeployment(siteId: string, reference: string, type: SitesCreateTemplateDeploymentType, activate?: boolean): Promise<Models.Deployment>;
+    /**
+     * Delete a site deployment by its unique ID.
+     *
+     * @param {string} params.siteId - Site ID.
+     * @param {string} params.deploymentId - Deployment ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    sitesDeleteDeployment(params: {
+        siteId: string;
+        deploymentId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a site deployment by its unique ID.
+     *
+     * @param {string} siteId - Site ID.
+     * @param {string} deploymentId - Deployment ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesDeleteDeployment(siteId: string, deploymentId: string): Promise<{}>;
+    /**
+     * Get a site deployment by its unique ID.
+     *
+     * @param {string} params.siteId - Site ID.
+     * @param {string} params.deploymentId - Deployment ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Deployment>}
+     */
+    sitesGetDeployment(params: {
+        siteId: string;
+        deploymentId: string;
+    }): Promise<Models.Deployment>;
+    /**
+     * Get a site deployment by its unique ID.
+     *
+     * @param {string} siteId - Site ID.
+     * @param {string} deploymentId - Deployment ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Deployment>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesGetDeployment(siteId: string, deploymentId: string): Promise<Models.Deployment>;
+    /**
+     * Get a site deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.
+     *
+     * @param {string} params.siteId - Site ID.
+     * @param {string} params.deploymentId - Deployment ID.
+     * @param {AppsGetDeploymentDownloadType} params.type - Deployment file to download. Can be: "source", "output".
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    sitesGetDeploymentDownload(params: {
+        siteId: string;
+        deploymentId: string;
+        type?: AppsGetDeploymentDownloadType;
+    }): Promise<{}>;
+    /**
+     * Get a site deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.
+     *
+     * @param {string} siteId - Site ID.
+     * @param {string} deploymentId - Deployment ID.
+     * @param {AppsGetDeploymentDownloadType} type - Deployment file to download. Can be: "source", "output".
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesGetDeploymentDownload(siteId: string, deploymentId: string, type?: AppsGetDeploymentDownloadType): Promise<{}>;
+    /**
+     * Cancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.
+     *
+     * @param {string} params.siteId - Site ID.
+     * @param {string} params.deploymentId - Deployment ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Deployment>}
+     */
+    sitesUpdateDeploymentStatus(params: {
+        siteId: string;
+        deploymentId: string;
+    }): Promise<Models.Deployment>;
+    /**
+     * Cancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.
+     *
+     * @param {string} siteId - Site ID.
+     * @param {string} deploymentId - Deployment ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Deployment>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesUpdateDeploymentStatus(siteId: string, deploymentId: string): Promise<Models.Deployment>;
+    /**
+     * Get a list of all site logs. You can use the query params to filter your results.
+     *
+     * @param {string} params.siteId - Site ID.
+     * @param {string[]} params.queries - Result filters, paging and ordering. Repeat the parameter once per query — `?queries=…&queries=…` — and make each value a JSON object, e.g. `{"method":"limit","values":[25]}`. The bracketed spellings `queries[]=` and `queries[0]=` are accepted too; the `limit(25)` call syntax is not. See “Query parameters” in this document's introduction. Filterable attributes, besides `$id`, `$createdAt`, `$updatedAt` and `$sequence`: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ExecutionList>}
+     */
+    sitesListLogs(params: {
+        siteId: string;
+        queries?: string[];
+        total?: boolean;
+    }): Promise<Models.ExecutionList>;
+    /**
+     * Get a list of all site logs. You can use the query params to filter your results.
+     *
+     * @param {string} siteId - Site ID.
+     * @param {string[]} queries - Result filters, paging and ordering. Repeat the parameter once per query — `?queries=…&queries=…` — and make each value a JSON object, e.g. `{"method":"limit","values":[25]}`. The bracketed spellings `queries[]=` and `queries[0]=` are accepted too; the `limit(25)` call syntax is not. See “Query parameters” in this document's introduction. Filterable attributes, besides `$id`, `$createdAt`, `$updatedAt` and `$sequence`: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.ExecutionList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesListLogs(siteId: string, queries?: string[], total?: boolean): Promise<Models.ExecutionList>;
+    /**
+     * Delete a site log by its unique ID.
+     *
+     * @param {string} params.siteId - Site ID.
+     * @param {string} params.logId - Log ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    sitesDeleteLog(params: {
+        siteId: string;
+        logId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a site log by its unique ID.
+     *
+     * @param {string} siteId - Site ID.
+     * @param {string} logId - Log ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesDeleteLog(siteId: string, logId: string): Promise<{}>;
+    /**
+     * Get a site request log by its unique ID.
+     *
+     * @param {string} params.siteId - Site ID.
+     * @param {string} params.logId - Log ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Execution>}
+     */
+    sitesGetLog(params: {
+        siteId: string;
+        logId: string;
+    }): Promise<Models.Execution>;
+    /**
+     * Get a site request log by its unique ID.
+     *
+     * @param {string} siteId - Site ID.
+     * @param {string} logId - Log ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Execution>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesGetLog(siteId: string, logId: string): Promise<Models.Execution>;
+    /**
+     * Get a list of all variables of a specific site.
+     *
+     * @param {string} params.siteId - Site unique ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.VariableList>}
+     */
+    sitesListVariables(params: {
+        siteId: string;
+    }): Promise<Models.VariableList>;
+    /**
+     * Get a list of all variables of a specific site.
+     *
+     * @param {string} siteId - Site unique ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.VariableList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesListVariables(siteId: string): Promise<Models.VariableList>;
+    /**
+     * Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.
+     *
+     * @param {string} params.siteId - Site unique ID.
+     * @param {string} params.key - Variable key. Max length: 255 chars.
+     * @param {string} params.value - Variable value. Max length: 8192 chars.
+     * @param {boolean} params.secret - Secret variables can be updated or deleted, but only sites can read them during build and runtime.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Variable>}
+     */
+    sitesCreateVariable(params: {
+        siteId: string;
+        key: string;
+        value: string;
+        secret?: boolean;
+    }): Promise<Models.Variable>;
+    /**
+     * Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.
+     *
+     * @param {string} siteId - Site unique ID.
+     * @param {string} key - Variable key. Max length: 255 chars.
+     * @param {string} value - Variable value. Max length: 8192 chars.
+     * @param {boolean} secret - Secret variables can be updated or deleted, but only sites can read them during build and runtime.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Variable>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesCreateVariable(siteId: string, key: string, value: string, secret?: boolean): Promise<Models.Variable>;
+    /**
+     * Delete a variable by its unique ID.
+     *
+     * @param {string} params.siteId - Site unique ID.
+     * @param {string} params.variableId - Variable unique ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    sitesDeleteVariable(params: {
+        siteId: string;
+        variableId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a variable by its unique ID.
+     *
+     * @param {string} siteId - Site unique ID.
+     * @param {string} variableId - Variable unique ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesDeleteVariable(siteId: string, variableId: string): Promise<{}>;
+    /**
+     * Get a variable by its unique ID.
+     *
+     * @param {string} params.siteId - Site unique ID.
+     * @param {string} params.variableId - Variable unique ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Variable>}
+     */
+    sitesGetVariable(params: {
+        siteId: string;
+        variableId: string;
+    }): Promise<Models.Variable>;
+    /**
+     * Get a variable by its unique ID.
+     *
+     * @param {string} siteId - Site unique ID.
+     * @param {string} variableId - Variable unique ID.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Variable>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesGetVariable(siteId: string, variableId: string): Promise<Models.Variable>;
+    /**
+     * Update variable by its unique ID.
+     *
+     * @param {string} params.siteId - Site unique ID.
+     * @param {string} params.variableId - Variable unique ID.
+     * @param {string} params.key - Variable key. Max length: 255 chars.
+     * @param {boolean} params.secret - Secret variables can be updated or deleted, but only sites can read them during build and runtime.
+     * @param {string} params.value - Variable value. Max length: 8192 chars.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Variable>}
+     */
+    sitesUpdateVariable(params: {
+        siteId: string;
+        variableId: string;
+        key: string;
+        secret?: boolean;
+        value?: string;
+    }): Promise<Models.Variable>;
+    /**
+     * Update variable by its unique ID.
+     *
+     * @param {string} siteId - Site unique ID.
+     * @param {string} variableId - Variable unique ID.
+     * @param {string} key - Variable key. Max length: 255 chars.
+     * @param {boolean} secret - Secret variables can be updated or deleted, but only sites can read them during build and runtime.
+     * @param {string} value - Variable value. Max length: 8192 chars.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Variable>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    sitesUpdateVariable(siteId: string, variableId: string, key: string, secret?: boolean, value?: string): Promise<Models.Variable>;
+}
+
+export { Sites };