@forteplatforms/sdk 1.0.13

package/README.md

@@ -0,0 +1,113 @@
+# Forte Platforms TypeScript SDK
+
+Official TypeScript SDK for interacting with the Forte Platforms API.
+
+## Installation
+
+```bash
+npm install @forteplatforms/sdk
+```
+
+## Authentication
+
+Set your API token as an environment variable:
+
+```bash
+export FORTE_API_TOKEN=your_api_token_here
+```
+
+Or pass it directly when creating the client:
+
+```typescript
+const client = new ForteClient({ apiToken: 'your_api_token_here' });
+```
+
+You can generate an API token from the Forte Platforms dashboard.
+
+## Quick Start
+
+```typescript
+import { ForteClient } from '@forteplatforms/sdk';
+
+const client = new ForteClient();
+
+// List your projects
+const projects = await client.projects.listProjects();
+
+// Get a specific project
+const project = await client.projects.getProject({ projectId: 'your-project-id' });
+```
+
+## Custom Base URL
+
+```typescript
+const client = new ForteClient({
+  baseUrl: 'https://custom-endpoint.example.com',
+});
+```
+
+## Error Handling
+
+API errors are thrown as exceptions with HTTP status information:
+
+```typescript
+try {
+  const project = await client.projects.getProject({ projectId: 'invalid-id' });
+} catch (error) {
+  console.error('API error:', error);
+}
+```
+
+## User Custom Attributes
+
+Store arbitrary key-value metadata on your users. Useful for tracking subscription tiers, feature flags, preferences, or any application-specific data.
+
+```typescript
+// Set custom attributes on a user
+const user = await client.projects.putUserCustomAttributes({
+  projectId: 'your-project-id',
+  userId: 'user-id',
+  requestBody: {
+    plan: 'pro',
+    referral_source: 'google',
+    onboarding_completed: 'true',
+  },
+});
+
+console.log(user.customMetadataAttributes);
+// { plan: 'pro', referral_source: 'google', onboarding_completed: 'true' }
+```
+
+**Key constraints:**
+- Keys must be 1-64 characters: letters, numbers, underscores, and hyphens only
+- Values are strings
+- Each call replaces all existing attributes — include any you want to keep
+
+### Merge with existing attributes
+
+```typescript
+// Read current attributes, then merge
+const user = await client.projects.getProjectUser({
+  projectId: 'your-project-id',
+  userId: 'user-id',
+});
+
+await client.projects.putUserCustomAttributes({
+  projectId: 'your-project-id',
+  userId: 'user-id',
+  requestBody: {
+    ...user.customMetadataAttributes,
+    plan: 'enterprise', // update one field
+  },
+});
+```
+
+## API Reference
+
+### `client.projects`
+
+Manage projects and services on Forte Platforms.
+
+### `client.users`
+
+Manage end-users within your projects.

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

@@ -0,0 +1,323 @@
+/**
+ * OpenAPI definition
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { CreateForteServiceRequest, CreateServiceRequestProxyRequest, CreateServiceRequestProxyResponse, PaginatedResponseLogLineObject, PaginatedResponseRequestLogObject, PaginatedResponseServiceBuildRequestObject, PaginatedResponseUserActionLogObject, PaginatedResponseUserObject, ProjectObject, RequestLogObject, ServiceBuildRequestObject, ServiceMetricsResponse, ServiceObject, UpdateForteServiceRequest, UpdateForteServiceResponse, UpdateProjectRequest, UserMetricsResponse, UserObject } from '../models/index';
+export interface CreateProjectRequest {
+    projectName: string;
+}
+export interface CreateServiceRequest {
+    projectId: string;
+    createForteServiceRequest: CreateForteServiceRequest;
+}
+export interface CreateServiceDeploymentRequest {
+    projectId: string;
+    serviceId: string;
+    commitSha?: string;
+}
+export interface CreateServiceRequestProxyOperationRequest {
+    projectId: string;
+    serviceId: string;
+    createServiceRequestProxyRequest: CreateServiceRequestProxyRequest;
+}
+export interface DeleteProjectRequest {
+    projectId: string;
+}
+export interface DeleteServiceRequest {
+    projectId: string;
+    serviceId: string;
+}
+export interface GetProjectRequest {
+    projectId: string;
+}
+export interface GetRequestInvocationLogRequest {
+    projectId: string;
+    serviceId: string;
+    requestId: string;
+}
+export interface GetServiceRequest {
+    projectId: string;
+    serviceId: string;
+}
+export interface GetServiceDeploymentRequest {
+    projectId: string;
+    serviceId: string;
+    deploymentId: string;
+}
+export interface GetServiceMetricsRequest {
+    projectId: string;
+    serviceId: string;
+    minTime?: Date;
+    maxTime?: Date;
+    granularity?: GetServiceMetricsGranularityType;
+}
+export interface GetUserRequest {
+    userId: string;
+    projectId: string;
+}
+export interface GetUserMetricsRequest {
+    projectId: string;
+    minTime?: Date;
+    maxTime?: Date;
+    granularity?: GetUserMetricsGranularityType;
+}
+export interface ListLogLinesRequest {
+    projectId: string;
+    serviceId: string;
+    minTime?: Date;
+    maxTime?: Date;
+    requestId?: string;
+    buildId?: string;
+    nextToken?: string;
+}
+export interface ListRequestInvocationLogsRequest {
+    projectId: string;
+    serviceId: string;
+    minTime?: Date;
+    maxTime?: Date;
+    statusCode?: number;
+    nextToken?: string;
+}
+export interface ListServiceDeploymentsRequest {
+    projectId: string;
+    serviceId: string;
+    minTime?: Date;
+    maxTime?: Date;
+    nextToken?: string;
+}
+export interface ListUserActionLogsRequest {
+    projectId: string;
+    userId: string;
+    actionType?: ListUserActionLogsActionTypeType;
+    minTime?: Date;
+    maxTime?: Date;
+    nextToken?: string;
+}
+export interface ListUsersRequest {
+    projectId: string;
+    minTime?: Date;
+    maxTime?: Date;
+    nextToken?: string;
+}
+export interface PutUserCustomAttributesRequest {
+    userId: string;
+    projectId: string;
+    requestBody: {
+        [key: string]: string;
+    };
+}
+export interface SearchLogLinesRequest {
+    projectId: string;
+    serviceId: string;
+    query: string;
+    minTime?: Date;
+    maxTime?: Date;
+    requestId?: string;
+    nextToken?: string;
+}
+export interface SuspendUserRequest {
+    userId: string;
+    projectId: string;
+}
+export interface UpdateProjectOperationRequest {
+    projectId: string;
+    updateProjectRequest: UpdateProjectRequest;
+}
+export interface UpdateServiceRequest {
+    projectId: string;
+    serviceId: string;
+    updateForteServiceRequest: UpdateForteServiceRequest;
+}
+/**
+ *
+ */
+export declare class ProjectsServerApi extends runtime.BaseAPI {
+    /**
+     */
+    createProjectRaw(requestParameters: CreateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectObject>>;
+    /**
+     */
+    createProject(requestParameters: CreateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectObject>;
+    /**
+     */
+    createServiceRaw(requestParameters: CreateServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ServiceObject>>;
+    /**
+     */
+    createService(requestParameters: CreateServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ServiceObject>;
+    /**
+     */
+    createServiceDeploymentRaw(requestParameters: CreateServiceDeploymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ServiceBuildRequestObject>>;
+    /**
+     */
+    createServiceDeployment(requestParameters: CreateServiceDeploymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ServiceBuildRequestObject>;
+    /**
+     */
+    createServiceRequestProxyRaw(requestParameters: CreateServiceRequestProxyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateServiceRequestProxyResponse>>;
+    /**
+     */
+    createServiceRequestProxy(requestParameters: CreateServiceRequestProxyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateServiceRequestProxyResponse>;
+    /**
+     */
+    deleteProjectRaw(requestParameters: DeleteProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    deleteProject(requestParameters: DeleteProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     */
+    deleteServiceRaw(requestParameters: DeleteServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    deleteService(requestParameters: DeleteServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     */
+    getProjectRaw(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectObject>>;
+    /**
+     */
+    getProject(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectObject>;
+    /**
+     */
+    getRequestInvocationLogRaw(requestParameters: GetRequestInvocationLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RequestLogObject>>;
+    /**
+     */
+    getRequestInvocationLog(requestParameters: GetRequestInvocationLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RequestLogObject>;
+    /**
+     */
+    getServiceRaw(requestParameters: GetServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ServiceObject>>;
+    /**
+     */
+    getService(requestParameters: GetServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ServiceObject>;
+    /**
+     */
+    getServiceDeploymentRaw(requestParameters: GetServiceDeploymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ServiceBuildRequestObject>>;
+    /**
+     */
+    getServiceDeployment(requestParameters: GetServiceDeploymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ServiceBuildRequestObject>;
+    /**
+     */
+    getServiceMetricsRaw(requestParameters: GetServiceMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ServiceMetricsResponse>>;
+    /**
+     */
+    getServiceMetrics(requestParameters: GetServiceMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ServiceMetricsResponse>;
+    /**
+     */
+    getUserRaw(requestParameters: GetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserObject>>;
+    /**
+     */
+    getUser(requestParameters: GetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserObject>;
+    /**
+     */
+    getUserMetricsRaw(requestParameters: GetUserMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserMetricsResponse>>;
+    /**
+     */
+    getUserMetrics(requestParameters: GetUserMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserMetricsResponse>;
+    /**
+     */
+    listLogLinesRaw(requestParameters: ListLogLinesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseLogLineObject>>;
+    /**
+     */
+    listLogLines(requestParameters: ListLogLinesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseLogLineObject>;
+    /**
+     */
+    listProjectsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectObject>>>;
+    /**
+     */
+    listProjects(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectObject>>;
+    /**
+     */
+    listRequestInvocationLogsRaw(requestParameters: ListRequestInvocationLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseRequestLogObject>>;
+    /**
+     */
+    listRequestInvocationLogs(requestParameters: ListRequestInvocationLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseRequestLogObject>;
+    /**
+     */
+    listServiceDeploymentsRaw(requestParameters: ListServiceDeploymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseServiceBuildRequestObject>>;
+    /**
+     */
+    listServiceDeployments(requestParameters: ListServiceDeploymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseServiceBuildRequestObject>;
+    /**
+     */
+    listUserActionLogsRaw(requestParameters: ListUserActionLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseUserActionLogObject>>;
+    /**
+     */
+    listUserActionLogs(requestParameters: ListUserActionLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseUserActionLogObject>;
+    /**
+     */
+    listUsersRaw(requestParameters: ListUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseUserObject>>;
+    /**
+     */
+    listUsers(requestParameters: ListUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseUserObject>;
+    /**
+     */
+    putUserCustomAttributesRaw(requestParameters: PutUserCustomAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserObject>>;
+    /**
+     */
+    putUserCustomAttributes(requestParameters: PutUserCustomAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserObject>;
+    /**
+     */
+    searchLogLinesRaw(requestParameters: SearchLogLinesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseLogLineObject>>;
+    /**
+     */
+    searchLogLines(requestParameters: SearchLogLinesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseLogLineObject>;
+    /**
+     */
+    suspendUserRaw(requestParameters: SuspendUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserObject>>;
+    /**
+     */
+    suspendUser(requestParameters: SuspendUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserObject>;
+    /**
+     */
+    updateProjectRaw(requestParameters: UpdateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectObject>>;
+    /**
+     */
+    updateProject(requestParameters: UpdateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectObject>;
+    /**
+     */
+    updateServiceRaw(requestParameters: UpdateServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateForteServiceResponse>>;
+    /**
+     */
+    updateService(requestParameters: UpdateServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateForteServiceResponse>;
+}
+/**
+ * @export
+ */
+export declare const GetServiceMetricsGranularityType: {
+    readonly ONE_MINUTE: "ONE_MINUTE";
+    readonly FIVE_MINUTES: "FIVE_MINUTES";
+    readonly FIFTEEN_MINUTES: "FIFTEEN_MINUTES";
+    readonly ONE_HOUR: "ONE_HOUR";
+};
+export type GetServiceMetricsGranularityType = typeof GetServiceMetricsGranularityType[keyof typeof GetServiceMetricsGranularityType];
+/**
+ * @export
+ */
+export declare const GetUserMetricsGranularityType: {
+    readonly ONE_MINUTE: "ONE_MINUTE";
+    readonly FIVE_MINUTES: "FIVE_MINUTES";
+    readonly FIFTEEN_MINUTES: "FIFTEEN_MINUTES";
+    readonly ONE_HOUR: "ONE_HOUR";
+};
+export type GetUserMetricsGranularityType = typeof GetUserMetricsGranularityType[keyof typeof GetUserMetricsGranularityType];
+/**
+ * @export
+ */
+export declare const ListUserActionLogsActionTypeType: {
+    readonly USER_CREATED: "USER_CREATED";
+    readonly USER_SUSPENDED: "USER_SUSPENDED";
+    readonly USER_DELETED: "USER_DELETED";
+    readonly CONTACT_METHOD_ADDED: "CONTACT_METHOD_ADDED";
+    readonly CONTACT_METHOD_REMOVED: "CONTACT_METHOD_REMOVED";
+    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";
+    readonly USER_LOGIN: "USER_LOGIN";
+    readonly USER_LOGOUT: "USER_LOGOUT";
+};
+export type ListUserActionLogsActionTypeType = typeof ListUserActionLogsActionTypeType[keyof typeof ListUserActionLogsActionTypeType];