@seamapi/http 2.0.0 → 2.2.0

package/src/lib/seam/connect/resources/unmanaged-user-identity.ts

@@ -3,46 +3,122 @@
  * Do not edit this file.
  */
 
+/**
+ * Represents an unmanaged user identity. Unmanaged user identities do not have keys.
+ */
 export type UnmanagedUserIdentity = {
+  /**
+   * Array of access system user IDs associated with the user identity.
+   */
   acs_user_ids: Array<string>
 
+  /**
+   * Date and time at which the user identity was created.
+   */
   created_at: string
 
+  /**
+   * Display name for the user identity.
+   */
   display_name: string
 
+  /**
+   * Unique email address for the user identity.
+   */
   email_address: string | null
-  errors: Array<{
-    acs_system_id: string
+  /**
+   * Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
+   */
+  errors: Array<
+    /**
+     * Indicates that there is an issue with an access system user associated with this user identity.
+     */
+    {
+      /**
+       * ID of the access system that the user identity is associated with.
+       */
+      acs_system_id: string
 
-    acs_user_id: string
+      /**
+       * ID of the access system user that has an issue.
+       */
+      acs_user_id: string
 
-    created_at: string
+      /**
+       * Date and time at which Seam created the error.
+       */
+      created_at: string
 
-    error_code: 'issue_with_acs_user'
+      /**
+       * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+       */
+      error_code: 'issue_with_acs_user'
 
-    message: string
-  }>
+      /**
+       * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+       */
+      message: string
+    }
+  >
 
+  /**
+   * Full name of the user associated with the user identity.
+   */
   full_name: string | null
+  /**
+   * Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
+   */
   phone_number: string | null
+  /**
+   * ID of the user identity.
+   */
   user_identity_id: string
 
+  /**
+   * Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
+   */
   warnings: Array<
+    /**
+     * Indicates that the user identity is currently being deleted.
+     */
     | {
+        /**
+         * Date and time at which Seam created the warning.
+         */
         created_at: string
 
+        /**
+         * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+         */
         message: string
 
+        /**
+         * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+         */
         warning_code: 'being_deleted'
-      }
+      } /**
+     * Indicates that the ACS user's profile does not match the user identity's profile
+     */
     | {
+        /**
+         * Date and time at which Seam created the warning.
+         */
         created_at: string
 
+        /**
+         * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+         */
         message: string
 
+        /**
+         * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+         */
         warning_code: 'acs_user_profile_does_not_match_user_identity'
       }
   >
 
+  /**
+   * ID of the workspace that contains the user identity.
+   */
   workspace_id: string
 }

package/src/lib/seam/connect/resources/user-identity.ts

@@ -3,47 +3,126 @@
  * Do not edit this file.
  */
 
+/**
+ * Represents a [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.
+ */
 export type UserIdentity = {
+  /**
+   * Array of access system user IDs associated with the user identity.
+   */
   acs_user_ids: Array<string>
 
+  /**
+   * Date and time at which the user identity was created.
+   */
   created_at: string
 
+  /**
+   * Display name for the user identity.
+   */
   display_name: string
 
+  /**
+   * Unique email address for the user identity.
+   */
   email_address: string | null
-  errors: Array<{
-    acs_system_id: string
+  /**
+   * Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
+   */
+  errors: Array<
+    /**
+     * Indicates that there is an issue with an access system user associated with this user identity.
+     */
+    {
+      /**
+       * ID of the access system that the user identity is associated with.
+       */
+      acs_system_id: string
 
-    acs_user_id: string
+      /**
+       * ID of the access system user that has an issue.
+       */
+      acs_user_id: string
 
-    created_at: string
+      /**
+       * Date and time at which Seam created the error.
+       */
+      created_at: string
 
-    error_code: 'issue_with_acs_user'
+      /**
+       * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+       */
+      error_code: 'issue_with_acs_user'
 
-    message: string
-  }>
+      /**
+       * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+       */
+      message: string
+    }
+  >
 
+  /**
+   * Full name of the user associated with the user identity.
+   */
   full_name: string | null
+  /**
+   * Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
+   */
   phone_number: string | null
+  /**
+   * ID of the user identity.
+   */
   user_identity_id: string
 
+  /**
+   * Unique key for the user identity.
+   */
   user_identity_key: string | null
+  /**
+   * Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
+   */
   warnings: Array<
+    /**
+     * Indicates that the user identity is currently being deleted.
+     */
     | {
+        /**
+         * Date and time at which Seam created the warning.
+         */
         created_at: string
 
+        /**
+         * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+         */
         message: string
 
+        /**
+         * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+         */
         warning_code: 'being_deleted'
-      }
+      } /**
+     * Indicates that the ACS user's profile does not match the user identity's profile
+     */
     | {
+        /**
+         * Date and time at which Seam created the warning.
+         */
         created_at: string
 
+        /**
+         * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+         */
         message: string
 
+        /**
+         * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+         */
         warning_code: 'acs_user_profile_does_not_match_user_identity'
       }
   >
 
+  /**
+   * ID of the workspace that contains the user identity.
+   */
   workspace_id: string
 }

package/src/lib/seam/connect/resources/webhook.ts

@@ -3,10 +3,25 @@
  * Do not edit this file.
  */
 
+/**
+ * Represents a [webhook](https://docs.seam.co/developer-tools/webhooks) that enables you to receive notifications of events. When you create a webhook, specify the endpoint URL at which you want to receive events and the set of event types that you want to receive.
+ */
 export type Webhook = {
+  /**
+   * Types of events that the [webhook](https://docs.seam.co/developer-tools/webhooks) should receive.
+   */
   event_types?: Array<string> | undefined
+  /**
+   * Secret associated with the [webhook](https://docs.seam.co/developer-tools/webhooks).
+   */
   secret?: string | undefined
+  /**
+   * URL for the [webhook](https://docs.seam.co/developer-tools/webhooks).
+   */
   url: string
 
+  /**
+   * ID of the webhook.
+   */
   webhook_id: string
 }

package/src/lib/seam/connect/resources/workspace.ts

@@ -3,27 +3,73 @@
  * Do not edit this file.
  */
 
+/**
+ * Represents a Seam [workspace](https://docs.seam.co/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/core-concepts/workspaces#production-workspaces).
+ */
 export type Workspace = {
+  /**
+   * Company name associated with the [workspace](https://docs.seam.co/core-concepts/workspaces).
+   */
   company_name: string
 
+  /**
+   * @deprecated Use `company_name` instead.
+   */
   connect_partner_name: string | null
+
   connect_webview_customization: {
+    /**
+     * URL of the inviter logo for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
+     */
     inviter_logo_url?: string | undefined
+    /**
+     * Logo shape for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
+     */
     logo_shape?: 'circle' | 'square' | undefined
+    /**
+     * Primary button color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
+     */
     primary_button_color?: string | undefined
+    /**
+     * Primary button text color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
+     */
     primary_button_text_color?: string | undefined
+    /**
+     * Success message for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
+     */
     success_message?: string | undefined
   }
 
+  /**
+   * Indicates whether publishable key authentication is enabled for this workspace.
+   */
   is_publishable_key_auth_enabled: boolean
 
+  /**
+   * Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+   */
   is_sandbox: boolean
 
+  /**
+   * Indicates whether the [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days.
+   */
   is_suspended: boolean
 
+  /**
+   * Name of the [workspace](https://docs.seam.co/core-concepts/workspaces).
+   */
   name: string
 
+  /**
+   * ID of the organization to which the workspace belongs, or `null` if the workspace is not assigned to an organization.
+   */
   organization_id: string | null
+  /**
+   * Publishable key for the [workspace](https://docs.seam.co/core-concepts/workspaces). This key is used to identify the workspace in client-side applications.
+   */
   publishable_key?: string | undefined
+  /**
+   * ID of the workspace.
+   */
   workspace_id: string
 }