@forteplatforms/sdk 1.0.496 → 1.0.497

package/dist/generated/apis/ProjectsServerApi.d.ts

@@ -621,6 +621,9 @@ export interface ListServiceHistoryRequest {
     maxTime?: Date;
     nextToken?: string;
 }
+export interface ListServicesRequest {
+    projectId: string;
+}
 export interface ListUserActionLogsRequest {
     projectId: string;
     userId: string;
@@ -1968,6 +1971,16 @@ export declare class ProjectsServerApi extends runtime.BaseAPI {
     /**
      */
     listServiceHistory(requestParameters: ListServiceHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAccountActionLogObject>;
+    /**
+     * Creates request options for listServices without sending the request
+     */
+    listServicesRequestOpts(requestParameters: ListServicesRequest): Promise<runtime.RequestOpts>;
+    /**
+     */
+    listServicesRaw(requestParameters: ListServicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ServiceObject>>>;
+    /**
+     */
+    listServices(requestParameters: ListServicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ServiceObject>>;
     /**
      * Creates request options for listUserActionLogs without sending the request
      */

package/dist/generated/apis/ProjectsServerApi.js

@@ -6551,6 +6551,63 @@ var ProjectsServerApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Creates request options for listServices without sending the request
+     */
+    ProjectsServerApi.prototype.listServicesRequestOpts = function (requestParameters) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, urlPath;
+            return __generator(this, function (_a) {
+                if (requestParameters['projectId'] == null) {
+                    throw new runtime.RequiredError('projectId', 'Required parameter "projectId" was null or undefined when calling listServices().');
+                }
+                queryParameters = {};
+                headerParameters = {};
+                urlPath = "/api/v1/projects/{projectId}/services";
+                urlPath = urlPath.replace('{projectId}', encodeURIComponent(String(requestParameters['projectId'])));
+                return [2 /*return*/, {
+                        path: urlPath,
+                        method: 'GET',
+                        headers: headerParameters,
+                        query: queryParameters,
+                    }];
+            });
+        });
+    };
+    /**
+     */
+    ProjectsServerApi.prototype.listServicesRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var requestOptions, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.listServicesRequestOpts(requestParameters)];
+                    case 1:
+                        requestOptions = _a.sent();
+                        return [4 /*yield*/, this.request(requestOptions, initOverrides)];
+                    case 2:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(ServiceObject_1.ServiceObjectFromJSON); })];
+                }
+            });
+        });
+    };
+    /**
+     */
+    ProjectsServerApi.prototype.listServices = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.listServicesRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Creates request options for listUserActionLogs without sending the request
      */

package/dist/generated/models/CreateForteServiceRequest.d.ts

@@ -17,13 +17,13 @@ import type { CreateServiceDatabaseConnectionRequest } from './CreateServiceData
  */
 export interface CreateForteServiceRequest {
     /**
-     *
+     * GitHub repository URL; the Forte GitHub App must be installed on its owner. Required unless codeSourceType is ARTIFACT.
      * @type {string}
      * @memberof CreateForteServiceRequest
      */
     githubRepositoryUrl?: string | null;
     /**
-     *
+     * PUSH deploys on every push to githubBranch; RELEASE_PUBLISHED deploys on GitHub releases. Required unless codeSourceType is ARTIFACT.
      * @type {CreateForteServiceRequestBuildTriggerType}
      * @memberof CreateForteServiceRequest
      */
@@ -41,7 +41,7 @@ export interface CreateForteServiceRequest {
      */
     artifactId?: string | null;
     /**
-     *
+     * Branch to build; required for PUSH.
      * @type {string}
      * @memberof CreateForteServiceRequest
      */
@@ -101,7 +101,7 @@ export interface CreateForteServiceRequest {
      */
     healthCheckPath?: string | null;
     /**
-     *
+     * Path of the app inside a monorepo.
      * @type {string}
      * @memberof CreateForteServiceRequest
      */
@@ -113,19 +113,19 @@ export interface CreateForteServiceRequest {
      */
     requestResponseBodyLoggingEnabled?: boolean | null;
     /**
-     *
+     * Ant-style path patterns (e.g. /public/**) that skip Forte user auth.
      * @type {Array<string>}
      * @memberof CreateForteServiceRequest
      */
     authPathExclusions?: Array<string> | null;
     /**
-     *
+     * Ant-style path patterns that return 404.
      * @type {Array<string>}
      * @memberof CreateForteServiceRequest
      */
     blockedPaths?: Array<string> | null;
     /**
-     *
+     * Managed databases to connect from the first deployment.
      * @type {Array<CreateServiceDatabaseConnectionRequest>}
      * @memberof CreateForteServiceRequest
      */

package/dist/generated/models/CreateManagedDatabaseRequest.d.ts

@@ -34,19 +34,19 @@ export interface CreateManagedDatabaseRequest {
      */
     tier: CreateManagedDatabaseRequestTierType;
     /**
-     *
+     * Ignored on the SHARED tier.
      * @type {string}
      * @memberof CreateManagedDatabaseRequest
      */
     cpu?: string | null;
     /**
-     *
+     * Ignored on the SHARED tier.
      * @type {number}
      * @memberof CreateManagedDatabaseRequest
      */
     memoryGb?: number | null;
     /**
-     *
+     * Defaults to 2 GB.
      * @type {number}
      * @memberof CreateManagedDatabaseRequest
      */

package/dist/generated/models/CreateServiceDatabaseConnectionRequest.d.ts

@@ -17,7 +17,7 @@ import type { ManagedDatabaseEnvVarMappings } from './ManagedDatabaseEnvVarMappi
  */
 export interface CreateServiceDatabaseConnectionRequest {
     /**
-     *
+     * An ACTIVE managed database in the same project.
      * @type {string}
      * @memberof CreateServiceDatabaseConnectionRequest
      */

package/dist/generated/models/CreateServiceToServiceConnectionRequest.d.ts

@@ -16,37 +16,37 @@
  */
 export interface CreateServiceToServiceConnectionRequest {
     /**
-     *
+     * The target service whose URL is set; same project.
      * @type {string}
      * @memberof CreateServiceToServiceConnectionRequest
      */
     serviceId: string;
     /**
-     *
+     * Environment variable that receives the URL.
      * @type {string}
      * @memberof CreateServiceToServiceConnectionRequest
      */
     environmentVariableName: string;
     /**
-     *
+     * FORTE_DOMAIN uses the Forte URL; CUSTOM_DOMAIN uses customDomainId.
      * @type {CreateServiceToServiceConnectionRequestDomainTypeType}
      * @memberof CreateServiceToServiceConnectionRequest
      */
     domainType: CreateServiceToServiceConnectionRequestDomainTypeType;
     /**
-     *
+     * An ACTIVE custom domain of the target; required for CUSTOM_DOMAIN.
      * @type {string}
      * @memberof CreateServiceToServiceConnectionRequest
      */
     customDomainId?: string | null;
     /**
-     *
+     * Appended to the URL, e.g. /api.
      * @type {string}
      * @memberof CreateServiceToServiceConnectionRequest
      */
     pathSuffix?: string | null;
     /**
-     *
+     * Set true to replace a plain environment variable of the same name.
      * @type {boolean}
      * @memberof CreateServiceToServiceConnectionRequest
      */

package/dist/generated/models/CreateServiceToWebAppConnectionRequest.d.ts

@@ -16,37 +16,37 @@
  */
 export interface CreateServiceToWebAppConnectionRequest {
     /**
-     *
+     * The web app whose URL is set; same project.
      * @type {string}
      * @memberof CreateServiceToWebAppConnectionRequest
      */
     webAppId: string;
     /**
-     *
+     * Environment variable that receives the URL.
      * @type {string}
      * @memberof CreateServiceToWebAppConnectionRequest
      */
     environmentVariableName: string;
     /**
-     *
+     * FORTE_DOMAIN uses the Forte URL; CUSTOM_DOMAIN uses customDomainId.
      * @type {CreateServiceToWebAppConnectionRequestDomainTypeType}
      * @memberof CreateServiceToWebAppConnectionRequest
      */
     domainType: CreateServiceToWebAppConnectionRequestDomainTypeType;
     /**
-     *
+     * An ACTIVE custom domain of the target; required for CUSTOM_DOMAIN.
      * @type {string}
      * @memberof CreateServiceToWebAppConnectionRequest
      */
     customDomainId?: string | null;
     /**
-     *
+     * Appended to the URL, e.g. /api.
      * @type {string}
      * @memberof CreateServiceToWebAppConnectionRequest
      */
     pathSuffix?: string | null;
     /**
-     *
+     * Set true to replace a plain environment variable of the same name.
      * @type {boolean}
      * @memberof CreateServiceToWebAppConnectionRequest
      */

package/dist/generated/models/CreateServiceUrlConnectionRequest.d.ts

@@ -16,37 +16,37 @@
  */
 export interface CreateServiceUrlConnectionRequest {
     /**
-     *
+     * The backend service whose URL is set; same project.
      * @type {string}
      * @memberof CreateServiceUrlConnectionRequest
      */
     serviceId: string;
     /**
-     *
+     * Environment variable that receives the URL.
      * @type {string}
      * @memberof CreateServiceUrlConnectionRequest
      */
     environmentVariableName: string;
     /**
-     *
+     * FORTE_DOMAIN uses the Forte URL; CUSTOM_DOMAIN uses customDomainId.
      * @type {CreateServiceUrlConnectionRequestDomainTypeType}
      * @memberof CreateServiceUrlConnectionRequest
      */
     domainType: CreateServiceUrlConnectionRequestDomainTypeType;
     /**
-     *
+     * An ACTIVE custom domain of the target; required for CUSTOM_DOMAIN.
      * @type {string}
      * @memberof CreateServiceUrlConnectionRequest
      */
     customDomainId?: string | null;
     /**
-     *
+     * Appended to the URL, e.g. /api.
      * @type {string}
      * @memberof CreateServiceUrlConnectionRequest
      */
     pathSuffix?: string | null;
     /**
-     *
+     * Set true to replace a plain environment variable of the same name.
      * @type {boolean}
      * @memberof CreateServiceUrlConnectionRequest
      */

package/dist/generated/models/CreateWebAppRequest.d.ts

@@ -23,19 +23,19 @@ export interface CreateWebAppRequest {
      */
     webAppName: string;
     /**
-     *
+     * GitHub repository URL; the Forte GitHub App must be installed on its owner. Required unless codeSourceType is ARTIFACT.
      * @type {string}
      * @memberof CreateWebAppRequest
      */
     githubRepositoryUrl?: string | null;
     /**
-     *
+     * Branch to build; required for PUSH.
      * @type {string}
      * @memberof CreateWebAppRequest
      */
     githubBranch?: string | null;
     /**
-     *
+     * PUSH deploys on every push to githubBranch; RELEASE_PUBLISHED deploys on GitHub releases. Required unless codeSourceType is ARTIFACT.
      * @type {CreateWebAppRequestBuildTriggerType}
      * @memberof CreateWebAppRequest
      */
@@ -53,37 +53,37 @@ export interface CreateWebAppRequest {
      */
     artifactId?: string | null;
     /**
-     *
+     * Auto-detected when omitted.
      * @type {string}
      * @memberof CreateWebAppRequest
      */
     buildCommand?: string | null;
     /**
-     *
+     * Build output directory. Auto-detected when omitted.
      * @type {string}
      * @memberof CreateWebAppRequest
      */
     buildPath?: string | null;
     /**
-     *
+     * Auto-detected when omitted.
      * @type {string}
      * @memberof CreateWebAppRequest
      */
     packageManager?: string | null;
     /**
-     *
+     * Auto-detected when omitted.
      * @type {string}
      * @memberof CreateWebAppRequest
      */
     nodeVersion?: string | null;
     /**
-     *
+     * Auto-detected when omitted.
      * @type {string}
      * @memberof CreateWebAppRequest
      */
     installCommand?: string | null;
     /**
-     *
+     * Path of the app inside a monorepo.
      * @type {string}
      * @memberof CreateWebAppRequest
      */
@@ -105,7 +105,7 @@ export interface CreateWebAppRequest {
         [key: string]: string;
     };
     /**
-     *
+     * Backend service URLs to set as environment variables from the first build.
      * @type {Array<CreateServiceUrlConnectionRequest>}
      * @memberof CreateWebAppRequest
      */

package/dist/generated/models/ManagedDatabaseEnvVarMappings.d.ts

@@ -16,49 +16,49 @@
  */
 export interface ManagedDatabaseEnvVarMappings {
     /**
-     *
+     * Environment variable that receives the full connection string, e.g. DATABASE_URL.
      * @type {string}
      * @memberof ManagedDatabaseEnvVarMappings
      */
     connectionStringEnvVar?: string | null;
     /**
-     *
+     * Environment variable that receives the host.
      * @type {string}
      * @memberof ManagedDatabaseEnvVarMappings
      */
     hostEnvVar?: string | null;
     /**
-     *
+     * Environment variable that receives the port.
      * @type {string}
      * @memberof ManagedDatabaseEnvVarMappings
      */
     portEnvVar?: string | null;
     /**
-     *
+     * Environment variable that receives the database name.
      * @type {string}
      * @memberof ManagedDatabaseEnvVarMappings
      */
     databaseEnvVar?: string | null;
     /**
-     *
+     * Environment variable that receives the username.
      * @type {string}
      * @memberof ManagedDatabaseEnvVarMappings
      */
     usernameEnvVar?: string | null;
     /**
-     *
+     * Environment variable that receives the password.
      * @type {string}
      * @memberof ManagedDatabaseEnvVarMappings
      */
     passwordEnvVar?: string | null;
     /**
-     *
+     * Connection string dialect for the consuming driver. Defaults to URI; CUSTOM uses connectionStringTemplate.
      * @type {ManagedDatabaseEnvVarMappingsConnectionStringFormatType}
      * @memberof ManagedDatabaseEnvVarMappings
      */
     connectionStringFormat?: ManagedDatabaseEnvVarMappingsConnectionStringFormatType | null;
     /**
-     *
+     * CUSTOM format only. Placeholders: {host} {port} {database} {username} {password} {sslmode}.
      * @type {string}
      * @memberof ManagedDatabaseEnvVarMappings
      */

package/dist/generated/models/UpdateServiceToServiceConnectionRequest.d.ts

@@ -16,31 +16,31 @@
  */
 export interface UpdateServiceToServiceConnectionRequest {
     /**
-     *
+     * The target service whose URL is set; same project.
      * @type {string}
      * @memberof UpdateServiceToServiceConnectionRequest
      */
     serviceId: string;
     /**
-     *
+     * Environment variable that receives the URL.
      * @type {string}
      * @memberof UpdateServiceToServiceConnectionRequest
      */
     environmentVariableName: string;
     /**
-     *
+     * FORTE_DOMAIN uses the Forte URL; CUSTOM_DOMAIN uses customDomainId.
      * @type {UpdateServiceToServiceConnectionRequestDomainTypeType}
      * @memberof UpdateServiceToServiceConnectionRequest
      */
     domainType: UpdateServiceToServiceConnectionRequestDomainTypeType;
     /**
-     *
+     * An ACTIVE custom domain of the target; required for CUSTOM_DOMAIN.
      * @type {string}
      * @memberof UpdateServiceToServiceConnectionRequest
      */
     customDomainId?: string | null;
     /**
-     *
+     * Appended to the URL, e.g. /api.
      * @type {string}
      * @memberof UpdateServiceToServiceConnectionRequest
      */

package/dist/generated/models/UpdateServiceToWebAppConnectionRequest.d.ts

@@ -16,31 +16,31 @@
  */
 export interface UpdateServiceToWebAppConnectionRequest {
     /**
-     *
+     * The web app whose URL is set; same project.
      * @type {string}
      * @memberof UpdateServiceToWebAppConnectionRequest
      */
     webAppId: string;
     /**
-     *
+     * Environment variable that receives the URL.
      * @type {string}
      * @memberof UpdateServiceToWebAppConnectionRequest
      */
     environmentVariableName: string;
     /**
-     *
+     * FORTE_DOMAIN uses the Forte URL; CUSTOM_DOMAIN uses customDomainId.
      * @type {UpdateServiceToWebAppConnectionRequestDomainTypeType}
      * @memberof UpdateServiceToWebAppConnectionRequest
      */
     domainType: UpdateServiceToWebAppConnectionRequestDomainTypeType;
     /**
-     *
+     * An ACTIVE custom domain of the target; required for CUSTOM_DOMAIN.
      * @type {string}
      * @memberof UpdateServiceToWebAppConnectionRequest
      */
     customDomainId?: string | null;
     /**
-     *
+     * Appended to the URL, e.g. /api.
      * @type {string}
      * @memberof UpdateServiceToWebAppConnectionRequest
      */

package/dist/generated/models/UpdateServiceUrlConnectionRequest.d.ts

@@ -16,31 +16,31 @@
  */
 export interface UpdateServiceUrlConnectionRequest {
     /**
-     *
+     * The backend service whose URL is set; same project.
      * @type {string}
      * @memberof UpdateServiceUrlConnectionRequest
      */
     serviceId: string;
     /**
-     *
+     * Environment variable that receives the URL.
      * @type {string}
      * @memberof UpdateServiceUrlConnectionRequest
      */
     environmentVariableName: string;
     /**
-     *
+     * FORTE_DOMAIN uses the Forte URL; CUSTOM_DOMAIN uses customDomainId.
      * @type {UpdateServiceUrlConnectionRequestDomainTypeType}
      * @memberof UpdateServiceUrlConnectionRequest
      */
     domainType: UpdateServiceUrlConnectionRequestDomainTypeType;
     /**
-     *
+     * An ACTIVE custom domain of the target; required for CUSTOM_DOMAIN.
      * @type {string}
      * @memberof UpdateServiceUrlConnectionRequest
      */
     customDomainId?: string | null;
     /**
-     *
+     * Appended to the URL, e.g. /api.
      * @type {string}
      * @memberof UpdateServiceUrlConnectionRequest
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forteplatforms/sdk",
-  "version": "1.0.496",
+  "version": "1.0.497",
   "description": "Official TypeScript SDK for Forte Platforms",
   "author": "Forte Platforms <support@forteplatforms.com>",
   "repository": {