Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@fullstory/server-api-client

Package Overview
Dependencies
Maintainers
2
Versions
10
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@fullstory/server-api-client - npm Package Compare versions

Comparing version 1.0.0-beta.3 to 1.0.0-beta.4

lib/model/events/BatchCreateEventsResponse.d.ts
lib/model/events/BatchCreateEventsResponse.js
lib/model/events/BatchCreateEventsResponse.js.map
lib/utils/__test__/integrationSrc.test.d.ts
lib/utils/__test__/integrationSrc.test.js
lib/utils/__test__/integrationSrc.test.js.map
lib/utils/integrationSrc.d.ts
lib/utils/integrationSrc.js
lib/utils/integrationSrc.js.map

11

CHANGELOG.md
# Changelog
## 1.0.0-beta.4
- [#38](https://github.com/fullstorydev/fullstory-node-sdk/pull/38)
- Developer enhancements: allowing APIs to point to a different environment for development and testing.
- [#39](https://github.com/fullstorydev/fullstory-node-sdk/pull/39)
- Pass `integration_src` to server APIs
- [#40](https://github.com/fullstorydev/fullstory-node-sdk/pull/40)
- Update server API interface: create user, update user, and create event APIs will return response bodies with `id`s only.
## 1.0.0-beta.3

@@ -4,0 +15,0 @@

10

lib/api/events/EventsApi.d.ts

@@ -1,14 +0,14 @@

import { CreateEventsResponse, CreateEventsRequest } from '../../model/index';
import { CreateEventsRequest } from '../../model/index';
import { FSRequestOptions, FSResponse, FullStoryOptions } from '../../http';
export declare class EventsApi {
protected readonly basePath = "https://api.fullstory.com";
readonly defaultBasePath = "https://api.fullstory.com";
private basePath;
private httpClient;
constructor(opts: FullStoryOptions);
/**
* Creates one event with the specified details.
* Creates one event with the specified details. This request can be [made idempotent](../../idempotent-requests).
* @summary Create Events
* @param body
* @param includeSchema Whether to include the schema in the response.
*/
createEvents(body: CreateEventsRequest, includeSchema?: boolean, options?: FSRequestOptions): Promise<FSResponse<CreateEventsResponse>>;
createEvents(body: CreateEventsRequest, options?: FSRequestOptions): Promise<FSResponse<void>>;
}

20

lib/api/events/EventsApi.js

@@ -19,13 +19,17 @@ "use strict";

constructor(opts) {
this.basePath = 'https://api.fullstory.com';
this.defaultBasePath = 'https://api.fullstory.com';
this.basePath = this.defaultBasePath;
// TODO(sabrina): allow injecting http client dependency rather than instantiating here
this.httpClient = new http_1.FSHttpClient(opts);
this.httpClient = new http_1.FSHttpClientImpl(opts);
// allow pointing to a different host for dev or tests
if (process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'test') {
this.basePath = process.env.FS_API_HOST || this.defaultBasePath;
}
}
/**
* Creates one event with the specified details.
* Creates one event with the specified details. This request can be [made idempotent](../../idempotent-requests).
* @summary Create Events
* @param body
* @param includeSchema Whether to include the schema in the response.
*/
createEvents(body, includeSchema, options) {
createEvents(body, options) {
return __awaiter(this, void 0, void 0, function* () {

@@ -36,5 +40,2 @@ const apiPath = `${this.basePath}/v2beta/events`;

const headerParams = {};
if (includeSchema !== undefined) {
queryParams.set('include_schema', String(includeSchema));
}
const consumes = ['application/json'];

@@ -53,2 +54,5 @@ // prefer 'application/json' if supported

hostname: url.hostname,
host: url.host,
port: url.port,
protocol: url.protocol,
path: url.pathname + (queryStr ? '?' + queryStr : ''),

@@ -55,0 +59,0 @@ };

5

lib/api/events/EventsBatchImportApi.d.ts
import { JobStatusResponse, GetBatchEventsImportErrorsResponse, CreateBatchEventsImportJobRequest, GetBatchEventsImportsResponse, CreateBatchEventsImportJobResponse } from '../../model/index';
import { FSRequestOptions, FSResponse, FullStoryOptions } from '../../http';
export declare class EventsBatchImportApi {
protected readonly basePath = "https://api.fullstory.com";
readonly defaultBasePath = "https://api.fullstory.com";
private basePath;
private httpClient;
constructor(opts: FullStoryOptions);
/**
* Creates a batch events import job with the given list of event information. The maximum number of request objects that can be included in a single batch request is `50,000`.
* Creates a batch events import job with the given list of event information. The maximum number of request objects that can be included in a single batch request is `50,000`. This request can be [made idempotent](../../idempotent-requests).
* @summary Create Events Batch Import

@@ -10,0 +11,0 @@ * @param body The request payloads contains the list of events to be imported

23

lib/api/events/EventsBatchImportApi.js

@@ -19,8 +19,13 @@ "use strict";

constructor(opts) {
this.basePath = 'https://api.fullstory.com';
this.defaultBasePath = 'https://api.fullstory.com';
this.basePath = this.defaultBasePath;
// TODO(sabrina): allow injecting http client dependency rather than instantiating here
this.httpClient = new http_1.FSHttpClient(opts);
this.httpClient = new http_1.FSHttpClientImpl(opts);
// allow pointing to a different host for dev or tests
if (process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'test') {
this.basePath = process.env.FS_API_HOST || this.defaultBasePath;
}
}
/**
* Creates a batch events import job with the given list of event information. The maximum number of request objects that can be included in a single batch request is `50,000`.
* Creates a batch events import job with the given list of event information. The maximum number of request objects that can be included in a single batch request is `50,000`. This request can be [made idempotent](../../idempotent-requests).
* @summary Create Events Batch Import

@@ -48,2 +53,5 @@ * @param body The request payloads contains the list of events to be imported

hostname: url.hostname,
host: url.host,
port: url.port,
protocol: url.protocol,
path: url.pathname + (queryStr ? '?' + queryStr : ''),

@@ -82,2 +90,5 @@ };

hostname: url.hostname,
host: url.host,
port: url.port,
protocol: url.protocol,
path: url.pathname + (queryStr ? '?' + queryStr : ''),

@@ -112,2 +123,5 @@ };

hostname: url.hostname,
host: url.host,
port: url.port,
protocol: url.protocol,
path: url.pathname + (queryStr ? '?' + queryStr : ''),

@@ -150,2 +164,5 @@ };

hostname: url.hostname,
host: url.host,
port: url.port,
protocol: url.protocol,
path: url.pathname + (queryStr ? '?' + queryStr : ''),

@@ -152,0 +169,0 @@ };

11

lib/api/users/UsersApi.d.ts
import { GetUserResponse, ListUsersResponse, CreateUserResponse, UpdateUserResponse, CreateUserRequest, UpdateUserRequest } from '../../model/index';
import { FSRequestOptions, FSResponse, FullStoryOptions } from '../../http';
export declare class UsersApi {
protected readonly basePath = "https://api.fullstory.com";
readonly defaultBasePath = "https://api.fullstory.com";
private basePath;
private httpClient;
constructor(opts: FullStoryOptions);
/**
* Creates a user with the specified details
* Creates a user with the specified details. This request can be [made idempotent](../../idempotent-requests).
* @summary Create User
* @param body
* @param includeSchema Whether to include the schema in the response.
*/
createUser(body: CreateUserRequest, includeSchema?: boolean, options?: FSRequestOptions): Promise<FSResponse<CreateUserResponse>>;
createUser(body: CreateUserRequest, options?: FSRequestOptions): Promise<FSResponse<CreateUserResponse>>;
/**

@@ -49,5 +49,4 @@ * Delete a single user by FullStory generated user ID.

* @param body
* @param includeSchema Whether to include the schema in the response.
*/
updateUser(id: string, body: UpdateUserRequest, includeSchema?: boolean, options?: FSRequestOptions): Promise<FSResponse<UpdateUserResponse>>;
updateUser(id: string, body: UpdateUserRequest, options?: FSRequestOptions): Promise<FSResponse<UpdateUserResponse>>;
}

41

lib/api/users/UsersApi.js

@@ -19,13 +19,17 @@ "use strict";

constructor(opts) {
this.basePath = 'https://api.fullstory.com';
this.defaultBasePath = 'https://api.fullstory.com';
this.basePath = this.defaultBasePath;
// TODO(sabrina): allow injecting http client dependency rather than instantiating here
this.httpClient = new http_1.FSHttpClient(opts);
this.httpClient = new http_1.FSHttpClientImpl(opts);
// allow pointing to a different host for dev or tests
if (process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'test') {
this.basePath = process.env.FS_API_HOST || this.defaultBasePath;
}
}
/**
* Creates a user with the specified details
* Creates a user with the specified details. This request can be [made idempotent](../../idempotent-requests).
* @summary Create User
* @param body
* @param includeSchema Whether to include the schema in the response.
*/
createUser(body, includeSchema, options) {
createUser(body, options) {
return __awaiter(this, void 0, void 0, function* () {

@@ -36,5 +40,2 @@ const apiPath = `${this.basePath}/v2beta/users`;

const headerParams = {};
if (includeSchema !== undefined) {
queryParams.set('include_schema', String(includeSchema));
}
const consumes = ['application/json'];

@@ -53,2 +54,5 @@ // prefer 'application/json' if supported

hostname: url.hostname,
host: url.host,
port: url.port,
protocol: url.protocol,
path: url.pathname + (queryStr ? '?' + queryStr : ''),

@@ -83,2 +87,5 @@ };

hostname: url.hostname,
host: url.host,
port: url.port,
protocol: url.protocol,
path: url.pathname + (queryStr ? '?' + queryStr : ''),

@@ -115,2 +122,5 @@ };

hostname: url.hostname,
host: url.host,
port: url.port,
protocol: url.protocol,
path: url.pathname + (queryStr ? '?' + queryStr : ''),

@@ -149,2 +159,5 @@ };

hostname: url.hostname,
host: url.host,
port: url.port,
protocol: url.protocol,
path: url.pathname + (queryStr ? '?' + queryStr : ''),

@@ -201,2 +214,5 @@ };

hostname: url.hostname,
host: url.host,
port: url.port,
protocol: url.protocol,
path: url.pathname + (queryStr ? '?' + queryStr : ''),

@@ -219,5 +235,4 @@ };

* @param body
* @param includeSchema Whether to include the schema in the response.
*/
updateUser(id, body, includeSchema, options) {
updateUser(id, body, options) {
return __awaiter(this, void 0, void 0, function* () {

@@ -229,5 +244,2 @@ const apiPath = `${this.basePath}/v2beta/users/{id}`

const headerParams = {};
if (includeSchema !== undefined) {
queryParams.set('include_schema', String(includeSchema));
}
const consumes = ['application/json'];

@@ -246,2 +258,5 @@ // prefer 'application/json' if supported

hostname: url.hostname,
host: url.host,
port: url.port,
protocol: url.protocol,
path: url.pathname + (queryStr ? '?' + queryStr : ''),

@@ -248,0 +263,0 @@ };

5

lib/api/users/UsersBatchImportApi.d.ts
import { JobStatusResponse, CreateBatchUserImportJobRequest, GetBatchUserImportsResponse, GetBatchUserImportErrorsResponse, CreateBatchUserImportJobResponse } from '../../model/index';
import { FSRequestOptions, FSResponse, FullStoryOptions } from '../../http';
export declare class UsersBatchImportApi {
protected readonly basePath = "https://api.fullstory.com";
readonly defaultBasePath = "https://api.fullstory.com";
private basePath;
private httpClient;
constructor(opts: FullStoryOptions);
/**
* Creates a batch user import job with the given list of users\' information. Users are upserted (created if they do not exist or updated if they do exist). ### Payload Limits The number of request objects that can be included in a single batch request is `50,000`.
* Creates a batch user import job with the given list of users\' information. Users are upserted (created if they do not exist or updated if they do exist). ### Payload Limits The number of request objects that can be included in a single batch request is `50,000`. This request can be [made idempotent](../../idempotent-requests).
* @summary Create Batch Import

@@ -10,0 +11,0 @@ * @param body

23

lib/api/users/UsersBatchImportApi.js

@@ -19,8 +19,13 @@ "use strict";

constructor(opts) {
this.basePath = 'https://api.fullstory.com';
this.defaultBasePath = 'https://api.fullstory.com';
this.basePath = this.defaultBasePath;
// TODO(sabrina): allow injecting http client dependency rather than instantiating here
this.httpClient = new http_1.FSHttpClient(opts);
this.httpClient = new http_1.FSHttpClientImpl(opts);
// allow pointing to a different host for dev or tests
if (process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'test') {
this.basePath = process.env.FS_API_HOST || this.defaultBasePath;
}
}
/**
* Creates a batch user import job with the given list of users\' information. Users are upserted (created if they do not exist or updated if they do exist). ### Payload Limits The number of request objects that can be included in a single batch request is `50,000`.
* Creates a batch user import job with the given list of users\' information. Users are upserted (created if they do not exist or updated if they do exist). ### Payload Limits The number of request objects that can be included in a single batch request is `50,000`. This request can be [made idempotent](../../idempotent-requests).
* @summary Create Batch Import

@@ -48,2 +53,5 @@ * @param body

hostname: url.hostname,
host: url.host,
port: url.port,
protocol: url.protocol,
path: url.pathname + (queryStr ? '?' + queryStr : ''),

@@ -82,2 +90,5 @@ };

hostname: url.hostname,
host: url.host,
port: url.port,
protocol: url.protocol,
path: url.pathname + (queryStr ? '?' + queryStr : ''),

@@ -112,2 +123,5 @@ };

hostname: url.hostname,
host: url.host,
port: url.port,
protocol: url.protocol,
path: url.pathname + (queryStr ? '?' + queryStr : ''),

@@ -150,2 +164,5 @@ };

hostname: url.hostname,
host: url.host,
port: url.port,
protocol: url.protocol,
path: url.pathname + (queryStr ? '?' + queryStr : ''),

@@ -152,0 +169,0 @@ };

10

lib/events.d.ts
import { EventsApi as FSEventsApi } from './api/index';
import { CreateBatchEventsImportJobRequest, CreateBatchEventsImportJobResponse, CreateEventsRequest, CreateEventsResponse, FailedEventsImport, GetBatchEventsImportErrorsResponse, GetBatchEventsImportsResponse, JobStatusResponse } from './model/index';
import { BatchCreateEventsResponse, CreateBatchEventsImportJobRequest, CreateBatchEventsImportJobResponse, CreateEventsRequest, FailedEventsImport, GetBatchEventsImportErrorsResponse, GetBatchEventsImportsResponse, JobStatusResponse } from './model/index';
import { BatchJob, BatchJobOptions, IBatchJob, IBatchRequester } from './batch';

@@ -9,3 +9,3 @@ import { FSRequestOptions, FSResponse, FullStoryOptions } from './http';

export interface IEventsApi {
create(...req: Parameters<typeof FSEventsApi.prototype.createEvents>): Promise<FSResponse<CreateEventsResponse>>;
create(...req: Parameters<typeof FSEventsApi.prototype.createEvents>): Promise<FSResponse<void>>;
}

@@ -21,3 +21,3 @@ /**

*/
export type IBatchEventsJob = IBatchJob<CreateEventsRequest, CreateEventsResponse, FailedEventsImport>;
export type IBatchEventsJob = IBatchJob<CreateEventsRequest, BatchCreateEventsResponse, FailedEventsImport>;
/**

@@ -27,3 +27,3 @@ * @interface IEvents - create or batch import events.

export type IEvents = IBatchEventsApi & IEventsApi;
declare class BatchEventsJob extends BatchJob<CreateEventsRequest, CreateBatchEventsImportJobResponse, JobStatusResponse, CreateEventsResponse, FailedEventsImport> {
declare class BatchEventsJob extends BatchJob<CreateEventsRequest, CreateBatchEventsImportJobResponse, JobStatusResponse, BatchCreateEventsResponse, FailedEventsImport> {
constructor(fsOpts: FullStoryOptions, requests?: CreateEventsRequest[], opts?: BatchJobOptions);

@@ -36,5 +36,5 @@ }

constructor(opts: FullStoryOptions);
create(body: CreateEventsRequest, includeSchema?: boolean, options?: FSRequestOptions | undefined): Promise<FSResponse<CreateEventsResponse>>;
create(body: CreateEventsRequest, options?: FSRequestOptions | undefined): Promise<FSResponse<void>>;
batchCreate(requests?: CreateEventsRequest[] | undefined, jobOptions?: BatchJobOptions | undefined): BatchEventsJob;
}
export {};

10

lib/events.js

@@ -15,2 +15,3 @@ "use strict";

const batch_1 = require("./batch");
const integrationSrc_1 = require("./utils/integrationSrc");
class BatchEventsJob extends batch_1.BatchJob {

@@ -23,2 +24,3 @@ constructor(fsOpts, requests = [], opts = {}) {

constructor(fsOpts) {
this.fsOpts = fsOpts;
this.batchEventsImpl = new index_1.EventsBatchImportApi(fsOpts);

@@ -29,2 +31,5 @@ }

return __awaiter(this, void 0, void 0, function* () {
for (const req of requests.requests) {
req.context = (0, integrationSrc_1.maybeAddIntegrationSrc)(req.context, this.fsOpts.integration_src);
}
const rsp = yield this.batchEventsImpl.createBatchEventsImportJob(requests);

@@ -78,5 +83,6 @@ // make sure job metadata exist

}
create(body, includeSchema, options) {
create(body, options) {
return __awaiter(this, void 0, void 0, function* () {
return this.eventsImpl.createEvents(body, includeSchema, options);
body.context = (0, integrationSrc_1.maybeAddIntegrationSrc)(body.context, options === null || options === void 0 ? void 0 : options.integration_src);
return this.eventsImpl.createEvents(body, options);
});

@@ -83,0 +89,0 @@ }

4

lib/http/index.d.ts

@@ -14,6 +14,6 @@ /// <reference types="node" />

}
export interface IFSHttpClient {
export interface FSHttpClient {
request: <REQ, RSP>(opts: RequestOptions, body?: REQ, fsReq?: FSRequestOptions) => Promise<FSResponse<RSP>>;
}
export declare class FSHttpClient implements IFSHttpClient {
export declare class FSHttpClientImpl implements FSHttpClient {
private opts;

@@ -20,0 +20,0 @@ constructor(opts: FullStoryOptions);

20

lib/http/index.js

@@ -38,9 +38,11 @@ "use strict";

Object.defineProperty(exports, "__esModule", { value: true });
exports.FSHttpClient = void 0;
exports.FSHttpClientImpl = void 0;
__exportStar(require("./options"), exports);
const http = __importStar(require("node:http"));
const https = __importStar(require("node:https"));
const errors_1 = require("../errors");
const defaultHttpsAgent = new https.Agent({ keepAlive: true });
const defaultHttpAgent = new http.Agent({ keepAlive: true });
// TODO(sabrina): separate out the error handling stuff out from the http client
class FSHttpClient {
class FSHttpClientImpl {
// TODO(sabrina): allow passing in a node https agent?

@@ -53,4 +55,11 @@ constructor(opts) {

// TODO(sabrina): add fsReq.integration_src to the request
let connectionEvent = 'secureConnect';
if (!opts.agent) {
opts.agent = defaultHttpsAgent;
if (opts.protocol === 'http:') {
connectionEvent = 'connect';
opts.agent = defaultHttpAgent;
}
else {
opts.agent = defaultHttpsAgent;
}
}

@@ -61,4 +70,3 @@ const req = https.request(opts);

if (socket.connecting) {
socket.once('secureConnect', //always use https
() => {
socket.once(connectionEvent, () => {
body && req.write(JSON.stringify(body));

@@ -138,3 +146,3 @@ req.end();

}
exports.FSHttpClient = FSHttpClient;
exports.FSHttpClientImpl = FSHttpClientImpl;
//# sourceMappingURL=index.js.map

2

lib/model/events.index.d.ts

@@ -5,2 +5,3 @@ /**

*/
export * from './events/BatchCreateEventsResponse';
export * from './events/BrowserContext';

@@ -11,3 +12,2 @@ export * from './events/Context';

export * from './events/CreateEventsRequest';
export * from './events/CreateEventsResponse';
export * from './events/DeviceContext';

@@ -14,0 +14,0 @@ export * from './apierror/ErrorResponse';

2

lib/model/events.index.js

@@ -23,2 +23,3 @@ "use strict";

*/
__exportStar(require("./events/BatchCreateEventsResponse"), exports);
__exportStar(require("./events/BrowserContext"), exports);

@@ -29,3 +30,2 @@ __exportStar(require("./events/Context"), exports);

__exportStar(require("./events/CreateEventsRequest"), exports);
__exportStar(require("./events/CreateEventsResponse"), exports);
__exportStar(require("./events/DeviceContext"), exports);

@@ -32,0 +32,0 @@ __exportStar(require("./apierror/ErrorResponse"), exports);

3

lib/model/events/Context.d.ts

@@ -15,5 +15,2 @@ /**

'integration'?: string;
'custom_annotations'?: {
[key: string]: string;
};
'browser'?: BrowserContext;

@@ -20,0 +17,0 @@ 'mobile'?: MobileContext;

2

lib/model/events/CreateEventsRequest.d.ts

@@ -11,3 +11,3 @@ /**

/**
* @interface CreateEventsRequest The request payload for events to be created
* @interface CreateEventsRequest
*/

@@ -14,0 +14,0 @@ export interface CreateEventsRequest {

4

lib/model/events/GetBatchEventsImportsResponse.d.ts

@@ -6,3 +6,3 @@ /**

*/
import { CreateEventsResponse } from '../events/CreateEventsResponse';
import { BatchCreateEventsResponse } from '../events/BatchCreateEventsResponse';
/**

@@ -15,3 +15,3 @@ * @interface GetBatchEventsImportsResponse Server response for retrieving batch events imported

*/
'results'?: Array<CreateEventsResponse>;
'results'?: Array<BatchCreateEventsResponse>;
/**

@@ -18,0 +18,0 @@ * Total number of records in this batch import

30

lib/model/users/CreateUserResponse.d.ts

@@ -6,5 +6,4 @@ /**

*/
import { Schema } from '../varsapi/Schema';
/**
* @interface CreateUserResponse Request payload for creating a user
* @interface CreateUserResponse Server response for creating a user
*/

@@ -16,29 +15,2 @@ export interface CreateUserResponse {

'id': string;
/**
* The application-specific ID you've given to the user
*/
'uid'?: string;
/**
* The nice-looking name for this user
*/
'display_name'?: string;
/**
* The email address associated with this user
*/
'email'?: string;
/**
* Properties that provide additional information about your user.
*- Up to 500 unique properties are allowed.
*- Property names must be a sequence of alphanumeric characters A-Z, a-z, or 0-9 and underscores ("_").
*- Property names must start with an alphabetic character (A-Z or a-z).
*- The maximum property name length is 512 characters.
*- Property values may also contain nested objects. Properties within nested objects must still conform to the naming requirements. For nested objects, the property name including the dotted concatenation of all its parent properties must still be under the length limit of 512 characters.
*- Property values have a maximum size of 8192 bytes. If the value for the property is larger than this limit, the property will be rejected.
*/
'properties'?: object;
'schema'?: Schema;
/**
* Any fields that are associated with multiple types.
*/
'type_conflicts'?: object;
}

28

lib/model/users/UpdateUserResponse.d.ts

@@ -6,3 +6,2 @@ /**

*/
import { Schema } from '../varsapi/Schema';
/**

@@ -16,29 +15,2 @@ * @interface UpdateUserResponse Server response payload for updating a user

'id': string;
/**
* The application-specific ID you've given to the user
*/
'uid'?: string;
/**
* The nice-looking name for this user
*/
'display_name'?: string;
/**
* The email address associated with this user
*/
'email'?: string;
/**
* Properties that provide additional information about your user.
*- Up to 500 unique properties are allowed.
*- Property names must be a sequence of alphanumeric characters A-Z, a-z, or 0-9 and underscores ("_").
*- Property names must start with an alphabetic character (A-Z or a-z).
*- The maximum property name length is 512 characters.
*- Property values may also contain nested objects. Properties within nested objects must still conform to the naming requirements. For nested objects, the property name including the dotted concatenation of all its parent properties must still be under the length limit of 512 characters.
*- Property values have a maximum size of 8192 bytes. If the value for the property is larger than this limit, the property will be rejected.
*/
'properties'?: object;
'schema'?: Schema;
/**
* Any fields that are associated with multiple types.
*/
'type_conflicts'?: object;
}

4

lib/users.d.ts

@@ -38,8 +38,8 @@ import { UsersApi as FSUsersApi } from './api/index';

get(id: string, includeSchema?: boolean, options?: FSRequestOptions | undefined): Promise<FSResponse<GetUserResponse>>;
create(body: CreateUserRequest, includeSchema?: boolean, options?: FSRequestOptions | undefined): Promise<FSResponse<CreateUserResponse>>;
create(body: CreateUserRequest, options?: FSRequestOptions | undefined): Promise<FSResponse<CreateUserResponse>>;
list(uid?: string | undefined, email?: string | undefined, displayName?: string | undefined, isIdentified?: boolean | undefined, pageToken?: string | undefined, includeSchema?: boolean, options?: FSRequestOptions | undefined): Promise<FSResponse<ListUsersResponse>>;
delete(id?: string, uid?: string, options?: FSRequestOptions | undefined): Promise<FSResponse<void>>;
update(id: string, body: UpdateUserRequest, includeSchema?: boolean, options?: FSRequestOptions | undefined): Promise<FSResponse<UpdateUserResponse>>;
update(id: string, body: UpdateUserRequest, options?: FSRequestOptions | undefined): Promise<FSResponse<UpdateUserResponse>>;
batchCreate(requests?: BatchUserImportRequest[], jobOptions?: BatchJobOptions): BatchUsersJob;
}
export {};

8

lib/users.js

@@ -82,5 +82,5 @@ "use strict";

}
create(body, includeSchema, options) {
create(body, options) {
return __awaiter(this, void 0, void 0, function* () {
return this.usersImpl.createUser(body, includeSchema, options);
return this.usersImpl.createUser(body, options);
});

@@ -104,5 +104,5 @@ }

}
update(id, body, includeSchema, options) {
update(id, body, options) {
return __awaiter(this, void 0, void 0, function* () {
return this.usersImpl.updateUser(id, body, includeSchema, options);
return this.usersImpl.updateUser(id, body, options);
});

@@ -109,0 +109,0 @@ }

2

package.json
{
"name": "@fullstory/server-api-client",
"version": "1.0.0-beta.3",
"version": "1.0.0-beta.4",
"description": "The official FullStory server API client SDK for NodeJS.",

@@ -5,0 +5,0 @@ "main": "lib/index.js",

83

README.md

@@ -98,3 +98,3 @@ # FullStory NodeJS Client SDK

- [Create events](https://developer.fullstory.com/server/v2/events/create-events/)
- [Create a event](https://developer.fullstory.com/server/v2/events/create-events/)

@@ -123,17 +123,10 @@ ```ts

},
events: [
{
name: 'Support Ticket',
timestamp: '2022-03-15T14:23:23Z',
properties: {
id: 424242,
priority: 'Normal',
source: 'Email',
title: 'Account locked out',
},
},
{
name: "Another Event",
}
]
name: 'Support Ticket',
timestamp: '2022-03-15T14:23:23Z',
properties: {
id: 424242,
priority: 'Normal',
source: 'Email',
title: 'Account locked out',
},
});

@@ -195,38 +188,9 @@ ```

},
events: [
{
name: 'Support Ticket',
timestamp: '2022-03-15T14:23:23Z',
properties: {
source: 'Email',
title: 'Account locked out',
},
},
{
name: "Another Event",
},
{
name: "More Events",
}
]
name: 'Support Ticket',
timestamp: '2022-03-15T14:23:23Z',
properties: {
source: 'Email',
title: 'Account locked out',
},
},
{
user: {
id: '000000',
},
session: {
use_most_recent: true,
},
events: [
{
name: 'Events - 1',
},
{
name: "Events - 2",
},
{
name: "Events - 3",
}
]
}
];

@@ -243,8 +207,12 @@

},
events: [
name: 'Events - 1',
timestamp: '2022-03-15T14:23:23Z',
},
{
name: 'Events - 1',
},
]
}
user: {
id: '100000',
},
name: 'Events - 2',
timestamp: '2022-03-15T14:23:23Z',
},
]);

@@ -343,2 +311,5 @@ ```

switch (err.name) {
case FSErrorName.ERROR_INVALID_ARGUMENT:
console.log('An argument provided to the SDK is invalid.');
break;
case FSErrorName.ERROR_RATE_LIMITED:

@@ -345,0 +316,0 @@ console.log('FullStory server API returned HTTP 429 Too Many Requests.');

lib/model/events/CreateEventsResponse.d.ts
lib/model/events/CreateEventsResponse.js
lib/model/events/CreateEventsResponse.js.map
lib/api/events/EventsApi.js.map

Sorry, the diff of this file is not supported yet

lib/api/events/EventsBatchImportApi.js.map

Sorry, the diff of this file is not supported yet

lib/api/users/UsersApi.js.map

Sorry, the diff of this file is not supported yet

lib/api/users/UsersBatchImportApi.js.map

Sorry, the diff of this file is not supported yet

lib/events.js.map

Sorry, the diff of this file is not supported yet

lib/http/index.js.map

Sorry, the diff of this file is not supported yet

lib/model/events.index.js.map

Sorry, the diff of this file is not supported yet

lib/users.js.map

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc