Release 1.3.4

flagright · Jan 31, 2024 · 24941c3 · 24941c3
1 parent 549d28b
commit 24941c3
Show file tree

Hide file tree

Showing 33 changed files with 3,160 additions and 24 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "flagright",
-    "version": "1.3.3",
+    "version": "1.3.4",
     "private": false,
     "repository": "https://github.com/flagright/flagright-node",
     "main": "./index.js",

diff --git a/src/api/errors/ForbiddenError.ts b/src/api/errors/ForbiddenError.ts
@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as errors from "../../errors";
+
+export class ForbiddenError extends errors.FlagrightError {
+    constructor(body?: unknown) {
+        super({
+            message: "ForbiddenError",
+            statusCode: 403,
+            body: body,
+        });
+        Object.setPrototypeOf(this, ForbiddenError.prototype);
+    }
+}
diff --git a/src/api/errors/index.ts b/src/api/errors/index.ts
@@ -1,3 +1,4 @@
 export * from "./BadRequestError";
 export * from "./UnauthorizedError";
+export * from "./ForbiddenError";
 export * from "./TooManyRequestsError";
diff --git a/src/api/resources/businessUserEvents/client/Client.ts b/src/api/resources/businessUserEvents/client/Client.ts
diff --git a/src/api/resources/businessUserEvents/client/requests/BusinessUserEvent.ts b/src/api/resources/businessUserEvents/client/requests/BusinessUserEvent.ts
diff --git a/src/api/resources/businessUsers/client/Client.ts b/src/api/resources/businessUsers/client/Client.ts
diff --git a/src/api/resources/consumerUserEvents/client/Client.ts b/src/api/resources/consumerUserEvents/client/Client.ts
diff --git a/src/api/resources/consumerUserEvents/client/requests/ConsumerUserEvent.ts b/src/api/resources/consumerUserEvents/client/requests/ConsumerUserEvent.ts
diff --git a/src/api/resources/consumerUsers/client/Client.ts b/src/api/resources/consumerUsers/client/Client.ts
diff --git a/src/api/resources/transactionEvents/client/Client.ts b/src/api/resources/transactionEvents/client/Client.ts
@@ -48,6 +48,41 @@ export class TransactionEvents {
      * @throws {@link Flagright.BadRequestError}
      * @throws {@link Flagright.UnauthorizedError}
      * @throws {@link Flagright.TooManyRequestsError}
+     *
+     * @example
+     *     await flagright.transactionEvents.create({
+     *         transactionState: Flagright.TransactionState.Successful,
+     *         timestamp: 1431231244001,
+     *         transactionId: "443dea26147a406b957d9ee3a1247b11",
+     *         eventId: "aaeeb166147a406b957dd9147a406b957",
+     *         eventDescription: "Transaction created",
+     *         updatedTransactionAttributes: {
+     *             transactionState: Flagright.TransactionState.Created,
+     *             originAmountDetails: {
+     *                 transactionAmount: 1.1,
+     *                 transactionCurrency: Flagright.CurrencyCode.OneInch,
+     *                 country: Flagright.CountryCode.Af
+     *             },
+     *             destinationAmountDetails: {
+     *                 transactionAmount: 1.1,
+     *                 transactionCurrency: Flagright.CurrencyCode.OneInch,
+     *                 country: Flagright.CountryCode.Af
+     *             },
+     *             originDeviceData: {},
+     *             destinationDeviceData: {},
+     *             tags: [{
+     *                     key: "string",
+     *                     value: "string"
+     *                 }]
+     *         },
+     *         metaData: {
+     *             batteryLevel: 76.3,
+     *             deviceLatitude: 13.009711,
+     *             deviceLongitude: 76.102898,
+     *             ipAddress: "79.144.2.20",
+     *             vpnUsed: true
+     *         }
+     *     })
      */
     public async create(
         request: Flagright.TransactionEvent,
@@ -63,7 +98,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.3.3",
+                "X-Fern-SDK-Version": "1.3.4",
             },
             contentType: "application/json",
             body: await serializers.TransactionEvent.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -118,6 +153,9 @@ export class TransactionEvents {
      * You can retrieve any transaction event you create using the [POST Transaction Events](https://docs.flagright.com/docs/flagright-api/d7c4dc4d02850-create-a-transaction-event) call.
      * @throws {@link Flagright.UnauthorizedError}
      * @throws {@link Flagright.TooManyRequestsError}
+     *
+     * @example
+     *     await flagright.transactionEvents.get("string")
      */
     public async get(
         eventId: string,
@@ -133,7 +171,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.3.3",
+                "X-Fern-SDK-Version": "1.3.4",
             },
             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
@@ -47,7 +47,64 @@ export class Transactions {
      * - `destinationPaymentDetails` - Payment details (if any) used at the destination (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.
      * @throws {@link Flagright.BadRequestError}
      * @throws {@link Flagright.UnauthorizedError}
+     * @throws {@link Flagright.ForbiddenError}
      * @throws {@link Flagright.TooManyRequestsError}
+     *
+     * @example
+     *     await flagright.transactions.verify({
+     *         validateOriginUserId: Flagright.BooleanString.True,
+     *         validateDestinationUserId: Flagright.BooleanString.True,
+     *         body: {
+     *             transactionState: Flagright.TransactionState.Created,
+     *             originAmountDetails: {
+     *                 transactionAmount: 800,
+     *                 transactionCurrency: Flagright.CurrencyCode.Eur,
+     *                 country: Flagright.CountryCode.De
+     *             },
+     *             destinationAmountDetails: {
+     *                 transactionAmount: 68351.34,
+     *                 transactionCurrency: Flagright.CurrencyCode.Inr,
+     *                 country: Flagright.CountryCode.In
+     *             },
+     *             promotionCodeUsed: true,
+     *             reference: "loan repayment",
+     *             originDeviceData: {
+     *                 batteryLevel: 95,
+     *                 deviceLatitude: 13.0033,
+     *                 deviceLongitude: 76.1004,
+     *                 ipAddress: "10.23.191.2",
+     *                 deviceIdentifier: "3c49f915d04485e34caba",
+     *                 vpnUsed: false,
+     *                 operatingSystem: "Android 11.2",
+     *                 deviceMaker: "ASUS",
+     *                 deviceModel: "Zenphone M2 Pro Max",
+     *                 deviceYear: "2018",
+     *                 appVersion: "1.1.0"
+     *             },
+     *             destinationDeviceData: {
+     *                 batteryLevel: 95,
+     *                 deviceLatitude: 13.0033,
+     *                 deviceLongitude: 76.1004,
+     *                 ipAddress: "10.23.191.2",
+     *                 deviceIdentifier: "3c49f915d04485e34caba",
+     *                 vpnUsed: false,
+     *                 operatingSystem: "Android 11.2",
+     *                 deviceMaker: "ASUS",
+     *                 deviceModel: "Zenphone M2 Pro Max",
+     *                 deviceYear: "2018",
+     *                 appVersion: "1.1.0"
+     *             },
+     *             tags: [{
+     *                     key: "customKey",
+     *                     value: "customValue"
+     *                 }],
+     *             type: Flagright.TransactionType.Deposit,
+     *             transactionId: "7b80a539eea6e78acbd6d458e5971482",
+     *             timestamp: 1641654664000,
+     *             originUserId: "8650a2611d0771cba03310f74bf6",
+     *             destinationUserId: "9350a2611e0771cba03310f74bf6"
+     *         }
+     *     })
      */
     public async verify(
         request: Flagright.TransactionsVerifyRequest,
@@ -73,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.3.3",
+                "X-Fern-SDK-Version": "1.3.4",
             },
             contentType: "application/json",
             queryParameters: _queryParams,
@@ -96,6 +153,8 @@ export class Transactions {
                     throw new Flagright.BadRequestError(_response.error.body);
                 case 401:
                     throw new Flagright.UnauthorizedError(_response.error.body);
+                case 403:
+                    throw new Flagright.ForbiddenError(_response.error.body);
                 case 429:
                     throw new Flagright.TooManyRequestsError(_response.error.body);
                 default:
@@ -129,6 +188,9 @@ export class Transactions {
      * 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}
      * @throws {@link Flagright.TooManyRequestsError}
+     *
+     * @example
+     *     await flagright.transactions.get("string")
      */
     public async get(
         transactionId: string,
@@ -144,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.3.3",
+                "X-Fern-SDK-Version": "1.3.4",
             },
             contentType: "application/json",
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

diff --git a/src/api/resources/transactions/client/requests/TransactionsVerifyRequest.ts b/src/api/resources/transactions/client/requests/TransactionsVerifyRequest.ts
@@ -4,6 +4,63 @@
 
 import * as Flagright from "../../../..";
 
+/**
+ * @example
+ *     {
+ *         validateOriginUserId: Flagright.BooleanString.True,
+ *         validateDestinationUserId: Flagright.BooleanString.True,
+ *         body: {
+ *             transactionState: Flagright.TransactionState.Created,
+ *             originAmountDetails: {
+ *                 transactionAmount: 800,
+ *                 transactionCurrency: Flagright.CurrencyCode.Eur,
+ *                 country: Flagright.CountryCode.De
+ *             },
+ *             destinationAmountDetails: {
+ *                 transactionAmount: 68351.34,
+ *                 transactionCurrency: Flagright.CurrencyCode.Inr,
+ *                 country: Flagright.CountryCode.In
+ *             },
+ *             promotionCodeUsed: true,
+ *             reference: "loan repayment",
+ *             originDeviceData: {
+ *                 batteryLevel: 95,
+ *                 deviceLatitude: 13.0033,
+ *                 deviceLongitude: 76.1004,
+ *                 ipAddress: "10.23.191.2",
+ *                 deviceIdentifier: "3c49f915d04485e34caba",
+ *                 vpnUsed: false,
+ *                 operatingSystem: "Android 11.2",
+ *                 deviceMaker: "ASUS",
+ *                 deviceModel: "Zenphone M2 Pro Max",
+ *                 deviceYear: "2018",
+ *                 appVersion: "1.1.0"
+ *             },
+ *             destinationDeviceData: {
+ *                 batteryLevel: 95,
+ *                 deviceLatitude: 13.0033,
+ *                 deviceLongitude: 76.1004,
+ *                 ipAddress: "10.23.191.2",
+ *                 deviceIdentifier: "3c49f915d04485e34caba",
+ *                 vpnUsed: false,
+ *                 operatingSystem: "Android 11.2",
+ *                 deviceMaker: "ASUS",
+ *                 deviceModel: "Zenphone M2 Pro Max",
+ *                 deviceYear: "2018",
+ *                 appVersion: "1.1.0"
+ *             },
+ *             tags: [{
+ *                     key: "customKey",
+ *                     value: "customValue"
+ *                 }],
+ *             type: Flagright.TransactionType.Deposit,
+ *             transactionId: "7b80a539eea6e78acbd6d458e5971482",
+ *             timestamp: 1641654664000,
+ *             originUserId: "8650a2611d0771cba03310f74bf6",
+ *             destinationUserId: "9350a2611e0771cba03310f74bf6"
+ *         }
+ *     }
+ */
 export interface TransactionsVerifyRequest {
     /**
      * Boolean string whether Flagright should validate if provided originUserId exist. True by default

diff --git a/src/api/types/AchDetails.ts b/src/api/types/AchDetails.ts
@@ -19,6 +19,7 @@ export interface AchDetails {
     bankAddress?: Flagright.Address;
     /** Beneficiary name of the account */
     beneficiaryName?: string;
+    emailId?: Flagright.EmailId;
     /** Additional information that can be added via tags */
     tags?: Flagright.Tag[];
 }
diff --git a/src/api/types/CardDetails.ts b/src/api/types/CardDetails.ts
@@ -10,6 +10,7 @@ import * as Flagright from "..";
 export interface CardDetails {
     /** Unique card fingerprint that helps identify a specific card without having to use explicit card number. This is likely available at your card payment scheme provider */
     cardFingerprint?: string;
+    emailId?: Flagright.EmailId;
     cardIssuedCountry?: Flagright.CountryCode;
     /** Reference for the transaction */
     transactionReferenceField?: string;

diff --git a/src/api/types/EmailId.ts b/src/api/types/EmailId.ts
@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * Email ID format. Ex: [email protected]
+ */
+export type EmailId = string;
diff --git a/src/api/types/GenericBankAccountDetails.ts b/src/api/types/GenericBankAccountDetails.ts
@@ -19,6 +19,7 @@ export interface GenericBankAccountDetails {
     /** Name of the account holder */
     name?: string;
     bankAddress?: Flagright.Address;
+    emailId?: Flagright.EmailId;
     /** Special instructions to be specified if any */
     specialInstructions?: string;
     paymentChannel?: string;

diff --git a/src/api/types/IbanDetails.ts b/src/api/types/IbanDetails.ts
@@ -18,9 +18,10 @@ export interface IbanDetails {
     iban?: string;
     /** Name of the bank account holder */
     name?: string;
-    /** Additional information that can be added via tags */
-    tags?: Flagright.Tag[];
+    emailId?: Flagright.EmailId;
     /** Branch code of the bank. In some countries, this can be the same as the bank's SWIFT code */
     bankBranchCode?: string;
     paymentChannel?: string;
+    /** Additional information that can be added via tags */
+    tags?: Flagright.Tag[];
 }
diff --git a/src/api/types/MpesaDetails.ts b/src/api/types/MpesaDetails.ts
@@ -13,6 +13,7 @@ export interface MpesaDetails {
     transactionType: Flagright.MpesaTransactionType;
     /** Contact Number of the account holder */
     phoneNumber: string;
+    emailId?: Flagright.EmailId;
     /** Additional information that can be added via tags */
     tags?: Flagright.Tag[];
 }
diff --git a/src/api/types/SwiftDetails.ts b/src/api/types/SwiftDetails.ts
@@ -19,6 +19,7 @@ export interface SwiftDetails {
     /** Name of the account holder */
     name?: string;
     bankAddress?: Flagright.Address;
+    emailId?: Flagright.EmailId;
     /** Special instructions if any */
     specialInstructions?: string;
     /** Additional information that can be added via tags */

diff --git a/src/api/types/UpiDetails.ts b/src/api/types/UpiDetails.ts
@@ -16,6 +16,7 @@ export interface UpiDetails {
     interfaceProvider?: string;
     /** Name of the account holder */
     name?: string;
+    emailId?: Flagright.EmailId;
     /** Additional information that can be added via tags */
     tags?: Flagright.Tag[];
 }
diff --git a/src/api/types/WalletDetails.ts b/src/api/types/WalletDetails.ts
@@ -16,6 +16,7 @@ export interface WalletDetails {
     paymentChannel?: string;
     /** Name of the account holder for a specific wallet */
     name?: string;
+    emailId?: Flagright.EmailId;
     /** Additional information that can be added via tags */
     tags?: Flagright.Tag[];
     /** Phone number associated with the wallet, if any */

diff --git a/src/api/types/index.ts b/src/api/types/index.ts
@@ -6,6 +6,7 @@ export * from "./User";
 export * from "./Person";
 export * from "./LegalDocument";
 export * from "./Tag";
+export * from "./EmailId";
 export * from "./Transaction";
 export * from "./TransactionUpdatableOriginPaymentDetails";
 export * from "./TransactionUpdatableDestinationPaymentDetails";

diff --git a/src/serialization/types/AchDetails.ts b/src/serialization/types/AchDetails.ts
@@ -14,6 +14,7 @@ export const AchDetails: core.serialization.ObjectSchema<serializers.AchDetails.
         name: core.serialization.string().optional(),
         bankAddress: core.serialization.lazyObject(async () => (await import("..")).Address).optional(),
         beneficiaryName: core.serialization.string().optional(),
+        emailId: core.serialization.lazy(async () => (await import("..")).EmailId).optional(),
         tags: core.serialization.list(core.serialization.lazyObject(async () => (await import("..")).Tag)).optional(),
     });
 
@@ -25,6 +26,7 @@ export declare namespace AchDetails {
         name?: string | null;
         bankAddress?: serializers.Address.Raw | null;
         beneficiaryName?: string | null;
+        emailId?: serializers.EmailId.Raw | null;
         tags?: serializers.Tag.Raw[] | null;
     }
 }
diff --git a/src/serialization/types/CardDetails.ts b/src/serialization/types/CardDetails.ts
@@ -9,6 +9,7 @@ import * as core from "../../core";
 export const CardDetails: core.serialization.ObjectSchema<serializers.CardDetails.Raw, Flagright.CardDetails> =
     core.serialization.object({
         cardFingerprint: core.serialization.string().optional(),
+        emailId: core.serialization.lazy(async () => (await import("..")).EmailId).optional(),
         cardIssuedCountry: core.serialization.lazy(async () => (await import("..")).CountryCode).optional(),
         transactionReferenceField: core.serialization.string().optional(),
         "3DsDone": core.serialization.property("3dsDone", core.serialization.boolean().optional()),
@@ -27,6 +28,7 @@ export const CardDetails: core.serialization.ObjectSchema<serializers.CardDetail
 export declare namespace CardDetails {
     interface Raw {
         cardFingerprint?: string | null;
+        emailId?: serializers.EmailId.Raw | null;
         cardIssuedCountry?: serializers.CountryCode.Raw | null;
         transactionReferenceField?: string | null;
         "3dsDone"?: boolean | null;

diff --git a/src/serialization/types/EmailId.ts b/src/serialization/types/EmailId.ts
@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as serializers from "..";
+import * as Flagright from "../../api";
+import * as core from "../../core";
+
+export const EmailId: core.serialization.Schema<serializers.EmailId.Raw, Flagright.EmailId> =
+    core.serialization.string();
+
+export declare namespace EmailId {
+    type Raw = string;
+}