implementation of ApiTokens (#203)

Author: axshani

resources/orgToken.ts

@@ -0,0 +1,23 @@
+import { UnitResponse, UnitConfig } from "../types/common"
+import { BaseResource } from "./baseResource"
+import { ApiToken, CreateApiTokenRequest } from "../types/orgToken"
+
+export class OrgTokens extends BaseResource {
+
+    constructor(token: string, basePath: string, config?: UnitConfig) {
+        super(token, basePath + "/users", config)
+    }
+
+    public async create(userId: string, request: CreateApiTokenRequest): Promise<UnitResponse<ApiToken>> {
+        return this.httpPost<UnitResponse<ApiToken>>(`/${userId}/api-tokens`, { data: request })
+    }
+
+    public async revoke(userId: string, tokenId: string): Promise<UnitResponse<ApiToken>> {
+        return this.httpDelete<UnitResponse<ApiToken>>(`/${userId}/api-tokens/${tokenId}`)
+    }
+
+    public async list(userId: string): Promise<UnitResponse<ApiToken[]>> {
+        return this.httpGet<UnitResponse<ApiToken[]>>(`/${userId}/api-tokens`)
+    }
+
+}

tests/orgTokens.spec.ts

@@ -0,0 +1,30 @@
+import { CreateApiTokenRequest, Unit } from "../unit"
+import dotenv from "dotenv"
+dotenv.config()
+const unit = new Unit(process.env.UNIT_TOKEN || "test", process.env.UNIT_API_URL || "test")
+
+describe("Create API Tokens", () => {
+    test("Create API Tokens", async () => {
+        const req: CreateApiTokenRequest = {
+            "type": "apiToken",
+            "attributes": {
+                "description": "test token",
+                "scope": "customers applications",
+                "expiration": "2022-09-01T13:47:17.000Z"
+            }
+        }
+
+        const res = await unit.orgTokens.create("252", req)
+        expect(res.data.type).toBe("apiToken")
+    })
+})
+
+describe("API Tokens List", () => {
+    test("Get API Tokens List", async () => {
+        const res = await unit.orgTokens.list("252")
+        res.data.forEach(element => {
+            expect(element.type).toBe("apiToken")
+        })
+    })
+})
+

types/index.ts

@@ -18,3 +18,4 @@ export * from "./webhooks"
 export * from "./billPay"
 export * from "./checkDeposit"
 export * from "./rewards"
+export * from "./orgToken"

types/orgToken.ts

@@ -0,0 +1,59 @@
+
+export interface ApiToken {
+    id: string
+    type: "apiToken"
+    attributes: {
+        /**
+         * The date the API token was created.
+         * RFC3339 format. For more information: https://en.wikipedia.org/wiki/ISO_8601#RFCs
+         */
+        createdAt: string
+
+        /**
+         * A description of the API token.
+         */
+        description: string
+
+        /**
+         * Expiration date of the API token.
+         * RFC3339 format. For more information: https://en.wikipedia.org/wiki/ISO_8601#RFCs
+         */
+        expiration: string
+
+        /**
+         * Optional. The actual bearer token. Available only on API token creation response.
+         */
+        token?: string
+
+        /**
+         * Optional. A comma separated list of IP addresses that are allowed to use the API token.
+         */
+        sourceIp?: string
+    }
+}
+
+export interface CreateApiTokenRequest {
+    type: "apiToken"
+    attributes: {
+        /**
+         * A description of the Org API token.
+         */
+        description: string
+
+        /**
+         * list of Scopes separated by spaces.
+         */
+        scope: string
+
+        /**
+         * Expiration date of the API token.
+         * RFC3339 format. For more information: https://en.wikipedia.org/wiki/ISO_8601#RFCs
+         */
+        expiration?: string
+
+        /**
+         * Optional. A comma separated list of IP addresses that are allowed to use the API token.
+         */
+        sourceIp?: string
+    }
+}

unit.ts

@@ -24,6 +24,7 @@ import { AtmLocations } from "./resources/atmLocations"
 import { CheckDeposits } from "./resources/checkDeposit"
 import { ReceivedPayments } from "./resources/receivedPayments"
 import { RecurringPayments } from "./resources/recurringPayments"
+import { OrgTokens } from "./resources/orgToken"
 
 export class Unit {
     public applications: Applications
@@ -52,6 +53,7 @@ export class Unit {
     public checkDeposits: CheckDeposits
     public rewards: Rewards
     public recurringPayments: RecurringPayments
+    public orgTokens: OrgTokens
 
     constructor(token: string, basePath: string, config?: UnitConfig) {
         // remove all trailing slashes from user-provided basePath
@@ -82,6 +84,7 @@ export class Unit {
         this.checkDeposits = new CheckDeposits(token, basePath, config)
         this.rewards = new Rewards(token, basePath, config)
         this.recurringPayments = new RecurringPayments(token, basePath, config)
+        this.orgTokens = new OrgTokens(token, basePath, config)
         this.helpers = helpers
     }