@wingspan/users
v2.0.1
Published
<div align="left"> <a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a> <a href="https://github.com/
Downloads
8
Readme
@wingspan/users
SDK Installation
NPM
npm add @wingspan/users
Yarn
yarn add @wingspan/users
SDK Example Usage
Example
import { Users } from "@wingspan/users";
async function run() {
const sdk = new Users({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
const result = await sdk.userAndMemberManagement.getUsers();
// Handle the result
console.log(result);
}
run();
Available Resources and Operations
userAndMemberManagement
- getUsers - Health Check for User Service
- getUsersUserClientId - Retrieve Client Details by ID
- getUsersUserEmailEmail - Retrieve User by Email Address
- getUsersUserLocation - Retrieve User's Location
- getUsersUserMemberSubscriptionPaymentHistory - Retrieve payment history for membership
- getUsersUserMemberId - Retrieve Subscription Details by ID
- getUsersUserMemberIdAdvocate - Retrieve Advocate Information for the Specified Member
- getUsersUserOccupation - Retrieve User's Occupation Details
- getUsersUserPublicId - Retrieve Public User Profile by ID
- getUsersUserTagId - Retrieve User by Tag ID
- getUsersUserId - Fetch user profile details using user ID
- patchUsersUserClientId - Modify Existing Client Details by ID
- patchUsersUserMemberId - Modify Subscription Details for Member
- patchUsersUserId - Modify user account details using user ID
- postUsersPendingUser - Register a new user with pending status
- postUsersUser - Register a new user
- postUsersUserClientId - Register a New Client with Specific ID
- postUsersUserMemberId - Register a New Subscription for Member
- postUsersUserPasswordReset - Initiate User Password Reset Process
accountAndBankingOperations
- deleteUsersAccountId - Unlink Bank Account
- getUsersAccount - Retrieve All Linked Bank Accounts
- getUsersAccountId - Fetch Specific Bank Account Details
- patchUsersAccountId - Modify Bank Account Details
- postUsersAccount - Add New Bank Account
- postUsersAccountLink - Generate Plaid Link Token for Account Integration
- postUsersAccountRequirements - Fetch Necessary Account Details
- postUsersAccountAccountIdVerify - Verify an account for payments
- postUsersGuestAccountNumbers - Retrieve Account Numbers for Guests
activityAndUsageTracking
- deleteUsersActivityId - Remove Specific Activity Record for a Member
- getUsersActivity - Retrieve All Activities of a Member
- getUsersActivityId - Retrieve Specific Activity Details for a Member
- patchUsersActivityId - Modify Specific Activity Details for a Member
- postUsersActivity - Log New Activity for Member
sessionAndAuthentication
- deleteUsersSessionApiId - Terminate a Specific API Session
- deleteUsersSessionTokenId - Terminate a user session using token ID
- getUsersGrantedSubscriberSubscriptionGrant - Retrieve Subscription Grants for a Granted Subscriber
- getUsersSessionApi - Retrieve All API Sessions Created by the Current User
- getUsersSessionApiId - Fetch Details of a Specific API Session
- getUsersSessionTokenId - Retrieve session details using token ID
- patchUsersSessionApiId - Modify a Specific API Session
- patchUsersSessionOtp - Confirm OTP/2FA Verification
- patchUsersUserIdVerificationEmail - Confirm Email Verification Status
- patchUsersUserIdVerificationPhone - Validate Phone Verification Status
- postUsersAuthentication - Authenticate User Request
- postUsersPendingSession - Initiate a new session with pending status
- postUsersSession - Initiate a New User Session
- postUsersSessionApi - Create a New API Session
- postUsersSessionOtp - Initiate OTP/2FA Verification Process
- postUsersSessionRequestingUser - Request to Sign-In on Behalf of Another User
- postUsersSessionSingleSignOn - Create a Single Sign-On (SSO) Session
- postUsersSessionSocialAuthGoogle - Authenticate using Google
- postUsersUserIdVerificationEmail - Initiate Email Verification Process for User
- postUsersUserIdVerificationExistingEmail - Initiate verification for an existing email address
- postUsersUserIdVerificationPhone - Start Phone Verification Process for User
authorizationAndPermissions
- deleteUsersAuthorizationAuthorizationId - Revoke and Remove Authorization Record
- getUsersAuthorization - Retrieve All User Authorizations
- getUsersAuthorizationAccountsUserId - Retrieve Accounts Authorized by User
- getUsersAuthorizationAuthorizationId - Retrieve Authorization Details by ID
- getUsersAuthorizedScopeGroups - Obtain all authorized scope-groups
- getUsersAuthorizedScopeGroupsRequestingUserId - Retrieve authorized scope-groups specific to a user
- getUsersAuthorizedScopes - Retrieve all authorized scopes
- getUsersAuthorizedScopesRequestingUserId - Obtain authorized scopes specific to a user
- patchUsersAuthorizationAuthorizationId - Modify Existing Authorization Details
- postUsersAuthorization - Request User Authorization
- postUsersFlatfileAuthToken - Retrieve Authentication Token for Flatfile
organizationAccountManagement
- getUsersOrganizationUser - Retrieve All Organization User Accounts
- getUsersOrganizationUserUserId - Retrieve Organization User Profile
- getUsersOrganizationUserUserIdSession - Initiate Session for Organization User
- patchUsersOrganizationUserUserId - Modify Organization User Profile
- patchUsersOrganizationUserUserIdAssociate - Modify the Association of Child User to Parent Organization
- postUsersOrganizationUser - Register New User within Organization
- postUsersOrganizationUserUserIdAssociate - Link a Child User to a Parent Organization Account
subscriptionAndGrantsManagement
- deleteUsersSubscriptionGrantId - Terminate a specific subscription grant by ID
- deleteUsersUserMemberIdSubscription - Remove Subscription for Member
- getUsersSubscriptionGrant - Fetch All Subscription Grants
- getUsersSubscriptionGrantId - Retrieve subscription grant details by ID
- getUsersUserMemberIdSubscription - Retrieve Subscription Details by ID
- patchUsersSubscriptionGrantId - Modify subscription grant details
- patchUsersUserMemberIdSubscription - Modify Subscription Details for Member
- postUsersSubscriptionGrant - New Subscription Grant
- postUsersUserMemberIdSubscription - Register a New Subscription for Member
deprecated
- deleteUsersUserMemberSubscriptionId - DEPRECATEDdeleteSubscription
- getUsersUserMemberSubscriptionPaymentMethod - DEPRECATED Get Payment Method
- getUsersUserMemberSubscriptionPlan - DEPRECATEDlist membership plans
- getUsersUserMemberSubscriptionPlanId - DEPRECATEDget membership plan
- getUsersUserMemberSubscriptionId - DEPRECATEDgetSubscription
- patchUsersUserMemberSubscriptionPaymentMethod - DEPRECATED Update Payment Method
- patchUsersUserMemberSubscriptionId - DEPRECATEDupdateSubscription
- postUsersUserMemberSubscriptionPaymentMethod - DEPRECATED create Payment Method
subscriptionManagement
- deleteUsersUserMemberMemberIdNextgenSubscriptionId - Revoke a Nextgen Subscription for Member
- getUsersUserMemberMemberIdNextgenSubscription - Fetch All Nextgen Subscriptions for Member
- getUsersUserMemberMemberIdNextgenSubscriptionPlan - Browse Available Nextgen Subscription Plans
- getUsersUserMemberMemberIdNextgenSubscriptionPlanId - Retrieve Specific Nextgen Subscription Plan
- getUsersUserMemberMemberIdNextgenSubscriptionId - Retrieve Details of a Specific Nextgen Subscription
- patchUsersUserMemberMemberIdNextgenSubscriptionId - Modify an Existing Nextgen Subscription for Member
- postUsersUserMemberMemberIdNextgenSubscription - Initiate a New Nextgen Subscription for a Member
Error Handling
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
| Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | / |
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError
that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue
. Additionally, a pretty()
method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
import { Users } from "@wingspan/users";
import * as errors from "@wingspan/users/sdk/models/errors";
async function run() {
const sdk = new Users({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
let result;
try {
result = await sdk.userAndMemberManagement.getUsers();
} catch (err) {
switch (true) {
case err instanceof errors.SDKValidationError: {
// Validation errors can be pretty-printed
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
default: {
throw err;
}
}
}
// Handle the result
console.log(result);
}
run();
Server Selection
Select Server by Index
You can override the default server globally by passing a server index to the serverIdx
optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
| - | ------ | --------- |
| 0 | https://api.wingspan.app
| None |
| 1 | https://stagingapi.wingspan.app
| None |
import { Users } from "@wingspan/users";
async function run() {
const sdk = new Users({
serverIdx: 1,
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
const result = await sdk.userAndMemberManagement.getUsers();
// Handle the result
console.log(result);
}
run();
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the serverURL
optional parameter when initializing the SDK client instance. For example:
import { Users } from "@wingspan/users";
async function run() {
const sdk = new Users({
serverURL: "https://api.wingspan.app",
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
const result = await sdk.userAndMemberManagement.getUsers();
// Handle the result
console.log(result);
}
run();
Custom HTTP Client
The TypeScript SDK makes API calls using an HTTPClient
that wraps the native
Fetch API. This
client is a thin wrapper around fetch
and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient
constructor takes an optional fetcher
argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest"
hook to to add a
custom header and a timeout to requests and how to use the "requestError"
hook
to log errors:
import { Users } from "@wingspan/users";
import { HTTPClient } from "@wingspan/users/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000);
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new Users({ httpClient });
Requirements
For supported JavaScript runtimes, please consult RUNTIMES.md.
Authentication
Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
| ------------ | ------------ | ------------ |
| bearerAuth
| http | HTTP Bearer |
To authenticate with the API the bearerAuth
parameter must be set when initializing the SDK client instance. For example:
import { Users } from "@wingspan/users";
async function run() {
const sdk = new Users({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
const result = await sdk.userAndMemberManagement.getUsers();
// Handle the result
console.log(result);
}
run();
Development
Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
Contributions
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!