@seamapi/types 1.1118.0 → 1.1120.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.
Files changed (16) hide show
  1. package/lib/seam/connect/models/access-grants/access-grant.d.ts +74 -15
  2. package/lib/seam/connect/models/access-grants/access-grant.js +12 -2
  3. package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
  4. package/lib/seam/connect/models/access-grants/access-method.d.ts +96 -0
  5. package/lib/seam/connect/models/access-grants/access-method.js +15 -0
  6. package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
  7. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +43 -0
  8. package/lib/seam/connect/models/action-attempts/assign-credential.d.ts +43 -0
  9. package/lib/seam/connect/openapi.js +143 -6
  10. package/lib/seam/connect/openapi.js.map +1 -1
  11. package/lib/seam/connect/route-types.d.ts +804 -238
  12. package/package.json +1 -1
  13. package/src/lib/seam/connect/models/access-grants/access-grant.ts +16 -2
  14. package/src/lib/seam/connect/models/access-grants/access-method.ts +18 -0
  15. package/src/lib/seam/connect/openapi.ts +169 -6
  16. package/src/lib/seam/connect/route-types.ts +637 -22
package/lib/seam/connect/openapi.js CHANGED
@@ -2002,15 +2002,20 @@ const openapi = {
2002
2002
  type: 'object',
2003
2003
  },
2004
2004
  {
2005
- description: 'Indicates that the requested PIN code was already in use on a device, so a different code was assigned.',
2005
+ description: 'Indicates that the requested PIN code could not be used, so a different code was assigned. For example, the code was already in use on a device, or the access system rejected it because it did not meet its PIN rules.',
2006
2006
  properties: {
2007
+ access_method_id: {
2008
+ description: 'ID of the access method whose requested code was unavailable. Present when an access system, such as Salto KS, assigned a different code.',
2009
+ format: 'uuid',
2010
+ type: 'string',
2011
+ },
2007
2012
  created_at: {
2008
2013
  description: 'Date and time at which Seam created the warning.',
2009
2014
  format: 'date-time',
2010
2015
  type: 'string',
2011
2016
  },
2012
2017
  device_id: {
2013
- description: 'ID of the device where the requested code was unavailable.',
2018
+ description: 'ID of the device where the requested code was unavailable. Present when the code was set directly on a device.',
2014
2019
  format: 'uuid',
2015
2020
  type: 'string',
2016
2021
  },
@@ -2036,7 +2041,6 @@ const openapi = {
2036
2041
  'created_at',
2037
2042
  'message',
2038
2043
  'warning_code',
2039
- 'device_id',
2040
2044
  'original_code',
2041
2045
  'new_code',
2042
2046
  ],
@@ -2605,6 +2609,41 @@ const openapi = {
2605
2609
  required: ['created_at', 'message', 'warning_code'],
2606
2610
  type: 'object',
2607
2611
  },
2612
+ {
2613
+ description: "Indicates that the access system could not use the PIN code requested for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), for example because it did not meet the access system's PIN rules, so the access system assigned a different code. Give the recipient the assigned code.",
2614
+ properties: {
2615
+ created_at: {
2616
+ description: 'Date and time at which Seam created the warning.',
2617
+ format: 'date-time',
2618
+ type: 'string',
2619
+ },
2620
+ message: {
2621
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
2622
+ type: 'string',
2623
+ },
2624
+ new_code: {
2625
+ description: 'The PIN code that was assigned instead.',
2626
+ type: 'string',
2627
+ },
2628
+ original_code: {
2629
+ description: 'The originally requested PIN code that could not be used.',
2630
+ type: 'string',
2631
+ },
2632
+ warning_code: {
2633
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
2634
+ enum: ['requested_code_unavailable'],
2635
+ type: 'string',
2636
+ },
2637
+ },
2638
+ required: [
2639
+ 'created_at',
2640
+ 'message',
2641
+ 'warning_code',
2642
+ 'original_code',
2643
+ 'new_code',
2644
+ ],
2645
+ type: 'object',
2646
+ },
2608
2647
  ],
2609
2648
  },
2610
2649
  type: 'array',
@@ -9178,6 +9217,41 @@ const openapi = {
9178
9217
  required: ['created_at', 'message', 'warning_code'],
9179
9218
  type: 'object',
9180
9219
  },
9220
+ {
9221
+ description: "Indicates that the access system could not use the PIN code requested for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), for example because it did not meet the access system's PIN rules, so the access system assigned a different code. Give the recipient the assigned code.",
9222
+ properties: {
9223
+ created_at: {
9224
+ description: 'Date and time at which Seam created the warning.',
9225
+ format: 'date-time',
9226
+ type: 'string',
9227
+ },
9228
+ message: {
9229
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
9230
+ type: 'string',
9231
+ },
9232
+ new_code: {
9233
+ description: 'The PIN code that was assigned instead.',
9234
+ type: 'string',
9235
+ },
9236
+ original_code: {
9237
+ description: 'The originally requested PIN code that could not be used.',
9238
+ type: 'string',
9239
+ },
9240
+ warning_code: {
9241
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
9242
+ enum: ['requested_code_unavailable'],
9243
+ type: 'string',
9244
+ },
9245
+ },
9246
+ required: [
9247
+ 'created_at',
9248
+ 'message',
9249
+ 'warning_code',
9250
+ 'original_code',
9251
+ 'new_code',
9252
+ ],
9253
+ type: 'object',
9254
+ },
9181
9255
  ],
9182
9256
  },
9183
9257
  type: 'array',
@@ -32978,15 +33052,20 @@ const openapi = {
32978
33052
  type: 'object',
32979
33053
  },
32980
33054
  {
32981
- description: 'Indicates that the requested PIN code was already in use on a device, so a different code was assigned.',
33055
+ description: 'Indicates that the requested PIN code could not be used, so a different code was assigned. For example, the code was already in use on a device, or the access system rejected it because it did not meet its PIN rules.',
32982
33056
  properties: {
33057
+ access_method_id: {
33058
+ description: 'ID of the access method whose requested code was unavailable. Present when an access system, such as Salto KS, assigned a different code.',
33059
+ format: 'uuid',
33060
+ type: 'string',
33061
+ },
32983
33062
  created_at: {
32984
33063
  description: 'Date and time at which Seam created the warning.',
32985
33064
  format: 'date-time',
32986
33065
  type: 'string',
32987
33066
  },
32988
33067
  device_id: {
32989
- description: 'ID of the device where the requested code was unavailable.',
33068
+ description: 'ID of the device where the requested code was unavailable. Present when the code was set directly on a device.',
32990
33069
  format: 'uuid',
32991
33070
  type: 'string',
32992
33071
  },
@@ -33012,7 +33091,6 @@ const openapi = {
33012
33091
  'created_at',
33013
33092
  'message',
33014
33093
  'warning_code',
33015
- 'device_id',
33016
33094
  'original_code',
33017
33095
  'new_code',
33018
33096
  ],
@@ -33565,6 +33643,41 @@ const openapi = {
33565
33643
  required: ['created_at', 'message', 'warning_code'],
33566
33644
  type: 'object',
33567
33645
  },
33646
+ {
33647
+ description: "Indicates that the access system could not use the PIN code requested for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), for example because it did not meet the access system's PIN rules, so the access system assigned a different code. Give the recipient the assigned code.",
33648
+ properties: {
33649
+ created_at: {
33650
+ description: 'Date and time at which Seam created the warning.',
33651
+ format: 'date-time',
33652
+ type: 'string',
33653
+ },
33654
+ message: {
33655
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
33656
+ type: 'string',
33657
+ },
33658
+ new_code: {
33659
+ description: 'The PIN code that was assigned instead.',
33660
+ type: 'string',
33661
+ },
33662
+ original_code: {
33663
+ description: 'The originally requested PIN code that could not be used.',
33664
+ type: 'string',
33665
+ },
33666
+ warning_code: {
33667
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
33668
+ enum: ['requested_code_unavailable'],
33669
+ type: 'string',
33670
+ },
33671
+ },
33672
+ required: [
33673
+ 'created_at',
33674
+ 'message',
33675
+ 'warning_code',
33676
+ 'original_code',
33677
+ 'new_code',
33678
+ ],
33679
+ type: 'object',
33680
+ },
33568
33681
  ],
33569
33682
  },
33570
33683
  type: 'array',
@@ -57586,6 +57699,12 @@ const openapi = {
57586
57699
  type: 'string',
57587
57700
  },
57588
57701
  prefer_guest_phone_last4_as_code: {
57702
+ deprecated: true,
57703
+ type: 'boolean',
57704
+ 'x-deprecated': 'Use `prefer_guest_phone_last_digits_as_code`.',
57705
+ },
57706
+ prefer_guest_phone_last_digits_as_code: {
57707
+ description: "Use the last digits of the guest's phone number as the PIN code. The code length is one that all locks in the reservation's spaces support, and digits that form a weak PIN, such as 0303, 1111, or 1234, are skipped in favor of a longer code.",
57589
57708
  type: 'boolean',
57590
57709
  },
57591
57710
  },
@@ -57975,6 +58094,12 @@ const openapi = {
57975
58094
  type: 'string',
57976
58095
  },
57977
58096
  prefer_guest_phone_last4_as_code: {
58097
+ deprecated: true,
58098
+ type: 'boolean',
58099
+ 'x-deprecated': 'Use `prefer_guest_phone_last_digits_as_code`.',
58100
+ },
58101
+ prefer_guest_phone_last_digits_as_code: {
58102
+ description: "Use the last digits of the guest's phone number as the PIN code. The code length is one that all locks in the reservation's spaces support, and digits that form a weak PIN, such as 0303, 1111, or 1234, are skipped in favor of a longer code.",
57978
58103
  type: 'boolean',
57979
58104
  },
57980
58105
  },
@@ -59383,6 +59508,12 @@ const openapi = {
59383
59508
  type: 'string',
59384
59509
  },
59385
59510
  prefer_guest_phone_last4_as_code: {
59511
+ deprecated: true,
59512
+ type: 'boolean',
59513
+ 'x-deprecated': 'Use `prefer_guest_phone_last_digits_as_code`.',
59514
+ },
59515
+ prefer_guest_phone_last_digits_as_code: {
59516
+ description: "Use the last digits of the guest's phone number as the PIN code. The code length is one that all locks in the reservation's spaces support, and digits that form a weak PIN, such as 0303, 1111, or 1234, are skipped in favor of a longer code.",
59386
59517
  type: 'boolean',
59387
59518
  },
59388
59519
  },
@@ -59789,6 +59920,12 @@ const openapi = {
59789
59920
  type: 'string',
59790
59921
  },
59791
59922
  prefer_guest_phone_last4_as_code: {
59923
+ deprecated: true,
59924
+ type: 'boolean',
59925
+ 'x-deprecated': 'Use `prefer_guest_phone_last_digits_as_code`.',
59926
+ },
59927
+ prefer_guest_phone_last_digits_as_code: {
59928
+ description: "Use the last digits of the guest's phone number as the PIN code. The code length is one that all locks in the reservation's spaces support, and digits that form a weak PIN, such as 0303, 1111, or 1234, are skipped in favor of a longer code.",
59792
59929
  type: 'boolean',
59793
59930
  },
59794
59931
  },