@vrplatform/api 1.3.1-6406 → 1.3.1-6410

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "1.3.1-6406",
6
+ "version": "1.3.1-6410",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -3870,7 +3870,7 @@ export interface paths {
3870
3870
  cookie?: never;
3871
3871
  };
3872
3872
  /**
3873
- * @description Check Plaid health using an existing connection
3873
+ * @description Check the current Plaid Item and institution health for an existing connection. Typed errors distinguish reconnect, replacement, retry, and support actions.
3874
3874
  *
3875
3875
  * Required scope: bank-connections:manage
3876
3876
  */
@@ -77880,16 +77880,15 @@ export interface operations {
77880
77880
  };
77881
77881
  };
77882
77882
  };
77883
- /** @description Conflict */
77883
+ /** @description The connection must be re-authenticated */
77884
77884
  409: {
77885
77885
  headers: {
77886
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
77887
- "Retry-After"?: number;
77888
77886
  [name: string]: unknown;
77889
77887
  };
77890
77888
  content: {
77891
77889
  "application/json": {
77892
- code: string;
77890
+ /** @constant */
77891
+ code: "CONNECTION_RECONNECT_REQUIRED";
77893
77892
  message: string;
77894
77893
  links?: {
77895
77894
  docs: string;
@@ -77901,7 +77900,27 @@ export interface operations {
77901
77900
  schema?: string;
77902
77901
  }[];
77903
77902
  retryable?: boolean;
77904
- context?: unknown;
77903
+ context: {
77904
+ endpoint?: string;
77905
+ method?: string;
77906
+ plaidDisplayMessage?: string;
77907
+ plaidDocumentationUrl?: string;
77908
+ plaidErrorCode?: string;
77909
+ plaidErrorCodeReason?: string;
77910
+ plaidErrorMessage?: string;
77911
+ plaidErrorType?: string;
77912
+ plaidRequestId?: string;
77913
+ plaidSuggestedAction?: string;
77914
+ retryAfterSeconds?: number;
77915
+ status?: number;
77916
+ statusText?: string;
77917
+ /** @constant */
77918
+ action: "reconnect";
77919
+ /** Format: uuid */
77920
+ connectionId: string;
77921
+ connectionName: string | null;
77922
+ operation?: string;
77923
+ };
77905
77924
  };
77906
77925
  };
77907
77926
  };
@@ -77930,16 +77949,15 @@ export interface operations {
77930
77949
  };
77931
77950
  };
77932
77951
  };
77933
- /** @description Unprocessable content */
77952
+ /** @description The Plaid Item must be replaced through Link */
77934
77953
  422: {
77935
77954
  headers: {
77936
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
77937
- "Retry-After"?: number;
77938
77955
  [name: string]: unknown;
77939
77956
  };
77940
77957
  content: {
77941
77958
  "application/json": {
77942
- code: string;
77959
+ /** @constant */
77960
+ code: "PLAID_CONNECT_REQUIRES_NEW_LINK";
77943
77961
  message: string;
77944
77962
  links?: {
77945
77963
  docs: string;
@@ -77951,20 +77969,41 @@ export interface operations {
77951
77969
  schema?: string;
77952
77970
  }[];
77953
77971
  retryable?: boolean;
77954
- context?: unknown;
77972
+ context: {
77973
+ endpoint?: string;
77974
+ method?: string;
77975
+ plaidDisplayMessage?: string;
77976
+ plaidDocumentationUrl?: string;
77977
+ plaidErrorCode?: string;
77978
+ plaidErrorCodeReason?: string;
77979
+ plaidErrorMessage?: string;
77980
+ plaidErrorType?: string;
77981
+ plaidRequestId?: string;
77982
+ plaidSuggestedAction?: string;
77983
+ retryAfterSeconds?: number;
77984
+ status?: number;
77985
+ statusText?: string;
77986
+ /** @constant */
77987
+ action: "replace";
77988
+ /** Format: uuid */
77989
+ connectionId: string;
77990
+ connectionName: string | null;
77991
+ operation?: string;
77992
+ /** @constant */
77993
+ restartMode: "replace";
77994
+ };
77955
77995
  };
77956
77996
  };
77957
77997
  };
77958
- /** @description Internal server error */
77998
+ /** @description The health request could not be completed */
77959
77999
  500: {
77960
78000
  headers: {
77961
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
77962
- "Retry-After"?: number;
77963
78001
  [name: string]: unknown;
77964
78002
  };
77965
78003
  content: {
77966
78004
  "application/json": {
77967
- code: string;
78005
+ /** @constant */
78006
+ code: "INTERNAL_SERVER_ERROR";
77968
78007
  message: string;
77969
78008
  links?: {
77970
78009
  docs: string;
@@ -77976,20 +78015,39 @@ export interface operations {
77976
78015
  schema?: string;
77977
78016
  }[];
77978
78017
  retryable?: boolean;
77979
- context?: unknown;
78018
+ context: {
78019
+ endpoint?: string;
78020
+ method?: string;
78021
+ plaidDisplayMessage?: string;
78022
+ plaidDocumentationUrl?: string;
78023
+ plaidErrorCode?: string;
78024
+ plaidErrorCodeReason?: string;
78025
+ plaidErrorMessage?: string;
78026
+ plaidErrorType?: string;
78027
+ plaidRequestId?: string;
78028
+ plaidSuggestedAction?: string;
78029
+ retryAfterSeconds?: number;
78030
+ status?: number;
78031
+ statusText?: string;
78032
+ /** @constant */
78033
+ action: "contactSupport";
78034
+ /** Format: uuid */
78035
+ connectionId: string;
78036
+ connectionName: string | null;
78037
+ operation?: string;
78038
+ };
77980
78039
  };
77981
78040
  };
77982
78041
  };
77983
- /** @description Service unavailable */
78042
+ /** @description Plaid is temporarily unavailable */
77984
78043
  503: {
77985
78044
  headers: {
77986
- /** @description Seconds to wait when retryable=true and the server supplies a delay. */
77987
- "Retry-After"?: number;
77988
78045
  [name: string]: unknown;
77989
78046
  };
77990
78047
  content: {
77991
78048
  "application/json": {
77992
- code: string;
78049
+ /** @constant */
78050
+ code: "PLAID_PROVIDER_UNAVAILABLE";
77993
78051
  message: string;
77994
78052
  links?: {
77995
78053
  docs: string;
@@ -78000,8 +78058,29 @@ export interface operations {
78000
78058
  path?: (string | number)[];
78001
78059
  schema?: string;
78002
78060
  }[];
78003
- retryable?: boolean;
78004
- context?: unknown;
78061
+ /** @constant */
78062
+ retryable: true;
78063
+ context: {
78064
+ endpoint?: string;
78065
+ method?: string;
78066
+ plaidDisplayMessage?: string;
78067
+ plaidDocumentationUrl?: string;
78068
+ plaidErrorCode?: string;
78069
+ plaidErrorCodeReason?: string;
78070
+ plaidErrorMessage?: string;
78071
+ plaidErrorType?: string;
78072
+ plaidRequestId?: string;
78073
+ plaidSuggestedAction?: string;
78074
+ retryAfterSeconds?: number;
78075
+ status?: number;
78076
+ statusText?: string;
78077
+ /** @constant */
78078
+ action: "retry";
78079
+ /** Format: uuid */
78080
+ connectionId: string;
78081
+ connectionName: string | null;
78082
+ operation?: string;
78083
+ };
78005
78084
  };
78006
78085
  };
78007
78086
  };