@spaceinvoices/js-sdk 13.16.0 → 13.16.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.
@@ -44,7 +44,7 @@ export type getEntityUsersResponse = (getEntityUsersResponseSuccess | getEntityU
44
44
  export declare const getGetEntityUsersUrl: (params?: GetEntityUsersParams) => string;
45
45
  export declare const getEntityUsers: (params?: GetEntityUsersParams, options?: RequestInit) => Promise<getEntityUsersResponse>;
46
46
  /**
47
- * Add an existing white-label user for this account to the entity or send an invitation. Existing account users must accept the invitation so they receive separate entity-user access. With `silent: true` no email is sent (`send_invite` is ignored): a missing white-label user is created immediately (no password, optional `metadata`) and linked to the entity, and an existing white-label user is linked. Silent provisioning requires an account API key or an account owner/admin user token. The new user's email counts as verified when the credential is an account API key or a user token whose email is verified; otherwise the user must verify their email before sending documents by email. Silent provisioning can be followed by `POST /entities/users/{user_id}/token` with `ttl` to embed the user.
47
+ * Add an existing white-label user for this account to the entity or send an invitation. Existing account users must accept the invitation so they receive separate entity-user access. With `silent: true` no email is sent (`send_invite` is ignored): a missing white-label user is created immediately (no password, optional `metadata`) and linked to the entity, and an existing white-label user is linked. Silent provisioning requires an account API key or an account owner/admin signed in directly (an interactive session); delegated (SSO) tokens are rejected. The new user's email counts as verified when the credential is an account API key or a user token whose email is verified; otherwise the user must verify their email before sending documents by email. Silent provisioning can be followed by `POST /entities/users/{user_id}/token` with `ttl` to embed the user.
48
48
  * @summary Add user to entity
49
49
  */
50
50
  export type addEntityUserResponse201 = {
@@ -204,7 +204,7 @@ export type removeEntityUserResponse = (removeEntityUserResponseSuccess | remove
204
204
  export declare const getRemoveEntityUserUrl: (userId: string) => string;
205
205
  export declare const removeEntityUser: (userId: string, options?: RequestInit) => Promise<removeEntityUserResponse>;
206
206
  /**
207
- * Generate a delegated SSO access token for a WL user to enable SSO-like redirect. Requires an account API key or a non-impersonated account owner/admin user token; entity API keys, entity-only roles, and account members are rejected. The token has the standard one-year session TTL but cannot authorize user-presence-sensitive operations such as account deletion, so callers must treat issuance as a privileged account-level operation. Pass `ttl` (300 to 86400 seconds) to receive a short-lived `delegated_embed` token for embedding the user's app instead; it cannot be extended. An embed session can call only the routes the embedded UI needs, and can never manage users, invitations, memberships or account settings, mint other credentials (tokens, API keys, impersonation), manage passkeys, two-factor or till operator PINs, or delete the account; a request to any other route is refused with 403.
207
+ * Generate a delegated SSO access token for a WL user to enable SSO-like redirect. Requires an account API key or a non-impersonated account owner/admin signed in directly (an interactive session); entity API keys, entity-only roles, account members, and delegated (SSO) tokens are rejected. The token has the standard one-year session TTL but cannot authorize user-presence-sensitive operations such as account deletion, so callers must treat issuance as a privileged account-level operation. Pass `ttl` (300 to 86400 seconds) to receive a short-lived `delegated_embed` token for embedding the user's app instead; it cannot be extended. An embed session can call only the routes the embedded UI needs, and can never manage users, invitations, memberships or account settings, mint other credentials (tokens, API keys, impersonation), manage passkeys, two-factor or till operator PINs, or delete the account; a request to any other route is refused with 403.
208
208
  * @summary Generate user access token
209
209
  */
210
210
  export type generateEntityUserTokenResponse200 = {
@@ -44,7 +44,7 @@ export type getEntityUsersResponse = (getEntityUsersResponseSuccess | getEntityU
44
44
  export declare const getGetEntityUsersUrl: (params?: GetEntityUsersParams) => string;
45
45
  export declare const getEntityUsers: (params?: GetEntityUsersParams, options?: RequestInit) => Promise<getEntityUsersResponse>;
46
46
  /**
47
- * Add an existing white-label user for this account to the entity or send an invitation. Existing account users must accept the invitation so they receive separate entity-user access. With `silent: true` no email is sent (`send_invite` is ignored): a missing white-label user is created immediately (no password, optional `metadata`) and linked to the entity, and an existing white-label user is linked. Silent provisioning requires an account API key or an account owner/admin user token. The new user's email counts as verified when the credential is an account API key or a user token whose email is verified; otherwise the user must verify their email before sending documents by email. Silent provisioning can be followed by `POST /entities/users/{user_id}/token` with `ttl` to embed the user.
47
+ * Add an existing white-label user for this account to the entity or send an invitation. Existing account users must accept the invitation so they receive separate entity-user access. With `silent: true` no email is sent (`send_invite` is ignored): a missing white-label user is created immediately (no password, optional `metadata`) and linked to the entity, and an existing white-label user is linked. Silent provisioning requires an account API key or an account owner/admin signed in directly (an interactive session); delegated (SSO) tokens are rejected. The new user's email counts as verified when the credential is an account API key or a user token whose email is verified; otherwise the user must verify their email before sending documents by email. Silent provisioning can be followed by `POST /entities/users/{user_id}/token` with `ttl` to embed the user.
48
48
  * @summary Add user to entity
49
49
  */
50
50
  export type addEntityUserResponse201 = {
@@ -204,7 +204,7 @@ export type removeEntityUserResponse = (removeEntityUserResponseSuccess | remove
204
204
  export declare const getRemoveEntityUserUrl: (userId: string) => string;
205
205
  export declare const removeEntityUser: (userId: string, options?: RequestInit) => Promise<removeEntityUserResponse>;
206
206
  /**
207
- * Generate a delegated SSO access token for a WL user to enable SSO-like redirect. Requires an account API key or a non-impersonated account owner/admin user token; entity API keys, entity-only roles, and account members are rejected. The token has the standard one-year session TTL but cannot authorize user-presence-sensitive operations such as account deletion, so callers must treat issuance as a privileged account-level operation. Pass `ttl` (300 to 86400 seconds) to receive a short-lived `delegated_embed` token for embedding the user's app instead; it cannot be extended. An embed session can call only the routes the embedded UI needs, and can never manage users, invitations, memberships or account settings, mint other credentials (tokens, API keys, impersonation), manage passkeys, two-factor or till operator PINs, or delete the account; a request to any other route is refused with 403.
207
+ * Generate a delegated SSO access token for a WL user to enable SSO-like redirect. Requires an account API key or a non-impersonated account owner/admin signed in directly (an interactive session); entity API keys, entity-only roles, account members, and delegated (SSO) tokens are rejected. The token has the standard one-year session TTL but cannot authorize user-presence-sensitive operations such as account deletion, so callers must treat issuance as a privileged account-level operation. Pass `ttl` (300 to 86400 seconds) to receive a short-lived `delegated_embed` token for embedding the user's app instead; it cannot be extended. An embed session can call only the routes the embedded UI needs, and can never manage users, invitations, memberships or account settings, mint other credentials (tokens, API keys, impersonation), manage passkeys, two-factor or till operator PINs, or delete the account; a request to any other route is refused with 403.
208
208
  * @summary Generate user access token
209
209
  */
210
210
  export type generateEntityUserTokenResponse200 = {
@@ -15,7 +15,7 @@ export type AddEntityUserBody = {
15
15
  /** Whether to send an invitation email (only applies to new users). Defaults to true. Ignored when `silent` is true: no email is sent. */
16
16
  send_invite?: boolean;
17
17
  /**
18
- * Provision the user without sending any email. A missing white-label user is created immediately, with no password, and linked to the entity; an existing white-label user is linked (its email verification is unchanged). The new user's email counts as verified when the credential is an account API key or a user with a verified email. Requires an account API key or an account owner/admin user token. Follow it with `POST /entities/users/{user_id}/token` and `ttl` to give the user an embedded session.
18
+ * Provision the user without sending any email. A missing white-label user is created immediately, with no password, and linked to the entity; an existing white-label user is linked (its email verification is unchanged). The new user's email counts as verified when the credential is an account API key or a user with a verified email. Requires an account API key or an account owner/admin signed in directly (an interactive session); delegated (SSO) tokens are rejected. Follow it with `POST /entities/users/{user_id}/token` and `ttl` to give the user an embedded session.
19
19
  * @nullable
20
20
  */
21
21
  silent?: boolean | null;
@@ -15,7 +15,7 @@ export type AddEntityUserBody = {
15
15
  /** Whether to send an invitation email (only applies to new users). Defaults to true. Ignored when `silent` is true: no email is sent. */
16
16
  send_invite?: boolean;
17
17
  /**
18
- * Provision the user without sending any email. A missing white-label user is created immediately, with no password, and linked to the entity; an existing white-label user is linked (its email verification is unchanged). The new user's email counts as verified when the credential is an account API key or a user with a verified email. Requires an account API key or an account owner/admin user token. Follow it with `POST /entities/users/{user_id}/token` and `ttl` to give the user an embedded session.
18
+ * Provision the user without sending any email. A missing white-label user is created immediately, with no password, and linked to the entity; an existing white-label user is linked (its email verification is unchanged). The new user's email counts as verified when the credential is an account API key or a user with a verified email. Requires an account API key or an account owner/admin signed in directly (an interactive session); delegated (SSO) tokens are rejected. Follow it with `POST /entities/users/{user_id}/token` and `ttl` to give the user an embedded session.
19
19
  * @nullable
20
20
  */
21
21
  silent?: boolean | null;
@@ -89,7 +89,7 @@ export type updateTicketBaiSettingsResponse = (updateTicketBaiSettingsResponseSu
89
89
  export declare const getUpdateTicketBaiSettingsUrl: () => string;
90
90
  export declare const updateTicketBaiSettings: (updateTicketBaiSettings: UpdateTicketBaiSettings, options?: RequestInit) => Promise<updateTicketBaiSettingsResponse>;
91
91
  /**
92
- * Requires an account API key or an account owner/admin session; entity-scoped keys cannot upload certificates. Upload a P12/PFX certificate and matching private key, at most 1 MiB. The private key is encrypted at rest. Uploading does not establish taxpayer representation or activate fiscalization.
92
+ * Requires an account API key or an account owner/admin signed in directly (delegated SSO tokens are rejected); entity-scoped keys cannot upload certificates. Upload a P12/PFX certificate and matching private key, at most 1 MiB. The private key is encrypted at rest. Uploading does not establish taxpayer representation or activate fiscalization.
93
93
  * @summary Upload TicketBAI signing and submission certificate
94
94
  */
95
95
  export type uploadTicketBaiCertificateResponse200 = {
@@ -89,7 +89,7 @@ export type updateTicketBaiSettingsResponse = (updateTicketBaiSettingsResponseSu
89
89
  export declare const getUpdateTicketBaiSettingsUrl: () => string;
90
90
  export declare const updateTicketBaiSettings: (updateTicketBaiSettings: UpdateTicketBaiSettings, options?: RequestInit) => Promise<updateTicketBaiSettingsResponse>;
91
91
  /**
92
- * Requires an account API key or an account owner/admin session; entity-scoped keys cannot upload certificates. Upload a P12/PFX certificate and matching private key, at most 1 MiB. The private key is encrypted at rest. Uploading does not establish taxpayer representation or activate fiscalization.
92
+ * Requires an account API key or an account owner/admin signed in directly (delegated SSO tokens are rejected); entity-scoped keys cannot upload certificates. Upload a P12/PFX certificate and matching private key, at most 1 MiB. The private key is encrypted at rest. Uploading does not establish taxpayer representation or activate fiscalization.
93
93
  * @summary Upload TicketBAI signing and submission certificate
94
94
  */
95
95
  export type uploadTicketBaiCertificateResponse200 = {
@@ -34,7 +34,7 @@ export declare const GetEntityUsersResponse: zod.ZodObject<{
34
34
  }, zod.z.core.$strip>>;
35
35
  }, zod.z.core.$strip>;
36
36
  /**
37
- * Add an existing white-label user for this account to the entity or send an invitation. Existing account users must accept the invitation so they receive separate entity-user access. With `silent: true` no email is sent (`send_invite` is ignored): a missing white-label user is created immediately (no password, optional `metadata`) and linked to the entity, and an existing white-label user is linked. Silent provisioning requires an account API key or an account owner/admin user token. The new user's email counts as verified when the credential is an account API key or a user token whose email is verified; otherwise the user must verify their email before sending documents by email. Silent provisioning can be followed by `POST /entities/users/{user_id}/token` with `ttl` to embed the user.
37
+ * Add an existing white-label user for this account to the entity or send an invitation. Existing account users must accept the invitation so they receive separate entity-user access. With `silent: true` no email is sent (`send_invite` is ignored): a missing white-label user is created immediately (no password, optional `metadata`) and linked to the entity, and an existing white-label user is linked. Silent provisioning requires an account API key or an account owner/admin signed in directly (an interactive session); delegated (SSO) tokens are rejected. The new user's email counts as verified when the credential is an account API key or a user token whose email is verified; otherwise the user must verify their email before sending documents by email. Silent provisioning can be followed by `POST /entities/users/{user_id}/token` with `ttl` to embed the user.
38
38
  * @summary Add user to entity
39
39
  */
40
40
  export declare const AddEntityUserHeader: zod.ZodObject<{
@@ -127,7 +127,7 @@ export declare const RemoveEntityUserResponse: zod.ZodObject<{
127
127
  message: zod.ZodString;
128
128
  }, zod.z.core.$strip>;
129
129
  /**
130
- * Generate a delegated SSO access token for a WL user to enable SSO-like redirect. Requires an account API key or a non-impersonated account owner/admin user token; entity API keys, entity-only roles, and account members are rejected. The token has the standard one-year session TTL but cannot authorize user-presence-sensitive operations such as account deletion, so callers must treat issuance as a privileged account-level operation. Pass `ttl` (300 to 86400 seconds) to receive a short-lived `delegated_embed` token for embedding the user's app instead; it cannot be extended. An embed session can call only the routes the embedded UI needs, and can never manage users, invitations, memberships or account settings, mint other credentials (tokens, API keys, impersonation), manage passkeys, two-factor or till operator PINs, or delete the account; a request to any other route is refused with 403.
130
+ * Generate a delegated SSO access token for a WL user to enable SSO-like redirect. Requires an account API key or a non-impersonated account owner/admin signed in directly (an interactive session); entity API keys, entity-only roles, account members, and delegated (SSO) tokens are rejected. The token has the standard one-year session TTL but cannot authorize user-presence-sensitive operations such as account deletion, so callers must treat issuance as a privileged account-level operation. Pass `ttl` (300 to 86400 seconds) to receive a short-lived `delegated_embed` token for embedding the user's app instead; it cannot be extended. An embed session can call only the routes the embedded UI needs, and can never manage users, invitations, memberships or account settings, mint other credentials (tokens, API keys, impersonation), manage passkeys, two-factor or till operator PINs, or delete the account; a request to any other route is refused with 403.
131
131
  * @summary Generate user access token
132
132
  */
133
133
  export declare const generateEntityUserTokenPathUserIdRegExp: RegExp;
@@ -34,7 +34,7 @@ export declare const GetEntityUsersResponse: zod.ZodObject<{
34
34
  }, zod.z.core.$strip>>;
35
35
  }, zod.z.core.$strip>;
36
36
  /**
37
- * Add an existing white-label user for this account to the entity or send an invitation. Existing account users must accept the invitation so they receive separate entity-user access. With `silent: true` no email is sent (`send_invite` is ignored): a missing white-label user is created immediately (no password, optional `metadata`) and linked to the entity, and an existing white-label user is linked. Silent provisioning requires an account API key or an account owner/admin user token. The new user's email counts as verified when the credential is an account API key or a user token whose email is verified; otherwise the user must verify their email before sending documents by email. Silent provisioning can be followed by `POST /entities/users/{user_id}/token` with `ttl` to embed the user.
37
+ * Add an existing white-label user for this account to the entity or send an invitation. Existing account users must accept the invitation so they receive separate entity-user access. With `silent: true` no email is sent (`send_invite` is ignored): a missing white-label user is created immediately (no password, optional `metadata`) and linked to the entity, and an existing white-label user is linked. Silent provisioning requires an account API key or an account owner/admin signed in directly (an interactive session); delegated (SSO) tokens are rejected. The new user's email counts as verified when the credential is an account API key or a user token whose email is verified; otherwise the user must verify their email before sending documents by email. Silent provisioning can be followed by `POST /entities/users/{user_id}/token` with `ttl` to embed the user.
38
38
  * @summary Add user to entity
39
39
  */
40
40
  export declare const AddEntityUserHeader: zod.ZodObject<{
@@ -127,7 +127,7 @@ export declare const RemoveEntityUserResponse: zod.ZodObject<{
127
127
  message: zod.ZodString;
128
128
  }, zod.z.core.$strip>;
129
129
  /**
130
- * Generate a delegated SSO access token for a WL user to enable SSO-like redirect. Requires an account API key or a non-impersonated account owner/admin user token; entity API keys, entity-only roles, and account members are rejected. The token has the standard one-year session TTL but cannot authorize user-presence-sensitive operations such as account deletion, so callers must treat issuance as a privileged account-level operation. Pass `ttl` (300 to 86400 seconds) to receive a short-lived `delegated_embed` token for embedding the user's app instead; it cannot be extended. An embed session can call only the routes the embedded UI needs, and can never manage users, invitations, memberships or account settings, mint other credentials (tokens, API keys, impersonation), manage passkeys, two-factor or till operator PINs, or delete the account; a request to any other route is refused with 403.
130
+ * Generate a delegated SSO access token for a WL user to enable SSO-like redirect. Requires an account API key or a non-impersonated account owner/admin signed in directly (an interactive session); entity API keys, entity-only roles, account members, and delegated (SSO) tokens are rejected. The token has the standard one-year session TTL but cannot authorize user-presence-sensitive operations such as account deletion, so callers must treat issuance as a privileged account-level operation. Pass `ttl` (300 to 86400 seconds) to receive a short-lived `delegated_embed` token for embedding the user's app instead; it cannot be extended. An embed session can call only the routes the embedded UI needs, and can never manage users, invitations, memberships or account settings, mint other credentials (tokens, API keys, impersonation), manage passkeys, two-factor or till operator PINs, or delete the account; a request to any other route is refused with 403.
131
131
  * @summary Generate user access token
132
132
  */
133
133
  export declare const generateEntityUserTokenPathUserIdRegExp: RegExp;
@@ -105,7 +105,7 @@ export declare const UpdateTicketBaiSettingsResponse: zod.ZodObject<{
105
105
  has_issued_records: zod.ZodBoolean;
106
106
  }, zod.z.core.$strip>;
107
107
  /**
108
- * Requires an account API key or an account owner/admin session; entity-scoped keys cannot upload certificates. Upload a P12/PFX certificate and matching private key, at most 1 MiB. The private key is encrypted at rest. Uploading does not establish taxpayer representation or activate fiscalization.
108
+ * Requires an account API key or an account owner/admin signed in directly (delegated SSO tokens are rejected); entity-scoped keys cannot upload certificates. Upload a P12/PFX certificate and matching private key, at most 1 MiB. The private key is encrypted at rest. Uploading does not establish taxpayer representation or activate fiscalization.
109
109
  * @summary Upload TicketBAI signing and submission certificate
110
110
  */
111
111
  export declare const UploadTicketBaiCertificateHeader: zod.ZodObject<{
@@ -105,7 +105,7 @@ export declare const UpdateTicketBaiSettingsResponse: zod.ZodObject<{
105
105
  has_issued_records: zod.ZodBoolean;
106
106
  }, zod.z.core.$strip>;
107
107
  /**
108
- * Requires an account API key or an account owner/admin session; entity-scoped keys cannot upload certificates. Upload a P12/PFX certificate and matching private key, at most 1 MiB. The private key is encrypted at rest. Uploading does not establish taxpayer representation or activate fiscalization.
108
+ * Requires an account API key or an account owner/admin signed in directly (delegated SSO tokens are rejected); entity-scoped keys cannot upload certificates. Upload a P12/PFX certificate and matching private key, at most 1 MiB. The private key is encrypted at rest. Uploading does not establish taxpayer representation or activate fiscalization.
109
109
  * @summary Upload TicketBAI signing and submission certificate
110
110
  */
111
111
  export declare const UploadTicketBaiCertificateHeader: zod.ZodObject<{