@seamapi/types 1.403.0 → 1.404.1

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.
Files changed (16) hide show
  1. package/dist/connect.cjs +120 -34
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +107 -5
  4. package/lib/seam/connect/models/connect-webviews/connect-webview.js +55 -15
  5. package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
  6. package/lib/seam/connect/models/custom-metadata.js +5 -2
  7. package/lib/seam/connect/models/custom-metadata.js.map +1 -1
  8. package/lib/seam/connect/openapi.d.ts +33 -1
  9. package/lib/seam/connect/openapi.js +76 -15
  10. package/lib/seam/connect/openapi.js.map +1 -1
  11. package/lib/seam/connect/route-types.d.ts +74 -4
  12. package/package.json +1 -1
  13. package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +79 -15
  14. package/src/lib/seam/connect/models/custom-metadata.ts +8 -4
  15. package/src/lib/seam/connect/openapi.ts +95 -15
  16. package/src/lib/seam/connect/route-types.ts +74 -4
package/lib/seam/connect/openapi.d.ts CHANGED
@@ -2925,6 +2925,7 @@ declare const _default: {
2925
2925
  'x-undocumented': string;
2926
2926
  };
2927
2927
  accepted_providers: {
2928
+ description: string;
2928
2929
  items: {
2929
2930
  type: string;
2930
2931
  };
@@ -2937,26 +2938,32 @@ declare const _default: {
2937
2938
  'x-undocumented': string;
2938
2939
  };
2939
2940
  any_provider_allowed: {
2941
+ description: string;
2940
2942
  type: string;
2941
2943
  };
2942
2944
  authorized_at: {
2945
+ description: string;
2943
2946
  format: string;
2944
2947
  nullable: boolean;
2945
2948
  type: string;
2946
2949
  };
2947
2950
  automatically_manage_new_devices: {
2951
+ description: string;
2948
2952
  type: string;
2949
2953
  };
2950
2954
  connect_webview_id: {
2955
+ description: string;
2951
2956
  format: string;
2952
2957
  type: string;
2953
2958
  };
2954
2959
  connected_account_id: {
2960
+ description: string;
2955
2961
  format: string;
2956
2962
  nullable: boolean;
2957
2963
  type: string;
2958
2964
  };
2959
2965
  created_at: {
2966
+ description: string;
2960
2967
  format: string;
2961
2968
  type: string;
2962
2969
  };
@@ -2966,14 +2973,17 @@ declare const _default: {
2966
2973
  type: string;
2967
2974
  }[];
2968
2975
  };
2976
+ description: string;
2969
2977
  type: string;
2970
2978
  };
2971
2979
  custom_redirect_failure_url: {
2980
+ description: string;
2972
2981
  format: string;
2973
2982
  nullable: boolean;
2974
2983
  type: string;
2975
2984
  };
2976
2985
  custom_redirect_url: {
2986
+ description: string;
2977
2987
  format: string;
2978
2988
  nullable: boolean;
2979
2989
  type: string;
@@ -2983,24 +2993,30 @@ declare const _default: {
2983
2993
  type: string;
2984
2994
  };
2985
2995
  login_successful: {
2996
+ description: string;
2986
2997
  type: string;
2987
2998
  };
2988
2999
  selected_provider: {
3000
+ description: string;
2989
3001
  nullable: boolean;
2990
3002
  type: string;
2991
3003
  };
2992
3004
  status: {
3005
+ description: string;
2993
3006
  enum: string[];
2994
3007
  type: string;
2995
3008
  };
2996
3009
  url: {
3010
+ description: string;
2997
3011
  format: string;
2998
3012
  type: string;
2999
3013
  };
3000
3014
  wait_for_device_creation: {
3015
+ description: string;
3001
3016
  type: string;
3002
3017
  };
3003
3018
  workspace_id: {
3019
+ description: string;
3004
3020
  format: string;
3005
3021
  type: string;
3006
3022
  };
@@ -3035,6 +3051,7 @@ declare const _default: {
3035
3051
  type: string;
3036
3052
  }[];
3037
3053
  };
3054
+ description: string;
3038
3055
  type: string;
3039
3056
  };
3040
3057
  errors: {
@@ -3289,6 +3306,7 @@ declare const _default: {
3289
3306
  type: string;
3290
3307
  }[];
3291
3308
  };
3309
+ description: string;
3292
3310
  type: string;
3293
3311
  };
3294
3312
  device_id: {
@@ -16865,13 +16883,22 @@ declare const _default: {
16865
16883
  'application/json': {
16866
16884
  schema: {
16867
16885
  properties: {
16886
+ acs_system_id: {
16887
+ description: string;
16888
+ format: string;
16889
+ type: string;
16890
+ };
16868
16891
  acs_user_id: {
16869
16892
  description: string;
16870
16893
  format: string;
16871
16894
  type: string;
16872
16895
  };
16896
+ user_identity_id: {
16897
+ description: string;
16898
+ format: string;
16899
+ type: string;
16900
+ };
16873
16901
  };
16874
- required: string[];
16875
16902
  type: string;
16876
16903
  };
16877
16904
  };
@@ -16956,6 +16983,11 @@ declare const _default: {
16956
16983
  format: string;
16957
16984
  type: string;
16958
16985
  };
16986
+ user_identity_id: {
16987
+ description: string;
16988
+ format: string;
16989
+ type: string;
16990
+ };
16959
16991
  };
16960
16992
  required: string[];
16961
16993
  type: string;
package/lib/seam/connect/openapi.js CHANGED
@@ -6450,39 +6450,62 @@ export default {
6450
6450
  'x-deprecated': 'Unused. Will be removed.',
6451
6451
  'x-undocumented': 'Unused. Will be removed.',
6452
6452
  },
6453
- accepted_providers: { items: { type: 'string' }, type: 'array' },
6453
+ accepted_providers: {
6454
+ description: 'List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).',
6455
+ items: { type: 'string' },
6456
+ type: 'array',
6457
+ },
6454
6458
  any_device_allowed: {
6455
6459
  deprecated: true,
6456
6460
  type: 'boolean',
6457
6461
  'x-deprecated': 'Unused. Will be removed.',
6458
6462
  'x-undocumented': 'Unused. Will be removed.',
6459
6463
  },
6460
- any_provider_allowed: { type: 'boolean' },
6464
+ any_provider_allowed: {
6465
+ description: 'Indicates whether any provider is allowed.',
6466
+ type: 'boolean',
6467
+ },
6461
6468
  authorized_at: {
6469
+ description: 'Date and time at which the user authorized (through the Connect Webview) the management of their devices.',
6462
6470
  format: 'date-time',
6463
6471
  nullable: true,
6464
6472
  type: 'string',
6465
6473
  },
6466
- automatically_manage_new_devices: { type: 'boolean' },
6467
- connect_webview_id: { format: 'uuid', type: 'string' },
6474
+ automatically_manage_new_devices: {
6475
+ description: 'Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.',
6476
+ type: 'boolean',
6477
+ },
6478
+ connect_webview_id: {
6479
+ description: 'ID of the Connect Webview.',
6480
+ format: 'uuid',
6481
+ type: 'string',
6482
+ },
6468
6483
  connected_account_id: {
6484
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview.',
6469
6485
  format: 'uuid',
6470
6486
  nullable: true,
6471
6487
  type: 'string',
6472
6488
  },
6473
- created_at: { format: 'date-time', type: 'string' },
6489
+ created_at: {
6490
+ description: 'Date and time at which the Connect Webview was created.',
6491
+ format: 'date-time',
6492
+ type: 'string',
6493
+ },
6474
6494
  custom_metadata: {
6475
6495
  additionalProperties: {
6476
6496
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
6477
6497
  },
6498
+ description: 'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
6478
6499
  type: 'object',
6479
6500
  },
6480
6501
  custom_redirect_failure_url: {
6502
+ description: 'URL to which the Connect Webview should redirect when an unexpected error occurs.',
6481
6503
  format: 'uri',
6482
6504
  nullable: true,
6483
6505
  type: 'string',
6484
6506
  },
6485
6507
  custom_redirect_url: {
6508
+ description: 'URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs.',
6486
6509
  format: 'uri',
6487
6510
  nullable: true,
6488
6511
  type: 'string',
@@ -6491,12 +6514,34 @@ export default {
6491
6514
  enum: ['none', 'single', 'multiple'],
6492
6515
  type: 'string',
6493
6516
  },
6494
- login_successful: { type: 'boolean' },
6495
- selected_provider: { nullable: true, type: 'string' },
6496
- status: { enum: ['pending', 'failed', 'authorized'], type: 'string' },
6497
- url: { format: 'uri', type: 'string' },
6498
- wait_for_device_creation: { type: 'boolean' },
6499
- workspace_id: { format: 'uuid', type: 'string' },
6517
+ login_successful: {
6518
+ description: 'Indicates whether the user logged in successfully using the Connect Webview.',
6519
+ type: 'boolean',
6520
+ },
6521
+ selected_provider: {
6522
+ description: 'Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).',
6523
+ nullable: true,
6524
+ type: 'string',
6525
+ },
6526
+ status: {
6527
+ description: 'Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview.',
6528
+ enum: ['pending', 'failed', 'authorized'],
6529
+ type: 'string',
6530
+ },
6531
+ url: {
6532
+ description: 'URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.',
6533
+ format: 'uri',
6534
+ type: 'string',
6535
+ },
6536
+ wait_for_device_creation: {
6537
+ description: 'Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.',
6538
+ type: 'boolean',
6539
+ },
6540
+ workspace_id: {
6541
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview.',
6542
+ format: 'uuid',
6543
+ type: 'string',
6544
+ },
6500
6545
  },
6501
6546
  required: [
6502
6547
  'connect_webview_id',
@@ -6534,6 +6579,7 @@ export default {
6534
6579
  additionalProperties: {
6535
6580
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
6536
6581
  },
6582
+ description: 'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
6537
6583
  type: 'object',
6538
6584
  },
6539
6585
  errors: {
@@ -6821,6 +6867,7 @@ export default {
6821
6867
  additionalProperties: {
6822
6868
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
6823
6869
  },
6870
+ description: 'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
6824
6871
  type: 'object',
6825
6872
  },
6826
6873
  device_id: {
@@ -22830,13 +22877,22 @@ export default {
22830
22877
  'application/json': {
22831
22878
  schema: {
22832
22879
  properties: {
22880
+ acs_system_id: {
22881
+ description: 'ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id.',
22882
+ format: 'uuid',
22883
+ type: 'string',
22884
+ },
22833
22885
  acs_user_id: {
22834
- description: 'ID of the access system user for whom you want to list accessible entrances.',
22886
+ description: 'ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.',
22887
+ format: 'uuid',
22888
+ type: 'string',
22889
+ },
22890
+ user_identity_id: {
22891
+ description: 'ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.',
22835
22892
  format: 'uuid',
22836
22893
  type: 'string',
22837
22894
  },
22838
22895
  },
22839
- required: ['acs_user_id'],
22840
22896
  type: 'object',
22841
22897
  },
22842
22898
  },
@@ -22894,12 +22950,17 @@ export default {
22894
22950
  type: 'string',
22895
22951
  },
22896
22952
  acs_user_id: {
22897
- description: 'ID of the access system user that you want to remove from an access group.',
22953
+ description: 'ID of the access system user that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.',
22954
+ format: 'uuid',
22955
+ type: 'string',
22956
+ },
22957
+ user_identity_id: {
22958
+ description: 'ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.',
22898
22959
  format: 'uuid',
22899
22960
  type: 'string',
22900
22961
  },
22901
22962
  },
22902
- required: ['acs_user_id', 'acs_access_group_id'],
22963
+ required: ['acs_access_group_id'],
22903
22964
  type: 'object',
22904
22965
  },
22905
22966
  },