Atm locations (#81)

* atm-locations is done

* rename file

* rename and lint-fix

* no need for that optionals

Co-authored-by: ilyamerman <[email protected]>

Author: axshani

resources/atmLocations.ts

@@ -0,0 +1,28 @@
+import { AtmLocation } from "../types/atmLocation"
+import { UnitResponse, UnitConfig, Coordinates, Address } from "../types/common"
+import { BaseResource } from "./baseResource"
+
+export class AtmLocations extends BaseResource {
+
+    constructor(token: string, basePath: string, config?: UnitConfig) {
+        super(token, basePath + "/atm-locations", config)
+    }
+
+    public async list(params?: AtmLocationListParams): Promise<UnitResponse<AtmLocation[]>> {
+        const parameters = {
+            ...(params?.coordinates && { "filter[coordinates]": params.coordinates }),
+            ...(params?.address && { "filter[address]": params.address }),
+            ...(params?.postalCode && { "filter[postalCode]": params.postalCode }),
+            ...(params?.searchRadius && { "filter[searchRadius]": params.searchRadius })
+        }
+
+        return this.httpGet<UnitResponse<AtmLocation[]>>("", { params: parameters })
+    }
+}
+
+export interface AtmLocationListParams {
+    coordinates?: Coordinates
+    address?: Address
+    postalCode?: string
+    searchRadius?: number
+}

types/atmLocation.ts

@@ -0,0 +1,48 @@
+import { Coordinates } from "."
+
+export interface AtmLocation {
+    /**
+     * Type of the ATM location resource. The value is always atmLocation.
+     */
+    type: "atmLocation"
+
+    /**
+     * JSON object representing the ATM location data.
+     */
+    attributes: {
+        /**
+         * Name of the ATM network.
+         */
+        network: string
+
+        /**
+         * Name of the ATM's location.
+         */
+        locationName: string
+
+        /**
+         * Coordinates (latitude, longitude) of the ATM.
+         */
+        coordinates: Coordinates
+        
+        /**
+         * Address of the ATM.
+         */
+        address: string
+
+        /**
+         * Distance to the ATM (in miles).
+         */
+        distance: number
+
+        /**
+         * Indicates if the ATM is surcharge free.
+         */
+        surchargeFree: boolean
+
+        /**
+         * Indicates if the ATM accepts deposits.
+         */
+        acceptDeposits: boolean
+    }
+}

unit.ts

@@ -20,6 +20,7 @@ import { ApplicationForms } from "./resources/applicationForm"
 import { AccountsEndOfDay } from "./resources/accountEndOfDay"
 import { BillPays } from "./resources"
 import { Institutions } from "./resources/institutions"
+import { AtmLocations } from "./resources/atmLocations"
 
 export class Unit {
     public applications: Applications
@@ -43,6 +44,7 @@ export class Unit {
     public returns: Returns
     public billPays: BillPays
     public institutions: Institutions
+    public atmLocations: AtmLocations
 
     constructor(token: string, basePath: string, config?: UnitConfig) {
         // remove all trailing slashes from user-provided basePath
@@ -68,6 +70,7 @@ export class Unit {
         this.returns = new Returns(token, basePath, config)
         this.billPays = new BillPays(token, basePath, config)
         this.institutions = new Institutions(token, basePath, config)
+        this.atmLocations = new AtmLocations(token, basePath, config)
         this.helpers = helpers
     }