@seamapi/types 1.357.1 → 1.359.0

package/src/lib/seam/connect/openapi.ts

@@ -523,6 +523,12 @@ export default {
                 {
                   description: 'Account is disconnected.',
                   properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -536,6 +542,7 @@ export default {
                     message: { type: 'string' },
                   },
                   required: [
+                    'created_at',
                     'message',
                     'is_connected_account_error',
                     'error_code',
@@ -545,6 +552,12 @@ export default {
                 {
                   description: 'Credentials provided were invalid.',
                   properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -558,12 +571,74 @@ export default {
                     message: { type: 'string' },
                   },
                   required: [
+                    'created_at',
                     'message',
                     'is_connected_account_error',
                     'error_code',
                   ],
                   type: 'object',
                 },
+                {
+                  description:
+                    'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['salto_ks_subscription_limit_exceeded'],
+                      type: 'string',
+                    },
+                    is_connected_account_error: {
+                      enum: [true],
+                      type: 'boolean',
+                    },
+                    message: { type: 'string' },
+                    salto_ks_metadata: {
+                      properties: {
+                        sites: {
+                          items: {
+                            properties: {
+                              site_id: { type: 'string' },
+                              site_name: { type: 'string' },
+                              site_user_subscription_limit: {
+                                minimum: 0,
+                                type: 'integer',
+                              },
+                              subscribed_site_user_count: {
+                                minimum: 0,
+                                type: 'integer',
+                              },
+                            },
+                            required: [
+                              'site_id',
+                              'site_name',
+                              'subscribed_site_user_count',
+                              'site_user_subscription_limit',
+                            ],
+                            type: 'object',
+                          },
+                          type: 'array',
+                        },
+                      },
+                      required: ['sites'],
+                      type: 'object',
+                    },
+                  },
+                  required: [
+                    'created_at',
+                    'message',
+                    'is_connected_account_error',
+                    'error_code',
+                    'salto_ks_metadata',
+                  ],
+                  type: 'object',
+                },
               ],
             },
             type: 'array',
@@ -5260,6 +5335,12 @@ export default {
                 {
                   description: 'Account is disconnected.',
                   properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -5273,6 +5354,7 @@ export default {
                     message: { type: 'string' },
                   },
                   required: [
+                    'created_at',
                     'message',
                     'is_connected_account_error',
                     'error_code',
@@ -5282,6 +5364,12 @@ export default {
                 {
                   description: 'Credentials provided were invalid.',
                   properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -5295,9 +5383,71 @@ export default {
                     message: { type: 'string' },
                   },
                   required: [
+                    'created_at',
+                    'message',
+                    'is_connected_account_error',
+                    'error_code',
+                  ],
+                  type: 'object',
+                },
+                {
+                  description:
+                    'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['salto_ks_subscription_limit_exceeded'],
+                      type: 'string',
+                    },
+                    is_connected_account_error: {
+                      enum: [true],
+                      type: 'boolean',
+                    },
+                    message: { type: 'string' },
+                    salto_ks_metadata: {
+                      properties: {
+                        sites: {
+                          items: {
+                            properties: {
+                              site_id: { type: 'string' },
+                              site_name: { type: 'string' },
+                              site_user_subscription_limit: {
+                                minimum: 0,
+                                type: 'integer',
+                              },
+                              subscribed_site_user_count: {
+                                minimum: 0,
+                                type: 'integer',
+                              },
+                            },
+                            required: [
+                              'site_id',
+                              'site_name',
+                              'subscribed_site_user_count',
+                              'site_user_subscription_limit',
+                            ],
+                            type: 'object',
+                          },
+                          type: 'array',
+                        },
+                      },
+                      required: ['sites'],
+                      type: 'object',
+                    },
+                  },
+                  required: [
+                    'created_at',
                     'message',
                     'is_connected_account_error',
                     'error_code',
+                    'salto_ks_metadata',
                   ],
                   type: 'object',
                 },
@@ -5323,6 +5473,12 @@ export default {
                 {
                   description: 'Scheduled downtime for account planned.',
                   properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the warning.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
                     message: { type: 'string' },
                     warning_code: {
                       description:
@@ -5331,13 +5487,19 @@ export default {
                       type: 'string',
                     },
                   },
-                  required: ['message', 'warning_code'],
+                  required: ['created_at', 'message', 'warning_code'],
                   type: 'object',
                 },
                 {
                   description:
                     'An unknown issue occurred while syncing the state of this connected account with the provider. This issue may affect the proper functioning of one or more resources in this account.',
                   properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the warning.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
                     message: { type: 'string' },
                     warning_code: {
                       description:
@@ -5346,7 +5508,63 @@ export default {
                       type: 'string',
                     },
                   },
-                  required: ['message', 'warning_code'],
+                  required: ['created_at', 'message', 'warning_code'],
+                  type: 'object',
+                },
+                {
+                  description:
+                    'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this.',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the warning.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    message: { type: 'string' },
+                    salto_ks_metadata: {
+                      properties: {
+                        sites: {
+                          items: {
+                            properties: {
+                              site_id: { type: 'string' },
+                              site_name: { type: 'string' },
+                              site_user_subscription_limit: {
+                                minimum: 0,
+                                type: 'integer',
+                              },
+                              subscribed_site_user_count: {
+                                minimum: 0,
+                                type: 'integer',
+                              },
+                            },
+                            required: [
+                              'site_id',
+                              'site_name',
+                              'site_user_subscription_limit',
+                              'subscribed_site_user_count',
+                            ],
+                            type: 'object',
+                          },
+                          type: 'array',
+                        },
+                      },
+                      required: ['sites'],
+                      type: 'object',
+                    },
+                    warning_code: {
+                      description:
+                        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                      enum: ['salto_ks_subscription_limit_almost_reached'],
+                      type: 'string',
+                    },
+                  },
+                  required: [
+                    'created_at',
+                    'message',
+                    'warning_code',
+                    'salto_ks_metadata',
+                  ],
                   type: 'object',
                 },
               ],
@@ -5665,6 +5883,12 @@ export default {
                 {
                   description: 'Account is disconnected.',
                   properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -5678,6 +5902,7 @@ export default {
                     message: { type: 'string' },
                   },
                   required: [
+                    'created_at',
                     'message',
                     'is_connected_account_error',
                     'error_code',
@@ -5687,6 +5912,12 @@ export default {
                 {
                   description: 'Credentials provided were invalid.',
                   properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -5700,12 +5931,74 @@ export default {
                     message: { type: 'string' },
                   },
                   required: [
+                    'created_at',
                     'message',
                     'is_connected_account_error',
                     'error_code',
                   ],
                   type: 'object',
                 },
+                {
+                  description:
+                    'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['salto_ks_subscription_limit_exceeded'],
+                      type: 'string',
+                    },
+                    is_connected_account_error: {
+                      enum: [true],
+                      type: 'boolean',
+                    },
+                    message: { type: 'string' },
+                    salto_ks_metadata: {
+                      properties: {
+                        sites: {
+                          items: {
+                            properties: {
+                              site_id: { type: 'string' },
+                              site_name: { type: 'string' },
+                              site_user_subscription_limit: {
+                                minimum: 0,
+                                type: 'integer',
+                              },
+                              subscribed_site_user_count: {
+                                minimum: 0,
+                                type: 'integer',
+                              },
+                            },
+                            required: [
+                              'site_id',
+                              'site_name',
+                              'subscribed_site_user_count',
+                              'site_user_subscription_limit',
+                            ],
+                            type: 'object',
+                          },
+                          type: 'array',
+                        },
+                      },
+                      required: ['sites'],
+                      type: 'object',
+                    },
+                  },
+                  required: [
+                    'created_at',
+                    'message',
+                    'is_connected_account_error',
+                    'error_code',
+                    'salto_ks_metadata',
+                  ],
+                  type: 'object',
+                },
               ],
             },
             type: 'array',
@@ -11814,6 +12107,30 @@ export default {
         type: 'object',
         'x-route-path': '/noise_sensors/noise_thresholds',
       },
+      pagination: {
+        description: 'Information about the current page of results.',
+        properties: {
+          has_next_page: {
+            description:
+              'Indicates whether there is another page of results after this one.',
+            type: 'boolean',
+          },
+          next_page_cursor: {
+            description:
+              'Opaque value that can be used to select the next page of results via the `page_cursor` parameter.',
+            nullable: true,
+            type: 'string',
+          },
+          next_page_url: {
+            description: 'URL to get the next page of results.',
+            format: 'uri',
+            nullable: true,
+            type: 'string',
+          },
+        },
+        required: ['next_page_cursor', 'has_next_page', 'next_page_url'],
+        type: 'object',
+      },
       phone: {
         description: "Represents an app user's mobile phone.",
         properties: {
@@ -12543,6 +12860,12 @@ export default {
                 {
                   description: 'Account is disconnected.',
                   properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -12556,6 +12879,7 @@ export default {
                     message: { type: 'string' },
                   },
                   required: [
+                    'created_at',
                     'message',
                     'is_connected_account_error',
                     'error_code',
@@ -12565,6 +12889,12 @@ export default {
                 {
                   description: 'Credentials provided were invalid.',
                   properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -12578,12 +12908,74 @@ export default {
                     message: { type: 'string' },
                   },
                   required: [
+                    'created_at',
                     'message',
                     'is_connected_account_error',
                     'error_code',
                   ],
                   type: 'object',
                 },
+                {
+                  description:
+                    'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['salto_ks_subscription_limit_exceeded'],
+                      type: 'string',
+                    },
+                    is_connected_account_error: {
+                      enum: [true],
+                      type: 'boolean',
+                    },
+                    message: { type: 'string' },
+                    salto_ks_metadata: {
+                      properties: {
+                        sites: {
+                          items: {
+                            properties: {
+                              site_id: { type: 'string' },
+                              site_name: { type: 'string' },
+                              site_user_subscription_limit: {
+                                minimum: 0,
+                                type: 'integer',
+                              },
+                              subscribed_site_user_count: {
+                                minimum: 0,
+                                type: 'integer',
+                              },
+                            },
+                            required: [
+                              'site_id',
+                              'site_name',
+                              'subscribed_site_user_count',
+                              'site_user_subscription_limit',
+                            ],
+                            type: 'object',
+                          },
+                          type: 'array',
+                        },
+                      },
+                      required: ['sites'],
+                      type: 'object',
+                    },
+                  },
+                  required: [
+                    'created_at',
+                    'message',
+                    'is_connected_account_error',
+                    'error_code',
+                    'salto_ks_metadata',
+                  ],
+                  type: 'object',
+                },
               ],
             },
             type: 'array',
@@ -13862,6 +14254,12 @@ export default {
                 {
                   description: 'Account is disconnected.',
                   properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -13875,6 +14273,7 @@ export default {
                     message: { type: 'string' },
                   },
                   required: [
+                    'created_at',
                     'message',
                     'is_connected_account_error',
                     'error_code',
@@ -13884,6 +14283,12 @@ export default {
                 {
                   description: 'Credentials provided were invalid.',
                   properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -13897,9 +14302,71 @@ export default {
                     message: { type: 'string' },
                   },
                   required: [
+                    'created_at',
+                    'message',
+                    'is_connected_account_error',
+                    'error_code',
+                  ],
+                  type: 'object',
+                },
+                {
+                  description:
+                    'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['salto_ks_subscription_limit_exceeded'],
+                      type: 'string',
+                    },
+                    is_connected_account_error: {
+                      enum: [true],
+                      type: 'boolean',
+                    },
+                    message: { type: 'string' },
+                    salto_ks_metadata: {
+                      properties: {
+                        sites: {
+                          items: {
+                            properties: {
+                              site_id: { type: 'string' },
+                              site_name: { type: 'string' },
+                              site_user_subscription_limit: {
+                                minimum: 0,
+                                type: 'integer',
+                              },
+                              subscribed_site_user_count: {
+                                minimum: 0,
+                                type: 'integer',
+                              },
+                            },
+                            required: [
+                              'site_id',
+                              'site_name',
+                              'subscribed_site_user_count',
+                              'site_user_subscription_limit',
+                            ],
+                            type: 'object',
+                          },
+                          type: 'array',
+                        },
+                      },
+                      required: ['sites'],
+                      type: 'object',
+                    },
+                  },
+                  required: [
+                    'created_at',
                     'message',
                     'is_connected_account_error',
                     'error_code',
+                    'salto_ks_metadata',
                   ],
                   type: 'object',
                 },
@@ -18794,35 +19261,7 @@ export default {
                       type: 'array',
                     },
                     ok: { type: 'boolean' },
-                    pagination: {
-                      description:
-                        'Information about the current page of results.',
-                      properties: {
-                        has_next_page: {
-                          description:
-                            'Indicates whether there is another page of results after this one.',
-                          type: 'boolean',
-                        },
-                        next_page_cursor: {
-                          description:
-                            'Opaque value that can be used to select the next page of results via the `page_cursor` parameter.',
-                          nullable: true,
-                          type: 'string',
-                        },
-                        next_page_url: {
-                          description: 'URL to get the next page of results.',
-                          format: 'uri',
-                          nullable: true,
-                          type: 'string',
-                        },
-                      },
-                      required: [
-                        'next_page_cursor',
-                        'has_next_page',
-                        'next_page_url',
-                      ],
-                      type: 'object',
-                    },
+                    pagination: { $ref: '#/components/schemas/pagination' },
                   },
                   required: ['acs_users', 'pagination', 'ok'],
                   type: 'object',