diff --git a/package.json b/package.json index 97e56fb..35c01ae 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "flagright", - "version": "1.4.2", + "version": "1.4.3", "private": false, "repository": "https://github.com/flagright/flagright-node", "main": "./index.js", diff --git a/src/api/resources/businessUserEvents/client/Client.ts b/src/api/resources/businessUserEvents/client/Client.ts index b31aa29..7e3ff0d 100644 --- a/src/api/resources/businessUserEvents/client/Client.ts +++ b/src/api/resources/businessUserEvents/client/Client.ts @@ -522,7 +522,7 @@ export class BusinessUserEvents { "x-api-key": await core.Supplier.get(this._options.apiKey), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "flagright", - "X-Fern-SDK-Version": "1.4.2", + "X-Fern-SDK-Version": "1.4.3", }, contentType: "application/json", queryParameters: _queryParams, diff --git a/src/api/resources/businessUsers/client/Client.ts b/src/api/resources/businessUsers/client/Client.ts index 14260a7..43088b2 100644 --- a/src/api/resources/businessUsers/client/Client.ts +++ b/src/api/resources/businessUsers/client/Client.ts @@ -33,7 +33,7 @@ export class BusinessUsers { * * ### Payload * - * Each consumer Business entity needs three mandatory fields: + * Each business user needs three mandatory fields: * * - `userId` - Unique identifier for the user * - `legalEntity` - Details of the business legal entity (CompanyGeneralDetails, FinancialDetails etc) - only `legalName`in `CompanyGeneralDetails` is mandatory @@ -301,7 +301,7 @@ export class BusinessUsers { "x-api-key": await core.Supplier.get(this._options.apiKey), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "flagright", - "X-Fern-SDK-Version": "1.4.2", + "X-Fern-SDK-Version": "1.4.3", }, contentType: "application/json", body: await serializers.Business.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }), @@ -374,7 +374,7 @@ export class BusinessUsers { "x-api-key": await core.Supplier.get(this._options.apiKey), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "flagright", - "X-Fern-SDK-Version": "1.4.2", + "X-Fern-SDK-Version": "1.4.3", }, contentType: "application/json", timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000, diff --git a/src/api/resources/consumerUserEvents/client/Client.ts b/src/api/resources/consumerUserEvents/client/Client.ts index 9757105..6ef39cc 100644 --- a/src/api/resources/consumerUserEvents/client/Client.ts +++ b/src/api/resources/consumerUserEvents/client/Client.ts @@ -188,7 +188,7 @@ export class ConsumerUserEvents { "x-api-key": await core.Supplier.get(this._options.apiKey), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "flagright", - "X-Fern-SDK-Version": "1.4.2", + "X-Fern-SDK-Version": "1.4.3", }, contentType: "application/json", queryParameters: _queryParams, diff --git a/src/api/resources/consumerUsers/client/Client.ts b/src/api/resources/consumerUsers/client/Client.ts index 67f1a82..3b25c4b 100644 --- a/src/api/resources/consumerUsers/client/Client.ts +++ b/src/api/resources/consumerUsers/client/Client.ts @@ -33,7 +33,7 @@ export class ConsumerUsers { * * ### Payload * - * Each consumer User entity needs three mandatory fields: + * Each consumer user needs two mandatory fields: * * - `userId` - Unique identifier for the user * - `createdTimestamp` - UNIX timestamp in _milliseconds_ for when the User is created in your system @@ -173,7 +173,7 @@ export class ConsumerUsers { "x-api-key": await core.Supplier.get(this._options.apiKey), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "flagright", - "X-Fern-SDK-Version": "1.4.2", + "X-Fern-SDK-Version": "1.4.3", }, contentType: "application/json", body: await serializers.User.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }), @@ -243,7 +243,7 @@ export class ConsumerUsers { "x-api-key": await core.Supplier.get(this._options.apiKey), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "flagright", - "X-Fern-SDK-Version": "1.4.2", + "X-Fern-SDK-Version": "1.4.3", }, contentType: "application/json", timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000, diff --git a/src/api/resources/transactionEvents/client/Client.ts b/src/api/resources/transactionEvents/client/Client.ts index 0dfa701..3bd1ca8 100644 --- a/src/api/resources/transactionEvents/client/Client.ts +++ b/src/api/resources/transactionEvents/client/Client.ts @@ -27,11 +27,11 @@ export class TransactionEvents { /** * ## POST Transaction Events * - * `/events/transaction` endpoint allows you to operate on the [Transaction Events entity.](https://docs.flagright.com/guides/overview/entities#transaction-event) + * `/events/transaction` endpoint allows you to operate on the [Transaction Events entity.](/guides/overview/entities#transaction-event) * * Transaction events are created after the initial `POST /transactions` call (which creates a transaction) and are used to: * - * - Update the STATE of the transaction, using the `transactionState` field and manage the [Transaction Lifecycle](https://docs.flagright.com/guides/overview/entities#transaction-lifecycle-through-transaction-events) + * - Update the STATE of the transaction, using the `transactionState` field and manage the [Transaction Lifecycle](/guides/overview/entities#transaction-lifecycle-through-transaction-events) * - Update the transaction details, using the `updatedTransactionAttributes` field. * * > If you have neither of the above two use cases, you do not need to use transaction events. @@ -126,7 +126,7 @@ export class TransactionEvents { "x-api-key": await core.Supplier.get(this._options.apiKey), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "flagright", - "X-Fern-SDK-Version": "1.4.2", + "X-Fern-SDK-Version": "1.4.3", }, contentType: "application/json", body: await serializers.TransactionEvent.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }), @@ -176,9 +176,9 @@ export class TransactionEvents { /** * ### GET Transaction Events * - * `/events/transaction` endpoint allows you to operate on the [Transaction Events entity.](https://docs.flagright.com/guides/overview/entities#transaction-event). + * `/events/transaction` endpoint allows you to operate on the [Transaction Events entity.](/guides/overview/entities#transaction-event). * - * You can retrieve any transaction event you create using the [POST Transaction Events](https://docs.flagright.com/api-reference/api-reference/transaction-events/create) call. + * You can retrieve any transaction event you create using the [POST Transaction Events](/api-reference/api-reference/transaction-events/create) call. * @throws {@link Flagright.UnauthorizedError} * @throws {@link Flagright.TooManyRequestsError} * @@ -199,7 +199,7 @@ export class TransactionEvents { "x-api-key": await core.Supplier.get(this._options.apiKey), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "flagright", - "X-Fern-SDK-Version": "1.4.2", + "X-Fern-SDK-Version": "1.4.3", }, contentType: "application/json", timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000, diff --git a/src/api/resources/transactions/client/Client.ts b/src/api/resources/transactions/client/Client.ts index e8dc0e4..b329098 100644 --- a/src/api/resources/transactions/client/Client.ts +++ b/src/api/resources/transactions/client/Client.ts @@ -27,20 +27,20 @@ export class Transactions { /** * ## POST Transactions * - * `/transactions` endpoint allows you to operate on the [Transaction entity.](https://docs.flagright.com/guides/overview/entities#transaction) + * `/transactions` endpoint allows you to operate on the [Transaction entity.](/guides/overview/entities#transaction) * - * In order to pass the payload of a transaction to Flagright and verify the transaciton, you will need to call this endpoint with the transaction payload. Not all fields are mandatory, you will only need to pass in the fields that you have and are relevant for your compliance setup. + * In order to pass the payload of a transaction to Flagright and verify the transaction, you will need to call this endpoint with the transaction payload. Not all fields are mandatory, you will only need to pass in the fields that you have and are relevant for your compliance setup. * * ### Payload * - * Here are some of the most used payload fields explained (you can find the full payload [schema below](https://docs.flagright.com/api-reference/api-reference/transactions/verify#request) with 1 line descriptions): + * Here are some of the most used payload fields explained (you can find the full payload [schema below](/api-reference/api-reference/transactions/verify#request) with 1 line descriptions): * * - `type`: Type of transaction (Ex: `WITHDRAWAL`, `DEPOSIT`, `TRANSFER` etc). * - `transactionId` - Unique Identifier for the transaction. Flagright API will generate a `transactionId` if this field is left empty * - `timestamp` - UNIX timestamp in _milliseconds_ of when the transaction took place - * - `transactionState` - The state of the transaction, set to `CREATED` by default. [More details here](https://docs.flagright.com/guides/overview/entities#transaction-lifecycle-through-transaction-events) - * - `originUserId` - Unique identifier (if any) of the user who is sending the money. This user must be created within the Flagright system before using the [create a consumer user](https://docs.flagright.com/api-reference/api-reference/consumer-users/create) or [create a business user](https://docs.flagright.com/api-reference/api-reference/business-users/create) endpoint - * - `destinationUserId` - Unique identifier (if any) of the user who is receiving the money. This user must be created within the Flagright system before using the [create a consumer user](https://docs.flagright.com/api-reference/api-reference/consumer-users/create) or [create a business user](https://docs.flagright.com/api-reference/api-reference/business-users/create) endpoint + * - `transactionState` - The state of the transaction, set to `CREATED` by default. [More details here](/guides/overview/entities#transaction-lifecycle-through-transaction-events) + * - `originUserId` - Unique identifier (if any) of the user who is sending the money. This user must be created within the Flagright system before using the [create a consumer user](/api-reference/api-reference/consumer-users/create) or [create a business user](/api-reference/api-reference/business-users/create) endpoint + * - `destinationUserId` - Unique identifier (if any) of the user who is receiving the money. This user must be created within the Flagright system before using the [create a consumer user](/api-reference/api-reference/consumer-users/create) or [create a business user](/api-reference/api-reference/business-users/create) endpoint * - `originAmountDetails` - Details of the amount being sent from the origin * - `destinationAmountDetails` - Details of the amount being received at the destination * - `originPaymentDetails` - Payment details (if any) used at the origin (ex: `CARD`, `IBAN`, `WALLET` etc). You can click on the dropdown next to the field in the schema below to view all supported payment types. @@ -130,7 +130,7 @@ export class Transactions { "x-api-key": await core.Supplier.get(this._options.apiKey), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "flagright", - "X-Fern-SDK-Version": "1.4.2", + "X-Fern-SDK-Version": "1.4.3", }, contentType: "application/json", queryParameters: _queryParams, @@ -183,7 +183,7 @@ export class Transactions { /** * ### GET Transactions * - * `/transactions` endpoint allows you to operate on the [Transaction entity](https://docs.flagright.com/guides/overview/entities#transaction). + * `/transactions` endpoint allows you to operate on the [Transaction entity](/guides/overview/entities#transaction). * * Calling `GET /transactions/{transactionId}` will return the entire transaction payload and rule execution results for the transaction with the corresponding `transactionId` * @throws {@link Flagright.UnauthorizedError} @@ -206,7 +206,7 @@ export class Transactions { "x-api-key": await core.Supplier.get(this._options.apiKey), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "flagright", - "X-Fern-SDK-Version": "1.4.2", + "X-Fern-SDK-Version": "1.4.3", }, contentType: "application/json", timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000, diff --git a/src/api/types/CompanyGeneralDetails.ts b/src/api/types/CompanyGeneralDetails.ts index 47b9732..63959cf 100644 --- a/src/api/types/CompanyGeneralDetails.ts +++ b/src/api/types/CompanyGeneralDetails.ts @@ -10,7 +10,7 @@ import * as Flagright from ".."; export interface CompanyGeneralDetails { /** Legal name of the company */ legalName: string; - /** The industry the business operates in for a business customer */ + /** The industry in which the business operates for a business customer */ businessIndustry?: string[]; /** The key products and services provided by the company */ mainProductsServicesSold?: string[]; diff --git a/src/api/types/CompanyRegistrationDetails.ts b/src/api/types/CompanyRegistrationDetails.ts index 1835e38..7f9b78f 100644 --- a/src/api/types/CompanyRegistrationDetails.ts +++ b/src/api/types/CompanyRegistrationDetails.ts @@ -13,7 +13,7 @@ export interface CompanyRegistrationDetails { registrationCountry: Flagright.CountryCode; /** Tax ID number of the registered entity */ taxIdentifier?: string; - /** Type of legal entity. Ex: Limited Liability */ + /** Type of legal entity, e.g., Limited Liability */ legalEntityType?: string; dateOfRegistration?: string; /** Additional information that can be added via tags */ diff --git a/yarn.lock b/yarn.lock index 0aa9c23..4444e6f 100644 --- a/yarn.lock +++ b/yarn.lock @@ -121,9 +121,9 @@ has-property-descriptors@^1.0.1: es-define-property "^1.0.0" has-proto@^1.0.1: - version "1.0.1" - resolved "https://registry.yarnpkg.com/has-proto/-/has-proto-1.0.1.tgz#1885c1305538958aff469fef37937c22795408e0" - integrity sha512-7qE+iP+O+bgF9clE5+UoBFzE65mlBiVj3tKCrlNQ0Ogwm0BjpT/gK4SlLYDMybDh5I3TCTKnPPa0oMG7JDYrhg== + version "1.0.3" + resolved "https://registry.yarnpkg.com/has-proto/-/has-proto-1.0.3.tgz#b31ddfe9b0e6e9914536a6ab286426d0214f77fd" + integrity sha512-SJ1amZAJUiZS+PhsVLf5tGydlaVB8EdFpaSO4gmiUKUOxk8qzn5AIy4ZeJUmh22znIdk/uMAUT2pl3FxzVUH+Q== has-symbols@^1.0.3: version "1.0.3"