@seamapi/types 1.887.0 → 1.888.0

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.
@@ -7329,6 +7329,19 @@ declare const acs_system: z.ZodObject<{
7329
7329
  created_at: string;
7330
7330
  warning_code: "time_zone_does_not_match_location";
7331
7331
  misconfigured_acs_entrance_ids?: string[] | undefined;
7332
+ }>, z.ZodObject<{
7333
+ created_at: z.ZodString;
7334
+ message: z.ZodString;
7335
+ } & {
7336
+ warning_code: z.ZodLiteral<"setup_required">;
7337
+ }, "strip", z.ZodTypeAny, {
7338
+ message: string;
7339
+ created_at: string;
7340
+ warning_code: "setup_required";
7341
+ }, {
7342
+ message: string;
7343
+ created_at: string;
7344
+ warning_code: "setup_required";
7332
7345
  }>]>, "many">;
7333
7346
  }, "strip", z.ZodTypeAny, {
7334
7347
  name: string;
@@ -7379,6 +7392,10 @@ declare const acs_system: z.ZodObject<{
7379
7392
  created_at: string;
7380
7393
  warning_code: "time_zone_does_not_match_location";
7381
7394
  misconfigured_acs_entrance_ids?: string[] | undefined;
7395
+ } | {
7396
+ message: string;
7397
+ created_at: string;
7398
+ warning_code: "setup_required";
7382
7399
  })[];
7383
7400
  image_alt_text: string;
7384
7401
  location: {
@@ -7448,6 +7465,10 @@ declare const acs_system: z.ZodObject<{
7448
7465
  created_at: string;
7449
7466
  warning_code: "time_zone_does_not_match_location";
7450
7467
  misconfigured_acs_entrance_ids?: string[] | undefined;
7468
+ } | {
7469
+ message: string;
7470
+ created_at: string;
7471
+ warning_code: "setup_required";
7451
7472
  })[];
7452
7473
  image_alt_text: string;
7453
7474
  location: {
@@ -14619,6 +14640,19 @@ declare const connected_account_warning: z.ZodDiscriminatedUnion<"warning_code",
14619
14640
  message: string;
14620
14641
  created_at: string;
14621
14642
  warning_code: "provider_service_unavailable";
14643
+ }>, z.ZodObject<{
14644
+ created_at: z.ZodString;
14645
+ message: z.ZodString;
14646
+ } & {
14647
+ warning_code: z.ZodLiteral<"setup_required">;
14648
+ }, "strip", z.ZodTypeAny, {
14649
+ message: string;
14650
+ created_at: string;
14651
+ warning_code: "setup_required";
14652
+ }, {
14653
+ message: string;
14654
+ created_at: string;
14655
+ warning_code: "setup_required";
14622
14656
  }>]>;
14623
14657
  declare const connected_account: z.ZodObject<{
14624
14658
  connected_account_id: z.ZodString;
@@ -14878,6 +14912,19 @@ declare const connected_account: z.ZodObject<{
14878
14912
  message: string;
14879
14913
  created_at: string;
14880
14914
  warning_code: "provider_service_unavailable";
14915
+ }>, z.ZodObject<{
14916
+ created_at: z.ZodString;
14917
+ message: z.ZodString;
14918
+ } & {
14919
+ warning_code: z.ZodLiteral<"setup_required">;
14920
+ }, "strip", z.ZodTypeAny, {
14921
+ message: string;
14922
+ created_at: string;
14923
+ warning_code: "setup_required";
14924
+ }, {
14925
+ message: string;
14926
+ created_at: string;
14927
+ warning_code: "setup_required";
14881
14928
  }>]>, "many">;
14882
14929
  custom_metadata: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
14883
14930
  automatically_manage_new_devices: z.ZodBoolean;
@@ -14951,6 +14998,10 @@ declare const connected_account: z.ZodObject<{
14951
14998
  message: string;
14952
14999
  created_at: string;
14953
15000
  warning_code: "provider_service_unavailable";
15001
+ } | {
15002
+ message: string;
15003
+ created_at: string;
15004
+ warning_code: "setup_required";
14954
15005
  })[];
14955
15006
  custom_metadata: Record<string, string | boolean>;
14956
15007
  automatically_manage_new_devices: boolean;
@@ -15034,6 +15085,10 @@ declare const connected_account: z.ZodObject<{
15034
15085
  message: string;
15035
15086
  created_at: string;
15036
15087
  warning_code: "provider_service_unavailable";
15088
+ } | {
15089
+ message: string;
15090
+ created_at: string;
15091
+ warning_code: "setup_required";
15037
15092
  })[];
15038
15093
  custom_metadata: Record<string, string | boolean>;
15039
15094
  automatically_manage_new_devices: boolean;
@@ -44695,6 +44750,13 @@ type Routes = {
44695
44750
  message: string;
44696
44751
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
44697
44752
  warning_code: 'provider_service_unavailable';
44753
+ } | {
44754
+ /** Date and time at which Seam created the warning. */
44755
+ created_at: string;
44756
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
44757
+ message: string;
44758
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
44759
+ warning_code: 'setup_required';
44698
44760
  })[];
44699
44761
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
44700
44762
  custom_metadata: {
@@ -44840,6 +44902,13 @@ type Routes = {
44840
44902
  /**
44841
44903
  * @deprecated this field is deprecated.*/
44842
44904
  misconfigured_acs_entrance_ids?: string[] | undefined;
44905
+ } | {
44906
+ /** Date and time at which Seam created the warning. */
44907
+ created_at: string;
44908
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
44909
+ message: string;
44910
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
44911
+ warning_code: 'setup_required';
44843
44912
  })[];
44844
44913
  }[] | undefined;
44845
44914
  user_identities?: {
@@ -64218,6 +64287,13 @@ type Routes = {
64218
64287
  /**
64219
64288
  * @deprecated this field is deprecated.*/
64220
64289
  misconfigured_acs_entrance_ids?: string[] | undefined;
64290
+ } | {
64291
+ /** Date and time at which Seam created the warning. */
64292
+ created_at: string;
64293
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
64294
+ message: string;
64295
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
64296
+ warning_code: 'setup_required';
64221
64297
  })[];
64222
64298
  };
64223
64299
  };
@@ -64361,6 +64437,13 @@ type Routes = {
64361
64437
  /**
64362
64438
  * @deprecated this field is deprecated.*/
64363
64439
  misconfigured_acs_entrance_ids?: string[] | undefined;
64440
+ } | {
64441
+ /** Date and time at which Seam created the warning. */
64442
+ created_at: string;
64443
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
64444
+ message: string;
64445
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
64446
+ warning_code: 'setup_required';
64364
64447
  })[];
64365
64448
  }[];
64366
64449
  };
@@ -64500,6 +64583,13 @@ type Routes = {
64500
64583
  /**
64501
64584
  * @deprecated this field is deprecated.*/
64502
64585
  misconfigured_acs_entrance_ids?: string[] | undefined;
64586
+ } | {
64587
+ /** Date and time at which Seam created the warning. */
64588
+ created_at: string;
64589
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
64590
+ message: string;
64591
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
64592
+ warning_code: 'setup_required';
64503
64593
  })[];
64504
64594
  }[];
64505
64595
  };
@@ -70403,6 +70493,13 @@ type Routes = {
70403
70493
  message: string;
70404
70494
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
70405
70495
  warning_code: 'provider_service_unavailable';
70496
+ } | {
70497
+ /** Date and time at which Seam created the warning. */
70498
+ created_at: string;
70499
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
70500
+ message: string;
70501
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
70502
+ warning_code: 'setup_required';
70406
70503
  })[];
70407
70504
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
70408
70505
  custom_metadata: {
@@ -70586,6 +70683,13 @@ type Routes = {
70586
70683
  message: string;
70587
70684
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
70588
70685
  warning_code: 'provider_service_unavailable';
70686
+ } | {
70687
+ /** Date and time at which Seam created the warning. */
70688
+ created_at: string;
70689
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
70690
+ message: string;
70691
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
70692
+ warning_code: 'setup_required';
70589
70693
  })[];
70590
70694
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
70591
70695
  custom_metadata: {
@@ -70803,6 +70907,13 @@ type Routes = {
70803
70907
  message: string;
70804
70908
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
70805
70909
  warning_code: 'provider_service_unavailable';
70910
+ } | {
70911
+ /** Date and time at which Seam created the warning. */
70912
+ created_at: string;
70913
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
70914
+ message: string;
70915
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
70916
+ warning_code: 'setup_required';
70806
70917
  })[];
70807
70918
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
70808
70919
  custom_metadata: {
@@ -113257,6 +113368,13 @@ type Routes = {
113257
113368
  message: string;
113258
113369
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
113259
113370
  warning_code: 'provider_service_unavailable';
113371
+ } | {
113372
+ /** Date and time at which Seam created the warning. */
113373
+ created_at: string;
113374
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
113375
+ message: string;
113376
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
113377
+ warning_code: 'setup_required';
113260
113378
  })[];
113261
113379
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
113262
113380
  custom_metadata: {
@@ -113402,6 +113520,13 @@ type Routes = {
113402
113520
  /**
113403
113521
  * @deprecated this field is deprecated.*/
113404
113522
  misconfigured_acs_entrance_ids?: string[] | undefined;
113523
+ } | {
113524
+ /** Date and time at which Seam created the warning. */
113525
+ created_at: string;
113526
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
113527
+ message: string;
113528
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
113529
+ warning_code: 'setup_required';
113405
113530
  })[];
113406
113531
  }[] | undefined;
113407
113532
  access_methods?: {
@@ -137040,6 +137165,13 @@ type Routes = {
137040
137165
  /**
137041
137166
  * @deprecated this field is deprecated.*/
137042
137167
  misconfigured_acs_entrance_ids?: string[] | undefined;
137168
+ } | {
137169
+ /** Date and time at which Seam created the warning. */
137170
+ created_at: string;
137171
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
137172
+ message: string;
137173
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
137174
+ warning_code: 'setup_required';
137043
137175
  })[];
137044
137176
  }[];
137045
137177
  };
@@ -139570,6 +139702,13 @@ type Routes = {
139570
139702
  /**
139571
139703
  * @deprecated this field is deprecated.*/
139572
139704
  misconfigured_acs_entrance_ids?: string[] | undefined;
139705
+ } | {
139706
+ /** Date and time at which Seam created the warning. */
139707
+ created_at: string;
139708
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
139709
+ message: string;
139710
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
139711
+ warning_code: 'setup_required';
139573
139712
  })[];
139574
139713
  }[] | undefined;
139575
139714
  acs_users?: {
@@ -143066,6 +143205,13 @@ type Routes = {
143066
143205
  message: string;
143067
143206
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
143068
143207
  warning_code: 'provider_service_unavailable';
143208
+ } | {
143209
+ /** Date and time at which Seam created the warning. */
143210
+ created_at: string;
143211
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
143212
+ message: string;
143213
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
143214
+ warning_code: 'setup_required';
143069
143215
  })[];
143070
143216
  /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
143071
143217
  custom_metadata: {
package/dist/index.cjs CHANGED
@@ -700,13 +700,19 @@ var provider_service_unavailable = common_connected_account_warning.extend({
700
700
  }).describe(
701
701
  "Indicates that the connected account's provider service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again."
702
702
  );
703
+ var setup_required = common_connected_account_warning.extend({
704
+ warning_code: zod.z.literal("setup_required").describe(warning_code_description)
705
+ }).describe(
706
+ "Indicates that the connected account requires additional setup before it can be fully operational. Follow the instructions in the warning message to complete the setup."
707
+ );
703
708
  var connected_account_warning = zod.z.discriminatedUnion("warning_code", [
704
709
  scheduled_maintenance_window,
705
710
  unknown_issue_with_connected_account,
706
711
  salto_ks_subscription_limit_almost_reached,
707
712
  account_reauthorization_requested,
708
713
  being_deleted,
709
- provider_service_unavailable
714
+ provider_service_unavailable,
715
+ setup_required
710
716
  ]).describe("Warning associated with the connected account.");
711
717
  zod.z.object({
712
718
  scheduled_maintenance_window: scheduled_maintenance_window.nullable().optional(),
@@ -714,7 +720,8 @@ zod.z.object({
714
720
  salto_ks_subscription_limit_almost_reached: salto_ks_subscription_limit_almost_reached.nullable().optional(),
715
721
  account_reauthorization_requested: account_reauthorization_requested.nullable().optional(),
716
722
  being_deleted: being_deleted.nullable().optional(),
717
- provider_service_unavailable: provider_service_unavailable.nullable().optional()
723
+ provider_service_unavailable: provider_service_unavailable.nullable().optional(),
724
+ setup_required: setup_required.nullable().optional()
718
725
  });
719
726
  var connected_account = zod.z.object({
720
727
  connected_account_id: zod.z.string().uuid().describe("ID of the connected account."),
@@ -4171,15 +4178,22 @@ var time_zone_does_not_match_location = common_acs_system_warning.extend({
4171
4178
  }).describe(
4172
4179
  "Indicates the [access control system](https://docs.seam.co/low-level-apis/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details)."
4173
4180
  );
4181
+ var setup_required2 = common_acs_system_warning.extend({
4182
+ warning_code: zod.z.literal("setup_required").describe(warning_code_description9)
4183
+ }).describe(
4184
+ "Indicates that the access control system requires additional setup before it can be fully operational. Follow the instructions in the warning message to complete the setup."
4185
+ );
4174
4186
  var acs_system_warning = zod.z.discriminatedUnion("warning_code", [
4175
4187
  salto_ks_subscription_limit_almost_reached3,
4176
- time_zone_does_not_match_location
4188
+ time_zone_does_not_match_location,
4189
+ setup_required2
4177
4190
  ]).describe(
4178
4191
  "Warning associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems)."
4179
4192
  );
4180
4193
  zod.z.object({
4181
4194
  salto_ks_subscription_limit_almost_reached: salto_ks_subscription_limit_almost_reached3.optional().nullable(),
4182
- time_zone_does_not_match_location: time_zone_does_not_match_location.optional().nullable()
4195
+ time_zone_does_not_match_location: time_zone_does_not_match_location.optional().nullable(),
4196
+ setup_required: setup_required2.optional().nullable()
4183
4197
  });
4184
4198
  var acs_system = zod.z.object({
4185
4199
  default_credential_manager_acs_system_id: zod.z.string().uuid().nullable().optional().describe(
@@ -12021,6 +12035,27 @@ var openapi = {
12021
12035
  },
12022
12036
  required: ["created_at", "message", "warning_code"],
12023
12037
  type: "object"
12038
+ },
12039
+ {
12040
+ description: "Indicates that the access control system requires additional setup before it can be fully operational. Follow the instructions in the warning message to complete the setup.",
12041
+ properties: {
12042
+ created_at: {
12043
+ description: "Date and time at which Seam created the warning.",
12044
+ format: "date-time",
12045
+ type: "string"
12046
+ },
12047
+ message: {
12048
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
12049
+ type: "string"
12050
+ },
12051
+ warning_code: {
12052
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
12053
+ enum: ["setup_required"],
12054
+ type: "string"
12055
+ }
12056
+ },
12057
+ required: ["created_at", "message", "warning_code"],
12058
+ type: "object"
12024
12059
  }
12025
12060
  ]
12026
12061
  },
@@ -18739,6 +18774,27 @@ var openapi = {
18739
18774
  },
18740
18775
  required: ["created_at", "message", "warning_code"],
18741
18776
  type: "object"
18777
+ },
18778
+ {
18779
+ description: "Indicates that the connected account requires additional setup before it can be fully operational. Follow the instructions in the warning message to complete the setup.",
18780
+ properties: {
18781
+ created_at: {
18782
+ description: "Date and time at which Seam created the warning.",
18783
+ format: "date-time",
18784
+ type: "string"
18785
+ },
18786
+ message: {
18787
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
18788
+ type: "string"
18789
+ },
18790
+ warning_code: {
18791
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
18792
+ enum: ["setup_required"],
18793
+ type: "string"
18794
+ }
18795
+ },
18796
+ required: ["created_at", "message", "warning_code"],
18797
+ type: "object"
18742
18798
  }
18743
18799
  ]
18744
18800
  },