finch-api-node/src/resources/shared.ts at main · Finch-API/finch-api-node · GitHub

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
81
82
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

export type ConnectionStatusType =
  | 'pending'
  | 'processing'
  | 'connected'
  | 'error_no_account_setup'
  | 'error_permissions'
  | 'reauth';

/**
 * - `supported`: This operation is supported by both the provider and Finch
 * - `not_supported_by_finch`: This operation is not supported by Finch but
 *   supported by the provider
 * - `not_supported_by_provider`: This operation is not supported by the provider,
 *   so Finch cannot support
 * - `client_access_only`: This behavior is supported by the provider, but only
 *   available to the client and not to Finch
 */
export type OperationSupport =
  | 'supported'
  | 'not_supported_by_finch'
  | 'not_supported_by_provider'
  | 'client_access_only';

export interface OperationSupportMatrix {
  /**
   * - `supported`: This operation is supported by both the provider and Finch
   * - `not_supported_by_finch`: This operation is not supported by Finch but
   *   supported by the provider
   * - `not_supported_by_provider`: This operation is not supported by the provider,
   *   so Finch cannot support
   * - `client_access_only`: This behavior is supported by the provider, but only
   *   available to the client and not to Finch
   */
  create?: OperationSupport;

  /**
   * - `supported`: This operation is supported by both the provider and Finch
   * - `not_supported_by_finch`: This operation is not supported by Finch but
   *   supported by the provider
   * - `not_supported_by_provider`: This operation is not supported by the provider,
   *   so Finch cannot support
   * - `client_access_only`: This behavior is supported by the provider, but only
   *   available to the client and not to Finch
   */
  delete?: OperationSupport;

  /**
   * - `supported`: This operation is supported by both the provider and Finch
   * - `not_supported_by_finch`: This operation is not supported by Finch but
   *   supported by the provider
   * - `not_supported_by_provider`: This operation is not supported by the provider,
   *   so Finch cannot support
   * - `client_access_only`: This behavior is supported by the provider, but only
   *   available to the client and not to Finch
   */
  read?: OperationSupport;

  /**
   * - `supported`: This operation is supported by both the provider and Finch
   * - `not_supported_by_finch`: This operation is not supported by Finch but
   *   supported by the provider
   * - `not_supported_by_provider`: This operation is not supported by the provider,
   *   so Finch cannot support
   * - `client_access_only`: This behavior is supported by the provider, but only
   *   available to the client and not to Finch
   */
  update?: OperationSupport;
}

export interface Paging {
  /**
   * The current start index of the returned list of elements
   */
  offset: number;

  /**
   * The total number of elements for the entire query (not just the given page)
   */
  count?: number;
}