@forteplatforms/sdk 1.0.156 → 1.0.163

package/README.md

@@ -10,27 +10,48 @@ npm install @forteplatforms/sdk
 
 ## Authentication
 
-When your code runs inside a Forte-hosted service, `FORTE_API_TOKEN` is set automatically and scoped to the service's project — no configuration needed:
+The SDK supports three auth modes depending on where it runs.
+
+### Inside a Forte-hosted service (no config)
+
+`FORTE_API_TOKEN` is set automatically and scoped to the service's project:
 
 ```typescript
 const client = new ForteClient();
 ```
 
-Outside of Forte (local development, external hosting), pass the token explicitly:
+### Client-side (browser / mobile)
+
+For calls to `client.users.*`, construct with no arguments. The browser sends the `Forte-User-Session-Token` cookie automatically after the user logs in. The SDK sets `credentials: 'include'` so the cookie reaches the API cross-origin.
 
 ```typescript
-const client = new ForteClient({ apiToken: 'your_api_token_here' });
+const client = new ForteClient();
+await client.users.renewSessionToken({ projectId });
 ```
 
-Or set it as an environment variable (Node.js only):
+Do **not** pass `apiToken` from browser code — it's a server-side secret.
 
-```bash
-export FORTE_API_TOKEN=your_api_token_here
+### Server-side BFF calling `client.users.*` (no token, per-call authorization)
+
+In a BFF that proxies user-scoped calls, omit the token and forward each user's session token as the `authorization` parameter on each call:
+
+```typescript
+const client = new ForteClient();
+await client.users.renewSessionToken({
+  projectId,
+  authorization: `Bearer ${userSessionToken}`,
+});
 ```
 
-You can generate an API token from the Forte Platforms dashboard.
+### External server-side calling `client.projects.*` (explicit token)
 
-> **Note:** The TypeScript SDK works in both Node.js and browser/React environments. In browsers, you must pass `apiToken` directly since environment variables are not available.
+```typescript
+const client = new ForteClient({ apiToken: 'your_api_token_here' });
+```
+
+Or set `FORTE_API_TOKEN` in the environment (Node.js only) and call `new ForteClient()`.
+
+You can generate an API token from the Forte Platforms dashboard.
 
 ## Quick Start
 

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

@@ -17,6 +17,7 @@ import { type ContactMethod } from '../models/ContactMethod';
 import { type ContentObject } from '../models/ContentObject';
 import { type CreateContentUploadLinkRequest } from '../models/CreateContentUploadLinkRequest';
 import { type CreateContentUploadLinkResponse } from '../models/CreateContentUploadLinkResponse';
+import { type CreateCustomDomainRequest } from '../models/CreateCustomDomainRequest';
 import { type CreateForteServiceRequest } from '../models/CreateForteServiceRequest';
 import { type CreatePaymentPreviewRequest } from '../models/CreatePaymentPreviewRequest';
 import { type CreatePaymentPreviewResponse } from '../models/CreatePaymentPreviewResponse';
@@ -28,9 +29,11 @@ import { type CreateProjectApiKeyResponse } from '../models/CreateProjectApiKeyR
 import { type CreateServiceRequestProxyRequest } from '../models/CreateServiceRequestProxyRequest';
 import { type CreateServiceRequestProxyResponse } from '../models/CreateServiceRequestProxyResponse';
 import { type CreateWebAppRequest } from '../models/CreateWebAppRequest';
+import { type CustomDomainResponse } from '../models/CustomDomainResponse';
 import { type GetContentDownloadLinkResponse } from '../models/GetContentDownloadLinkResponse';
 import { type ImpersonationTokenResponse } from '../models/ImpersonationTokenResponse';
 import { type ListContentResponse } from '../models/ListContentResponse';
+import { type ListCustomDomainsResponse } from '../models/ListCustomDomainsResponse';
 import { type NotificationTemplatesResponse } from '../models/NotificationTemplatesResponse';
 import { type PaginatedResponseLogLineObject } from '../models/PaginatedResponseLogLineObject';
 import { type PaginatedResponsePaymentObject } from '../models/PaginatedResponsePaymentObject';
@@ -48,6 +51,7 @@ import { type SendUserSmsRequest } from '../models/SendUserSmsRequest';
 import { type ServiceBuildRequestObject } from '../models/ServiceBuildRequestObject';
 import { type ServiceMetricsResponse } from '../models/ServiceMetricsResponse';
 import { type ServiceObject } from '../models/ServiceObject';
+import { type SyncCustomDomainResponse } from '../models/SyncCustomDomainResponse';
 import { type TestInvocationRequest } from '../models/TestInvocationRequest';
 import { type TestInvocationResponse } from '../models/TestInvocationResponse';
 import { type UpdateContentSharesRequest } from '../models/UpdateContentSharesRequest';
@@ -89,6 +93,11 @@ export interface AdminVerifyUserContactMethodRequest {
     contactMethodId: string;
     verificationCode: string;
 }
+export interface CreateCustomDomainOperationRequest {
+    projectId: string;
+    webAppId: string;
+    createCustomDomainRequest: CreateCustomDomainRequest;
+}
 export interface CreatePaymentTriggerOperationRequest {
     projectId: string;
     createPaymentTriggerRequest: CreatePaymentTriggerRequest;
@@ -124,6 +133,11 @@ export interface CreateWebAppDeploymentRequest {
     webAppId: string;
     commitSha?: string;
 }
+export interface DeleteCustomDomainRequest {
+    projectId: string;
+    webAppId: string;
+    customDomainId: string;
+}
 export interface DeletePaymentTriggerRequest {
     projectId: string;
     triggerId: string;
@@ -147,6 +161,11 @@ export interface DeleteWebAppRequest {
     projectId: string;
     webAppId: string;
 }
+export interface GetCustomDomainRequest {
+    projectId: string;
+    webAppId: string;
+    customDomainId: string;
+}
 export interface GetNotificationTemplatesRequest {
     projectId: string;
 }
@@ -197,6 +216,10 @@ export interface IssueImpersonationTokenRequest {
     projectId: string;
     userId: string;
 }
+export interface ListCustomDomainsRequest {
+    projectId: string;
+    webAppId: string;
+}
 export interface ListLogLinesRequest {
     projectId: string;
     serviceId: string;
@@ -253,6 +276,15 @@ export interface ListUsersRequest {
     maxTime?: Date;
     nextToken?: string;
 }
+export interface ListWebAppBuildLogLinesRequest {
+    projectId: string;
+    webAppId: string;
+    buildId: string;
+    minTime?: Date;
+    maxTime?: Date;
+    level?: string;
+    nextToken?: string;
+}
 export interface ListWebAppDeploymentsRequest {
     projectId: string;
     webAppId: string;
@@ -345,6 +377,11 @@ export interface SuspendUserRequest {
     userId: string;
     projectId: string;
 }
+export interface SyncCustomDomainRequest {
+    projectId: string;
+    webAppId: string;
+    customDomainId: string;
+}
 export interface TestInvocationOperationRequest {
     projectId: string;
     serviceId: string;
@@ -427,6 +464,16 @@ export declare class ProjectsServerApi extends runtime.BaseAPI {
     /**
      */
     adminVerifyUserContactMethod(requestParameters: AdminVerifyUserContactMethodRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContactMethod>;
+    /**
+     * Creates request options for createCustomDomain without sending the request
+     */
+    createCustomDomainRequestOpts(requestParameters: CreateCustomDomainOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     */
+    createCustomDomainRaw(requestParameters: CreateCustomDomainOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDomainResponse>>;
+    /**
+     */
+    createCustomDomain(requestParameters: CreateCustomDomainOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDomainResponse>;
     /**
      * Creates request options for createPaymentTrigger without sending the request
      */
@@ -507,6 +554,16 @@ export declare class ProjectsServerApi extends runtime.BaseAPI {
     /**
      */
     createWebAppDeployment(requestParameters: CreateWebAppDeploymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebAppBuildRequestObject>;
+    /**
+     * Creates request options for deleteCustomDomain without sending the request
+     */
+    deleteCustomDomainRequestOpts(requestParameters: DeleteCustomDomainRequest): Promise<runtime.RequestOpts>;
+    /**
+     */
+    deleteCustomDomainRaw(requestParameters: DeleteCustomDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    deleteCustomDomain(requestParameters: DeleteCustomDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Creates request options for deletePaymentTrigger without sending the request
      */
@@ -567,6 +624,16 @@ export declare class ProjectsServerApi extends runtime.BaseAPI {
     /**
      */
     deleteWebApp(requestParameters: DeleteWebAppRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getCustomDomain without sending the request
+     */
+    getCustomDomainRequestOpts(requestParameters: GetCustomDomainRequest): Promise<runtime.RequestOpts>;
+    /**
+     */
+    getCustomDomainRaw(requestParameters: GetCustomDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomDomainResponse>>;
+    /**
+     */
+    getCustomDomain(requestParameters: GetCustomDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomDomainResponse>;
     /**
      * Creates request options for getNotificationTemplates without sending the request
      */
@@ -677,6 +744,16 @@ export declare class ProjectsServerApi extends runtime.BaseAPI {
     /**
      */
     issueImpersonationToken(requestParameters: IssueImpersonationTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImpersonationTokenResponse>;
+    /**
+     * Creates request options for listCustomDomains without sending the request
+     */
+    listCustomDomainsRequestOpts(requestParameters: ListCustomDomainsRequest): Promise<runtime.RequestOpts>;
+    /**
+     */
+    listCustomDomainsRaw(requestParameters: ListCustomDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListCustomDomainsResponse>>;
+    /**
+     */
+    listCustomDomains(requestParameters: ListCustomDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListCustomDomainsResponse>;
     /**
      * Creates request options for listLogLines without sending the request
      */
@@ -767,6 +844,16 @@ export declare class ProjectsServerApi extends runtime.BaseAPI {
     /**
      */
     listUsers(requestParameters: ListUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseUserObject>;
+    /**
+     * Creates request options for listWebAppBuildLogLines without sending the request
+     */
+    listWebAppBuildLogLinesRequestOpts(requestParameters: ListWebAppBuildLogLinesRequest): Promise<runtime.RequestOpts>;
+    /**
+     */
+    listWebAppBuildLogLinesRaw(requestParameters: ListWebAppBuildLogLinesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseLogLineObject>>;
+    /**
+     */
+    listWebAppBuildLogLines(requestParameters: ListWebAppBuildLogLinesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseLogLineObject>;
     /**
      * Creates request options for listWebAppDeployments without sending the request
      */
@@ -937,6 +1024,16 @@ export declare class ProjectsServerApi extends runtime.BaseAPI {
     /**
      */
     suspendUser(requestParameters: SuspendUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserObject>;
+    /**
+     * Creates request options for syncCustomDomain without sending the request
+     */
+    syncCustomDomainRequestOpts(requestParameters: SyncCustomDomainRequest): Promise<runtime.RequestOpts>;
+    /**
+     */
+    syncCustomDomainRaw(requestParameters: SyncCustomDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SyncCustomDomainResponse>>;
+    /**
+     */
+    syncCustomDomain(requestParameters: SyncCustomDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SyncCustomDomainResponse>;
     /**
      * Creates request options for testInvocation without sending the request
      */
@@ -1028,6 +1125,7 @@ export declare const ListUserActionLogsActionTypeType: {
     readonly USER_HARD_DELETED: "USER_HARD_DELETED";
     readonly CONTACT_METHOD_ADDED: "CONTACT_METHOD_ADDED";
     readonly CONTACT_METHOD_REMOVED: "CONTACT_METHOD_REMOVED";
+    readonly CONTACT_METHOD_DISPLACED: "CONTACT_METHOD_DISPLACED";
     readonly CONTACT_METHOD_VERIFICATION_CODE_SENT: "CONTACT_METHOD_VERIFICATION_CODE_SENT";
     readonly CONTACT_METHOD_VERIFICATION_CODE_RE_SENT: "CONTACT_METHOD_VERIFICATION_CODE_RE_SENT";
     readonly CONTACT_METHOD_VERIFIED: "CONTACT_METHOD_VERIFIED";