Class GreendotStoreClient

Hierarchy

GreendotBaseClient
- GreendotStoreClient

Index

Constructors

constructor

new GreendotStoreClient(): GreendotStoreClient
Returns GreendotStoreClient
Inherited from GreendotBaseClient.constructor
- Defined in packages/deposit-services/src/clients/greendot/GreendotBaseClient.ts:37

Properties

`Protected` `Readonly`client

client: Client<paths>

`Static`instance

instance: (...args: []) => GreendotStoreClient = ...

The process client over the partner API, reading greendot-partner at each call.

Methods

getStoresByLatLong

getStoresByLatLong(
    req: {
        count: number;
        latitude: number;
        longitude: number;
        page: number;
        serviceType: number;
    },
): Promise<
    | { error: GreendotError; ok: false }
    | { ok: true; value: GreendotStorePage },
>
Parameters
- req: {
      count: number;
      latitude: number;
      longitude: number;
      page: number;
      serviceType: number;
  }
  - count: number
    
    Description
    record counts per page
  - latitude: number
    
    Description
    location latitude
  - longitude: number
    
    Description
    location logitude
  - page: number
    
    Description
    page number for pagenation
  - serviceType: number
    
    Description
    service type flags filter for store supported services
Returns Promise<
| { error: GreendotError; ok: false }
| { ok: true; value: GreendotStorePage },
>
- Defined in packages/deposit-services/src/clients/greendot/GreendotStoreClient.ts:60

getStoresByZipcode

getStoresByZipcode(
    req: {
        count: number;
        page: number;
        serviceType: number;
        zipcode: string;
    },
): Promise<
    | { error: GreendotError; ok: false }
    | { ok: true; value: GreendotStorePage },
>
Parameters
- req: { count: number; page: number; serviceType: number; zipcode: string }
  - count: number
    
    Description
    record counts per page
  - page: number
    
    Description
    page number for pagenation
  - serviceType: number
    
    Description
    service type flags filter for store supported services
  - zipcode: string
    
    Description
    zip code for search
Returns Promise<
| { error: GreendotError; ok: false }
| { ok: true; value: GreendotStorePage },
>
- Defined in packages/deposit-services/src/clients/greendot/GreendotStoreClient.ts:21

ping

ping(): Promise<{ error: GreendotError; ok: false } | { ok: true; value: true }>
Returns Promise<{ error: GreendotError; ok: false } | { ok: true; value: true }>
Inherited from GreendotBaseClient.ping
- Defined in packages/deposit-services/src/clients/greendot/GreendotBaseClient.ts:83

searchStores

searchStores(
    __namedParameters: { page: number; pageSize: number } & (
        { zipcode: string }
        | { latitude: number; longitude: number }
    ),
): Promise<
    | { error: GreendotError; ok: false }
    | { ok: true; value: GreendotStoreSearchResult },
>
Cash-reload stores near a zipcode or coordinate pair, page and coordinates sent as given.
Parameters
- __namedParameters: { page: number; pageSize: number } & (
  { zipcode: string }
  | { latitude: number; longitude: number }
  )
Returns Promise<
| { error: GreendotError; ok: false }
| { ok: true; value: GreendotStoreSearchResult },
>
- Defined in packages/deposit-services/src/clients/greendot/GreendotStoreClient.ts:103

Class GreendotStoreClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns GreendotStoreClient

Properties

Protected Readonlyclient

Staticinstance

Methods

getStoresByLatLong

Parameters

count: number

Description

latitude: number

Description

longitude: number

Description

page: number

Description

serviceType: number

Description

Returns Promise< | { error: GreendotError; ok: false } | { ok: true; value: GreendotStorePage },>

getStoresByZipcode

Parameters

count: number

Description

page: number

Description

serviceType: number

Description

zipcode: string

Description

Returns Promise< | { error: GreendotError; ok: false } | { ok: true; value: GreendotStorePage },>

ping

Returns Promise<{ error: GreendotError; ok: false } | { ok: true; value: true }>

searchStores

Parameters

Returns Promise< | { error: GreendotError; ok: false } | { ok: true; value: GreendotStoreSearchResult },>

Settings

On This Page

`Protected` `Readonly`client

`Static`instance

Returns Promise<
| { error: GreendotError; ok: false }
| { ok: true; value: GreendotStorePage },
>

Returns Promise<
| { error: GreendotError; ok: false }
| { ok: true; value: GreendotStorePage },
>

Returns Promise<
| { error: GreendotError; ok: false }
| { ok: true; value: GreendotStoreSearchResult },
>