-
Notifications
You must be signed in to change notification settings - Fork 14
/
connections.ts
80 lines (65 loc) · 2.04 KB
/
connections.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from '../resource';
import { isRequestOptions } from '../core';
import * as Core from '../core';
import * as ConnectionsAPI from './connections';
import { Page, type PageParams } from '../pagination';
export class Connections extends APIResource {
/**
* Get a list of all connections.
*/
list(
query?: ConnectionListParams,
options?: Core.RequestOptions,
): Core.PagePromise<ConnectionsPage, Connection>;
list(options?: Core.RequestOptions): Core.PagePromise<ConnectionsPage, Connection>;
list(
query: ConnectionListParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.PagePromise<ConnectionsPage, Connection> {
if (isRequestOptions(query)) {
return this.list({}, query);
}
return this._client.getAPIList('/api/connections', ConnectionsPage, { query, ...options });
}
}
export class ConnectionsPage extends Page<Connection> {}
export interface Connection {
id: string;
created_at: string;
discarded_at: string | null;
/**
* This field will be true if this object exists in the live environment or false
* if it exists in the test environment.
*/
live_mode: boolean;
object: string;
updated_at: string;
/**
* An identifier given to this connection by the bank.
*/
vendor_customer_id: string | null;
/**
* Unique identifier for the bank or vendor.
*/
vendor_id: string;
/**
* A human-friendly name for the bank or vendor.
*/
vendor_name: string;
}
export interface ConnectionListParams extends PageParams {
/**
* A string code representing the vendor (i.e. bank).
*/
entity?: string;
/**
* An identifier assigned by the vendor to your organization.
*/
vendor_customer_id?: string;
}
export namespace Connections {
export import Connection = ConnectionsAPI.Connection;
export import ConnectionsPage = ConnectionsAPI.ConnectionsPage;
export import ConnectionListParams = ConnectionsAPI.ConnectionListParams;
}