@ikatec/digisac-api-sdk 4.10.0 → 4.12.0

package/dist/apis/me/MeApi.mjs

@@ -1,62 +1,69 @@
 import { BaseApi } from "../../core/BaseApi.mjs";
 
 //#region src/apis/me/MeApi.ts
+/**
+* A query object always has an array or an object among its values; the headers only have strings (a header that
+* comes as `undefined` at runtime stays a header). That tells the two apart in the methods that took only the
+* headers before and now take a query first.
+*/
+function splitQueryAndHeaders(queryOrHeaders, headers) {
+	return !!queryOrHeaders && Object.values(queryOrHeaders).some((value) => typeof value === "object" && value !== null) ? [queryOrHeaders, headers] : [void 0, queryOrHeaders];
+}
 var MeApi = class extends BaseApi {
-	/**
-	* Returns the currently authenticated user, including their roles, departments, and timetable.
-	* @permissions users.view
-	*/
-	getMe(headers) {
-		return this.client.get("/me", headers);
+	getMe(queryOrHeaders, headers) {
+		const [query, sent] = splitQueryAndHeaders(queryOrHeaders, headers);
+		return this.client.get(`/me${this.toQueryString(query)}`, sent);
 	}
-	/** Returns the account associated with the currently authenticated user. */
-	getAccount(headers) {
-		return this.client.get("/me/account", headers);
+	getAccount(queryOrHeaders, headers) {
+		const [query, sent] = splitQueryAndHeaders(queryOrHeaders, headers);
+		return this.client.get(`/me/account${this.toQueryString(query)}`, sent);
 	}
-	/**
-	* Returns credit and usage amounts for the current account.
-	* Excludes Digisac's own internal credit amounts.
-	*/
-	getAccountAmounts(headers) {
-		return this.client.get("/me/get-account-amounts", headers);
+	getAccountAmounts(queryOrHeaders, headers) {
+		const [query, sent] = splitQueryAndHeaders(queryOrHeaders, headers);
+		const queryString = query ? this.toQueryString({ filter: query.filter.join(",") }) : "";
+		return this.client.get(`/me/get-account-amounts${queryString}`, sent);
 	}
 	/**
-	* Returns a URL to the Agnus billing/plan management page for the current account.
+	* Returns a URL to the Agnus billing/plan management page for the current account. Calls Agnus (an external
+	* service) and, for accounts without credits control, reports the consumption to it first.
 	* @permissions myAccount.myPlan
 	*/
 	getAgnusMyPlanUrl(headers) {
 		return this.client.get("/me/account/agnus-my-plan-url", headers);
 	}
 	/**
-	* Updates the current user's profile fields such as name, language, and preferences.
-	* If a new password is provided, it is validated against the last 6 password history entries
-	* and all existing access tokens for the user are revoked.
+	* Updates the current user's profile fields such as name, language, and preferences (`data` and `preferences`
+	* replace the stored objects). A new `password` needs `currentPassword` and a recent login, is validated against
+	* the last 6 passwords, and revokes the access tokens with an expiration — including the one of this request.
 	*/
 	updateMe(body, headers) {
 		return this.client.put("/me", body, headers);
 	}
-	/** Updates account-level settings such as name, settings object, wizard progress, and default department. */
+	/**
+	* Updates account-level settings such as name, settings object, wizard progress, and default department. It
+	* applies to the whole account; the default department is required while the tickets are enabled.
+	*/
 	updateAccount(body, headers) {
 		return this.client.put("/me/account", body, headers);
 	}
 	/**
-	* Updates the presence status of the current user (`online`, `offline`, or `away`).
+	* Updates the presence status of the current user (`online`, `offline`, or `away`) for a `client`.
 	* If setting to `online`, validates the user's timetable first — if outside working hours,
-	* the status is set to `offline` instead.
+	* the status is set to `offline` instead. Resolves the status fields of the user.
 	*/
 	updateStatus(body, headers) {
 		return this.client.put("/me/status", body, headers);
 	}
 	/**
-	* Extends the grace period for the current account when it has expired or is about to expire.
-	* Returns the updated account.
+	* Extends the grace period for the current account when it has expired or is about to expire, and notifies the
+	* billing webhook. Returns the updated account; an account not in a grace period answers 400.
 	*/
 	extendAccountGracePeriod(headers) {
 		return this.client.post("/me/account/extend-grace-period", void 0, headers);
 	}
 	/**
-	* Registers a OneSignal push notification token for the current user.
-	* Used to enable push notifications on mobile/web clients.
+	* Registers the push notification tokens of the current user (`data` replaces the whole `data` of the user).
+	* Resolves with no body.
 	*/
 	registerToken(body, headers) {
 		return this.client.post("/me/one-signal/register-token", body, headers);
@@ -66,8 +73,8 @@ var MeApi = class extends BaseApi {
 		return this.client.post("/me/report-login", void 0, headers);
 	}
 	/**
-	* Sets the current user's status to `online` for the given client and emits a takeover event,
-	* which signals other connected sessions to yield control to this one.
+	* Sets the current user's status to `online` for the given client (`'web'` by default) and emits a takeover
+	* event, which signals other connected sessions to yield control to this one. Resolves with no body.
 	*/
 	takeover(body, headers) {
 		return this.client.post("/me/takeover", body, headers);
@@ -82,7 +89,7 @@ var MeApi = class extends BaseApi {
 	/**
 	* Activates OTP (two-factor) authentication for the current user.
 	* Requires the `x-digisac-otp` header with a valid TOTP token generated from the secret key
-	* previously set via `setOtpSecretKey`.
+	* previously set via `setOtpSecretKey`. Resolves the text `'OK'`.
 	*/
 	activateOtpAuth(headers) {
 		return this.client.post("/me/activate-otp-auth", void 0, headers);

package/dist/apis/me/MeApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"MeApi.mjs","names":[],"sources":["../../../src/apis/me/MeApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type { Account } from '../accounts/types'\nimport type { User } from '../users/types'\nimport type {\n  RegisterTokenPayload,\n  SetOtpSecretKeyPayload,\n  TakeoverPayload,\n  UpdateMeAccountPayload,\n  UpdateMePayload,\n  UpdateMeStatusPayload,\n} from './types'\n\nexport class MeApi extends BaseApi {\n  /**\n   * Returns the currently authenticated user, including their roles, departments, and timetable.\n   * @permissions users.view\n   */\n  getMe(headers?: Record<string, string>): Promise<User> {\n    return this.client.get<User>('/me', headers)\n  }\n\n  /** Returns the account associated with the currently authenticated user. */\n  getAccount(headers?: Record<string, string>): Promise<Account> {\n    return this.client.get<Account>('/me/account', headers)\n  }\n\n  /**\n   * Returns credit and usage amounts for the current account.\n   * Excludes Digisac's own internal credit amounts.\n   */\n  getAccountAmounts(headers?: Record<string, string>): Promise<Record<string, unknown>> {\n    return this.client.get<Record<string, unknown>>('/me/get-account-amounts', headers)\n  }\n\n  /**\n   * Returns a URL to the Agnus billing/plan management page for the current account.\n   * @permissions myAccount.myPlan\n   */\n  getAgnusMyPlanUrl(headers?: Record<string, string>): Promise<{ url: string }> {\n    return this.client.get<{ url: string }>('/me/account/agnus-my-plan-url', headers)\n  }\n\n  /**\n   * Updates the current user's profile fields such as name, language, and preferences.\n   * If a new password is provided, it is validated against the last 6 password history entries\n   * and all existing access tokens for the user are revoked.\n   */\n  updateMe(body: UpdateMePayload, headers?: Record<string, string>): Promise<User> {\n    return this.client.put<User, UpdateMePayload>('/me', body, headers)\n  }\n\n  /** Updates account-level settings such as name, settings object, wizard progress, and default department. */\n  updateAccount(body: UpdateMeAccountPayload, headers?: Record<string, string>): Promise<Account> {\n    return this.client.put<Account, UpdateMeAccountPayload>('/me/account', body, headers)\n  }\n\n  /**\n   * Updates the presence status of the current user (`online`, `offline`, or `away`).\n   * If setting to `online`, validates the user's timetable first — if outside working hours,\n   * the status is set to `offline` instead.\n   */\n  updateStatus(body: UpdateMeStatusPayload, headers?: Record<string, string>): Promise<User> {\n    return this.client.put<User, UpdateMeStatusPayload>('/me/status', body, headers)\n  }\n\n  /**\n   * Extends the grace period for the current account when it has expired or is about to expire.\n   * Returns the updated account.\n   */\n  extendAccountGracePeriod(headers?: Record<string, string>): Promise<Account> {\n    return this.client.post<Account>('/me/account/extend-grace-period', undefined, headers)\n  }\n\n  /**\n   * Registers a OneSignal push notification token for the current user.\n   * Used to enable push notifications on mobile/web clients.\n   */\n  registerToken(body: RegisterTokenPayload, headers?: Record<string, string>): Promise<void> {\n    return this.client.post<void, RegisterTokenPayload>(\n      '/me/one-signal/register-token',\n      body,\n      headers,\n    )\n  }\n\n  /** Marks the current user's first login as complete by setting `isFirstLogin` to `false`. */\n  reportFirstLogin(headers?: Record<string, string>): Promise<User> {\n    return this.client.post<User>('/me/report-login', undefined, headers)\n  }\n\n  /**\n   * Sets the current user's status to `online` for the given client and emits a takeover event,\n   * which signals other connected sessions to yield control to this one.\n   */\n  takeover(body?: TakeoverPayload, headers?: Record<string, string>): Promise<void> {\n    return this.client.post<void, TakeoverPayload>('/me/takeover', body, headers)\n  }\n\n  /**\n   * Stores a 16-character OTP secret key on the current user.\n   * This must be called before activating OTP authentication via `activateOtpAuth`.\n   */\n  setOtpSecretKey(body: SetOtpSecretKeyPayload, headers?: Record<string, string>): Promise<void> {\n    return this.client.patch<void, SetOtpSecretKeyPayload>('/me/set-otp-secret-key', body, headers)\n  }\n\n  /**\n   * Activates OTP (two-factor) authentication for the current user.\n   * Requires the `x-digisac-otp` header with a valid TOTP token generated from the secret key\n   * previously set via `setOtpSecretKey`.\n   */\n  activateOtpAuth(headers?: Record<string, string>): Promise<boolean> {\n    return this.client.post<boolean>('/me/activate-otp-auth', undefined, headers)\n  }\n}\n"],"mappings":";;;AAYA,IAAa,QAAb,cAA2B,QAAQ;;;;;CAKjC,MAAM,SAAiD;AACrD,SAAO,KAAK,OAAO,IAAU,OAAO,QAAQ;;;CAI9C,WAAW,SAAoD;AAC7D,SAAO,KAAK,OAAO,IAAa,eAAe,QAAQ;;;;;;CAOzD,kBAAkB,SAAoE;AACpF,SAAO,KAAK,OAAO,IAA6B,2BAA2B,QAAQ;;;;;;CAOrF,kBAAkB,SAA4D;AAC5E,SAAO,KAAK,OAAO,IAAqB,iCAAiC,QAAQ;;;;;;;CAQnF,SAAS,MAAuB,SAAiD;AAC/E,SAAO,KAAK,OAAO,IAA2B,OAAO,MAAM,QAAQ;;;CAIrE,cAAc,MAA8B,SAAoD;AAC9F,SAAO,KAAK,OAAO,IAAqC,eAAe,MAAM,QAAQ;;;;;;;CAQvF,aAAa,MAA6B,SAAiD;AACzF,SAAO,KAAK,OAAO,IAAiC,cAAc,MAAM,QAAQ;;;;;;CAOlF,yBAAyB,SAAoD;AAC3E,SAAO,KAAK,OAAO,KAAc,mCAAmC,QAAW,QAAQ;;;;;;CAOzF,cAAc,MAA4B,SAAiD;AACzF,SAAO,KAAK,OAAO,KACjB,iCACA,MACA,QACD;;;CAIH,iBAAiB,SAAiD;AAChE,SAAO,KAAK,OAAO,KAAW,oBAAoB,QAAW,QAAQ;;;;;;CAOvE,SAAS,MAAwB,SAAiD;AAChF,SAAO,KAAK,OAAO,KAA4B,gBAAgB,MAAM,QAAQ;;;;;;CAO/E,gBAAgB,MAA8B,SAAiD;AAC7F,SAAO,KAAK,OAAO,MAAoC,0BAA0B,MAAM,QAAQ;;;;;;;CAQjG,gBAAgB,SAAoD;AAClE,SAAO,KAAK,OAAO,KAAc,yBAAyB,QAAW,QAAQ"}
+{"version":3,"file":"MeApi.mjs","names":[],"sources":["../../../src/apis/me/MeApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type { Account } from '../accounts/types'\nimport type { User } from '../users/types'\nimport type {\n  AccountAmounts,\n  AccountAmountsQuery,\n  MeAccountQuery,\n  MeQuery,\n  MeStatusResponse,\n  RegisterTokenPayload,\n  SetOtpSecretKeyPayload,\n  TakeoverPayload,\n  UpdateMeAccountPayload,\n  UpdateMePayload,\n  UpdateMeStatusPayload,\n} from './types'\n\n/**\n * A query object always has an array or an object among its values; the headers only have strings (a header that\n * comes as `undefined` at runtime stays a header). That tells the two apart in the methods that took only the\n * headers before and now take a query first.\n */\nfunction splitQueryAndHeaders<TQuery extends object>(\n  queryOrHeaders: TQuery | Record<string, string> | undefined,\n  headers: Record<string, string> | undefined,\n): [TQuery | undefined, Record<string, string> | undefined] {\n  const isQuery =\n    !!queryOrHeaders &&\n    Object.values(queryOrHeaders).some((value) => typeof value === 'object' && value !== null)\n  return isQuery\n    ? [queryOrHeaders as TQuery, headers]\n    : [undefined, queryOrHeaders as Record<string, string> | undefined]\n}\n\nexport class MeApi extends BaseApi {\n  /**\n   * Returns the currently authenticated user. Without `include`, the user comes without relations (roles,\n   * departments, timetable, account).\n   * @permissions users.view\n   */\n  getMe(headers?: Record<string, string>): Promise<User>\n  getMe(query: MeQuery, headers?: Record<string, string>): Promise<User>\n  getMe(\n    queryOrHeaders?: MeQuery | Record<string, string>,\n    headers?: Record<string, string>,\n  ): Promise<User> {\n    const [query, sent] = splitQueryAndHeaders<MeQuery>(queryOrHeaders, headers)\n    return this.client.get<User>(`/me${this.toQueryString(query)}`, sent)\n  }\n\n  /**\n   * Returns the account of the current user. Send `where.id` with the `accountId` of the user (what the web app\n   * does): without it, the route answers 500.\n   */\n  getAccount(headers?: Record<string, string>): Promise<Account>\n  getAccount(query: MeAccountQuery, headers?: Record<string, string>): Promise<Account>\n  getAccount(\n    queryOrHeaders?: MeAccountQuery | Record<string, string>,\n    headers?: Record<string, string>,\n  ): Promise<Account> {\n    const [query, sent] = splitQueryAndHeaders<MeAccountQuery>(queryOrHeaders, headers)\n    return this.client.get<Account>(`/me/account${this.toQueryString(query)}`, sent)\n  }\n\n  /**\n   * Returns the amounts of the current account named in `filter` (services and/or users). The credit amounts are\n   * never answered here. An account without credits control answers 400.\n   */\n  getAccountAmounts(headers?: Record<string, string>): Promise<AccountAmounts>\n  getAccountAmounts(\n    query: AccountAmountsQuery,\n    headers?: Record<string, string>,\n  ): Promise<AccountAmounts>\n  getAccountAmounts(\n    queryOrHeaders?: AccountAmountsQuery | Record<string, string>,\n    headers?: Record<string, string>,\n  ): Promise<AccountAmounts> {\n    const [query, sent] = splitQueryAndHeaders<AccountAmountsQuery>(queryOrHeaders, headers)\n    const queryString = query ? this.toQueryString({ filter: query.filter.join(',') }) : ''\n    return this.client.get<AccountAmounts>(`/me/get-account-amounts${queryString}`, sent)\n  }\n\n  /**\n   * Returns a URL to the Agnus billing/plan management page for the current account. Calls Agnus (an external\n   * service) and, for accounts without credits control, reports the consumption to it first.\n   * @permissions myAccount.myPlan\n   */\n  getAgnusMyPlanUrl(headers?: Record<string, string>): Promise<{ url: string }> {\n    return this.client.get<{ url: string }>('/me/account/agnus-my-plan-url', headers)\n  }\n\n  /**\n   * Updates the current user's profile fields such as name, language, and preferences (`data` and `preferences`\n   * replace the stored objects). A new `password` needs `currentPassword` and a recent login, is validated against\n   * the last 6 passwords, and revokes the access tokens with an expiration — including the one of this request.\n   */\n  updateMe(body: UpdateMePayload, headers?: Record<string, string>): Promise<User> {\n    return this.client.put<User, UpdateMePayload>('/me', body, headers)\n  }\n\n  /**\n   * Updates account-level settings such as name, settings object, wizard progress, and default department. It\n   * applies to the whole account; the default department is required while the tickets are enabled.\n   */\n  updateAccount(body: UpdateMeAccountPayload, headers?: Record<string, string>): Promise<Account> {\n    return this.client.put<Account, UpdateMeAccountPayload>('/me/account', body, headers)\n  }\n\n  /**\n   * Updates the presence status of the current user (`online`, `offline`, or `away`) for a `client`.\n   * If setting to `online`, validates the user's timetable first — if outside working hours,\n   * the status is set to `offline` instead. Resolves the status fields of the user.\n   */\n  updateStatus(\n    body: UpdateMeStatusPayload,\n    headers?: Record<string, string>,\n  ): Promise<MeStatusResponse> {\n    return this.client.put<MeStatusResponse, UpdateMeStatusPayload>('/me/status', body, headers)\n  }\n\n  /**\n   * Extends the grace period for the current account when it has expired or is about to expire, and notifies the\n   * billing webhook. Returns the updated account; an account not in a grace period answers 400.\n   */\n  extendAccountGracePeriod(headers?: Record<string, string>): Promise<Account> {\n    return this.client.post<Account>('/me/account/extend-grace-period', undefined, headers)\n  }\n\n  /**\n   * Registers the push notification tokens of the current user (`data` replaces the whole `data` of the user).\n   * Resolves with no body.\n   */\n  registerToken(body: RegisterTokenPayload, headers?: Record<string, string>): Promise<void> {\n    return this.client.post<void, RegisterTokenPayload>(\n      '/me/one-signal/register-token',\n      body,\n      headers,\n    )\n  }\n\n  /** Marks the current user's first login as complete by setting `isFirstLogin` to `false`. */\n  reportFirstLogin(headers?: Record<string, string>): Promise<User> {\n    return this.client.post<User>('/me/report-login', undefined, headers)\n  }\n\n  /**\n   * Sets the current user's status to `online` for the given client (`'web'` by default) and emits a takeover\n   * event, which signals other connected sessions to yield control to this one. Resolves with no body.\n   */\n  takeover(body?: TakeoverPayload, headers?: Record<string, string>): Promise<void> {\n    return this.client.post<void, TakeoverPayload>('/me/takeover', body, headers)\n  }\n\n  /**\n   * Stores a 16-character OTP secret key on the current user.\n   * This must be called before activating OTP authentication via `activateOtpAuth`.\n   */\n  setOtpSecretKey(body: SetOtpSecretKeyPayload, headers?: Record<string, string>): Promise<void> {\n    return this.client.patch<void, SetOtpSecretKeyPayload>('/me/set-otp-secret-key', body, headers)\n  }\n\n  /**\n   * Activates OTP (two-factor) authentication for the current user.\n   * Requires the `x-digisac-otp` header with a valid TOTP token generated from the secret key\n   * previously set via `setOtpSecretKey`. Resolves the text `'OK'`.\n   */\n  activateOtpAuth(headers?: Record<string, string>): Promise<'OK'> {\n    return this.client.post<'OK'>('/me/activate-otp-auth', undefined, headers)\n  }\n}\n"],"mappings":";;;;;;;;AAsBA,SAAS,qBACP,gBACA,SAC0D;AAI1D,QAFE,CAAC,CAAC,kBACF,OAAO,OAAO,eAAe,CAAC,MAAM,UAAU,OAAO,UAAU,YAAY,UAAU,KAAK,GAExF,CAAC,gBAA0B,QAAQ,GACnC,CAAC,QAAW,eAAqD;;AAGvE,IAAa,QAAb,cAA2B,QAAQ;CAQjC,MACE,gBACA,SACe;EACf,MAAM,CAAC,OAAO,QAAQ,qBAA8B,gBAAgB,QAAQ;AAC5E,SAAO,KAAK,OAAO,IAAU,MAAM,KAAK,cAAc,MAAM,IAAI,KAAK;;CASvE,WACE,gBACA,SACkB;EAClB,MAAM,CAAC,OAAO,QAAQ,qBAAqC,gBAAgB,QAAQ;AACnF,SAAO,KAAK,OAAO,IAAa,cAAc,KAAK,cAAc,MAAM,IAAI,KAAK;;CAYlF,kBACE,gBACA,SACyB;EACzB,MAAM,CAAC,OAAO,QAAQ,qBAA0C,gBAAgB,QAAQ;EACxF,MAAM,cAAc,QAAQ,KAAK,cAAc,EAAE,QAAQ,MAAM,OAAO,KAAK,IAAI,EAAE,CAAC,GAAG;AACrF,SAAO,KAAK,OAAO,IAAoB,0BAA0B,eAAe,KAAK;;;;;;;CAQvF,kBAAkB,SAA4D;AAC5E,SAAO,KAAK,OAAO,IAAqB,iCAAiC,QAAQ;;;;;;;CAQnF,SAAS,MAAuB,SAAiD;AAC/E,SAAO,KAAK,OAAO,IAA2B,OAAO,MAAM,QAAQ;;;;;;CAOrE,cAAc,MAA8B,SAAoD;AAC9F,SAAO,KAAK,OAAO,IAAqC,eAAe,MAAM,QAAQ;;;;;;;CAQvF,aACE,MACA,SAC2B;AAC3B,SAAO,KAAK,OAAO,IAA6C,cAAc,MAAM,QAAQ;;;;;;CAO9F,yBAAyB,SAAoD;AAC3E,SAAO,KAAK,OAAO,KAAc,mCAAmC,QAAW,QAAQ;;;;;;CAOzF,cAAc,MAA4B,SAAiD;AACzF,SAAO,KAAK,OAAO,KACjB,iCACA,MACA,QACD;;;CAIH,iBAAiB,SAAiD;AAChE,SAAO,KAAK,OAAO,KAAW,oBAAoB,QAAW,QAAQ;;;;;;CAOvE,SAAS,MAAwB,SAAiD;AAChF,SAAO,KAAK,OAAO,KAA4B,gBAAgB,MAAM,QAAQ;;;;;;CAO/E,gBAAgB,MAA8B,SAAiD;AAC7F,SAAO,KAAK,OAAO,MAAoC,0BAA0B,MAAM,QAAQ;;;;;;;CAQjG,gBAAgB,SAAiD;AAC/D,SAAO,KAAK,OAAO,KAAW,yBAAyB,QAAW,QAAQ"}

package/dist/apis/me/types.d.ts

@@ -1,9 +1,54 @@
 import type { AccountSettings } from '../accounts/types';
 import type { UserPreferences } from '../users/types';
 import type { UserStatus } from '../users/types';
+/** The client of the session that sets the status: the web app or the mobile app. */
+export type MeClient = 'web' | 'app';
+/** Query of `GET /me`: without `include`, the user comes without relations. */
+export type MeQuery = {
+    include?: ('roles' | 'departments' | 'timetable' | 'account' | 'permissions' | 'organizations' | (string & {}))[];
+    attributes?: string[];
+};
+/** Query of `GET /me/account`: `where.id` is the id of the account of the user (`accountId` of `getMe`). */
+export type MeAccountQuery = {
+    where: {
+        id: string;
+    };
+    include?: string[];
+    attributes?: string[];
+};
+export type AccountAmountsFilter = 'services.amounts' | 'users.amounts';
+/** Query of `GET /me/get-account-amounts`: which amounts to answer (the credit amounts are never answered). */
+export type AccountAmountsQuery = {
+    filter: AccountAmountsFilter[];
+};
+export type UsersAmounts = {
+    planBase: number;
+    additional: number;
+    totalContracted: number;
+    planBaseConsumed: number;
+    additionalConsumed: number;
+    totalConsumed: number;
+    available: number;
+};
+export type AccountAmounts = {
+    accountId: string;
+    servicesAmounts?: Record<string, unknown>;
+    usersAmounts?: UsersAmounts;
+};
+/** What `updateStatus` answers: the status fields of the user, not the whole user. */
+export type MeStatusResponse = {
+    id: string;
+    updatedAt: string;
+    status: UserStatus;
+    clientsStatus: Partial<Record<MeClient, UserStatus>>;
+    language: string;
+    account?: unknown;
+};
 export type UpdateMePayload = {
     name?: string;
     password?: string;
+    /** Required with `password`: the current password of the user. */
+    currentPassword?: string;
     language?: string;
     preferences?: UserPreferences;
     otpAuthActive?: boolean;
@@ -12,19 +57,37 @@ export type UpdateMePayload = {
 };
 export type UpdateMeStatusPayload = {
     status: UserStatus;
-    client?: string;
+    /** Required by the backend (400 without it). */
+    client?: MeClient;
 };
+/**
+ * Merged over the account. The default department is required while the tickets are enabled
+ * (`settings.ticketsEnabled`; 400 `DEFAULT_DEPARTMENT_REQUIRED`).
+ */
 export type UpdateMeAccountPayload = {
     name?: string;
     settings?: Partial<AccountSettings>;
-    wizardProgress?: string;
+    wizardProgress?: 'notStarted' | 'started' | 'finished' | (string & {});
     defaultDepartmentId?: string;
+    defaultDepartment?: {
+        id: string;
+    };
 };
 export type TakeoverPayload = {
-    client?: string;
+    /** Defaults to `'web'`. */
+    client?: MeClient;
 };
 export type SetOtpSecretKeyPayload = {
     secretKey: string;
 };
-export type RegisterTokenPayload = Record<string, unknown>;
+/** The push tokens of the user. `data` REPLACES the whole `data` of the user (it is not merged). */
+export type RegisterTokenPayload = {
+    data?: {
+        oneSignalToken?: string;
+        expoPushToken?: string | null;
+        fromApp?: boolean;
+    };
+    /** The backend ignores the call when it is `true`. */
+    isClientUser?: boolean;
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/apis/me/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/me/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAEhD,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,eAAe,CAAA;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,UAAU,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAA;IACnC,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/me/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAEhD,qFAAqF;AACrF,MAAM,MAAM,QAAQ,GAAG,KAAK,GAAG,KAAK,CAAA;AAEpC,+EAA+E;AAC/E,MAAM,MAAM,OAAO,GAAG;IACpB,OAAO,CAAC,EAAE,CACN,OAAO,GACP,aAAa,GACb,WAAW,GACX,SAAS,GACT,aAAa,GACb,eAAe,GACf,CAAC,MAAM,GAAG,EAAE,CAAC,CAChB,EAAE,CAAA;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;CACtB,CAAA;AAED,4GAA4G;AAC5G,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,kBAAkB,GAAG,eAAe,CAAA;AAEvE,+GAA+G;AAC/G,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,oBAAoB,EAAE,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,eAAe,EAAE,MAAM,CAAA;IACvB,gBAAgB,EAAE,MAAM,CAAA;IACxB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,aAAa,EAAE,MAAM,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,YAAY,CAAC,EAAE,YAAY,CAAA;CAC5B,CAAA;AAED,sFAAsF;AACtF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,UAAU,CAAA;IAClB,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAA;IACpD,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,kEAAkE;IAClE,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,eAAe,CAAA;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,UAAU,CAAA;IAClB,gDAAgD;IAChD,MAAM,CAAC,EAAE,QAAQ,CAAA;CAClB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAA;IACnC,cAAc,CAAC,EAAE,YAAY,GAAG,SAAS,GAAG,UAAU,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;IACtE,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,iBAAiB,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,2BAA2B;IAC3B,MAAM,CAAC,EAAE,QAAQ,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,oGAAoG;AACpG,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;IACpF,sDAAsD;IACtD,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA"}

package/dist/apis/transcripts/TranscriptsApi.cjs

@@ -4,9 +4,19 @@ const require_core_BaseApi = require('../../core/BaseApi.cjs');
 //#region src/apis/transcripts/TranscriptsApi.ts
 var TranscriptsApi = class extends require_core_BaseApi.BaseApi {
 	basePath = "/transcripts";
-	/** Triggers audio transcription for a message by dispatching an async job, and marks it as transcribing. */
+	/**
+	* Starts the transcription of the audio of a message: marks the message as transcribing and dispatches an async
+	* job, which calls the transcription service (AI) and debits the AI credits of the account. Resolves with no body;
+	* the result shows on the message. An unknown message answers 500.
+	*/
+	transcribe(messageId, headers) {
+		return this.client.get(`${this.basePath}/${messageId}`, headers);
+	}
+	/**
+	* @deprecated Not a read: it starts the transcription of the message. Use {@link transcribe}.
+	*/
 	getById(id, headers) {
-		return this.client.get(`${this.basePath}/${id}`, headers);
+		return this.transcribe(id, headers);
 	}
 };
 

package/dist/apis/transcripts/TranscriptsApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"TranscriptsApi.cjs","names":["BaseApi"],"sources":["../../../src/apis/transcripts/TranscriptsApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type { HasGetById } from '../../core/types'\nimport type { TranscriptResponse } from './types'\n\nexport class TranscriptsApi extends BaseApi implements HasGetById<TranscriptResponse> {\n  private readonly basePath = '/transcripts'\n\n  /** Triggers audio transcription for a message by dispatching an async job, and marks it as transcribing. */\n  getById(id: string, headers?: Record<string, string>): Promise<TranscriptResponse> {\n    return this.client.get<TranscriptResponse>(`${this.basePath}/${id}`, headers)\n  }\n}\n"],"mappings":";;;;AAIA,IAAa,iBAAb,cAAoCA,6BAAkD;CACpF,AAAiB,WAAW;;CAG5B,QAAQ,IAAY,SAA+D;AACjF,SAAO,KAAK,OAAO,IAAwB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ"}
+{"version":3,"file":"TranscriptsApi.cjs","names":["BaseApi"],"sources":["../../../src/apis/transcripts/TranscriptsApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\n\nexport class TranscriptsApi extends BaseApi {\n  private readonly basePath = '/transcripts'\n\n  /**\n   * Starts the transcription of the audio of a message: marks the message as transcribing and dispatches an async\n   * job, which calls the transcription service (AI) and debits the AI credits of the account. Resolves with no body;\n   * the result shows on the message. An unknown message answers 500.\n   */\n  transcribe(messageId: string, headers?: Record<string, string>): Promise<void> {\n    return this.client.get<void>(`${this.basePath}/${messageId}`, headers)\n  }\n\n  /**\n   * @deprecated Not a read: it starts the transcription of the message. Use {@link transcribe}.\n   */\n  getById(id: string, headers?: Record<string, string>): Promise<void> {\n    return this.transcribe(id, headers)\n  }\n}\n"],"mappings":";;;;AAEA,IAAa,iBAAb,cAAoCA,6BAAQ;CAC1C,AAAiB,WAAW;;;;;;CAO5B,WAAW,WAAmB,SAAiD;AAC7E,SAAO,KAAK,OAAO,IAAU,GAAG,KAAK,SAAS,GAAG,aAAa,QAAQ;;;;;CAMxE,QAAQ,IAAY,SAAiD;AACnE,SAAO,KAAK,WAAW,IAAI,QAAQ"}

package/dist/apis/transcripts/TranscriptsApi.d.ts

@@ -1,9 +1,15 @@
 import { BaseApi } from '../../core/BaseApi';
-import type { HasGetById } from '../../core/types';
-import type { TranscriptResponse } from './types';
-export declare class TranscriptsApi extends BaseApi implements HasGetById<TranscriptResponse> {
+export declare class TranscriptsApi extends BaseApi {
     private readonly basePath;
-    /** Triggers audio transcription for a message by dispatching an async job, and marks it as transcribing. */
-    getById(id: string, headers?: Record<string, string>): Promise<TranscriptResponse>;
+    /**
+     * Starts the transcription of the audio of a message: marks the message as transcribing and dispatches an async
+     * job, which calls the transcription service (AI) and debits the AI credits of the account. Resolves with no body;
+     * the result shows on the message. An unknown message answers 500.
+     */
+    transcribe(messageId: string, headers?: Record<string, string>): Promise<void>;
+    /**
+     * @deprecated Not a read: it starts the transcription of the message. Use {@link transcribe}.
+     */
+    getById(id: string, headers?: Record<string, string>): Promise<void>;
 }
 //# sourceMappingURL=TranscriptsApi.d.ts.map

package/dist/apis/transcripts/TranscriptsApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TranscriptsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/transcripts/TranscriptsApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAEjD,qBAAa,cAAe,SAAQ,OAAQ,YAAW,UAAU,CAAC,kBAAkB,CAAC;IACnF,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAiB;IAE1C,4GAA4G;IAC5G,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAGnF"}
+{"version":3,"file":"TranscriptsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/transcripts/TranscriptsApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAE5C,qBAAa,cAAe,SAAQ,OAAO;IACzC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAiB;IAE1C;;;;OAIG;IACH,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9E;;OAEG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAGrE"}

package/dist/apis/transcripts/TranscriptsApi.mjs

@@ -3,9 +3,19 @@ import { BaseApi } from "../../core/BaseApi.mjs";
 //#region src/apis/transcripts/TranscriptsApi.ts
 var TranscriptsApi = class extends BaseApi {
 	basePath = "/transcripts";
-	/** Triggers audio transcription for a message by dispatching an async job, and marks it as transcribing. */
+	/**
+	* Starts the transcription of the audio of a message: marks the message as transcribing and dispatches an async
+	* job, which calls the transcription service (AI) and debits the AI credits of the account. Resolves with no body;
+	* the result shows on the message. An unknown message answers 500.
+	*/
+	transcribe(messageId, headers) {
+		return this.client.get(`${this.basePath}/${messageId}`, headers);
+	}
+	/**
+	* @deprecated Not a read: it starts the transcription of the message. Use {@link transcribe}.
+	*/
 	getById(id, headers) {
-		return this.client.get(`${this.basePath}/${id}`, headers);
+		return this.transcribe(id, headers);
 	}
 };
 

package/dist/apis/transcripts/TranscriptsApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"TranscriptsApi.mjs","names":[],"sources":["../../../src/apis/transcripts/TranscriptsApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type { HasGetById } from '../../core/types'\nimport type { TranscriptResponse } from './types'\n\nexport class TranscriptsApi extends BaseApi implements HasGetById<TranscriptResponse> {\n  private readonly basePath = '/transcripts'\n\n  /** Triggers audio transcription for a message by dispatching an async job, and marks it as transcribing. */\n  getById(id: string, headers?: Record<string, string>): Promise<TranscriptResponse> {\n    return this.client.get<TranscriptResponse>(`${this.basePath}/${id}`, headers)\n  }\n}\n"],"mappings":";;;AAIA,IAAa,iBAAb,cAAoC,QAAkD;CACpF,AAAiB,WAAW;;CAG5B,QAAQ,IAAY,SAA+D;AACjF,SAAO,KAAK,OAAO,IAAwB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ"}
+{"version":3,"file":"TranscriptsApi.mjs","names":[],"sources":["../../../src/apis/transcripts/TranscriptsApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\n\nexport class TranscriptsApi extends BaseApi {\n  private readonly basePath = '/transcripts'\n\n  /**\n   * Starts the transcription of the audio of a message: marks the message as transcribing and dispatches an async\n   * job, which calls the transcription service (AI) and debits the AI credits of the account. Resolves with no body;\n   * the result shows on the message. An unknown message answers 500.\n   */\n  transcribe(messageId: string, headers?: Record<string, string>): Promise<void> {\n    return this.client.get<void>(`${this.basePath}/${messageId}`, headers)\n  }\n\n  /**\n   * @deprecated Not a read: it starts the transcription of the message. Use {@link transcribe}.\n   */\n  getById(id: string, headers?: Record<string, string>): Promise<void> {\n    return this.transcribe(id, headers)\n  }\n}\n"],"mappings":";;;AAEA,IAAa,iBAAb,cAAoC,QAAQ;CAC1C,AAAiB,WAAW;;;;;;CAO5B,WAAW,WAAmB,SAAiD;AAC7E,SAAO,KAAK,OAAO,IAAU,GAAG,KAAK,SAAS,GAAG,aAAa,QAAQ;;;;;CAMxE,QAAQ,IAAY,SAAiD;AACnE,SAAO,KAAK,WAAW,IAAI,QAAQ"}

package/dist/apis/transcripts/types.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @deprecated The route answers no body: `TranscriptsApi.transcribe` (and `getById`) resolve `undefined`. The
+ * transcription status shows on the message (`isTranscribing`, `transcribeError`).
+ */
 export type TranscriptResponse = {
     id: string;
     isTranscribing: boolean;

package/dist/apis/transcripts/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/transcripts/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,cAAc,EAAE,OAAO,CAAA;IACvB,eAAe,EAAE,OAAO,CAAA;CACzB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/transcripts/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,cAAc,EAAE,OAAO,CAAA;IACvB,eAAe,EAAE,OAAO,CAAA;CACzB,CAAA"}

package/dist/apis/whatsappBusinessTemplates/WhatsappBusinessTemplatesApi.cjs

@@ -2,10 +2,62 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_core_BaseCrudApi = require('../../core/BaseCrudApi.cjs');
 
 //#region src/apis/whatsappBusinessTemplates/WhatsappBusinessTemplatesApi.ts
+/**
+* WhatsApp Business templates. Create, update, reads and count are local; `sendToReview`, `refreshTemplates`,
+* `resume` and the delete of a template of a `whatsapp-business` connection call the provider (Meta, 360Dialog).
+* `getById` answers `null` for an unknown id.
+*/
 var WhatsappBusinessTemplatesApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	constructor(client) {
 		super(client, "/whatsapp-business-templates");
 	}
+	/**
+	* Counts the templates matching the query.
+	* @permissions hsm.view
+	*/
+	count(query, headers) {
+		return this.client.get(`${this.basePath}/count${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* Reads the template limit of the plan of the account. Send the `accountId` of the current user: the route is
+	* outside the error handler of the backend, so an unknown id gets no answer (the request waits for the timeout).
+	* @permissions hsm.view
+	*/
+	getHsmLimit(accountId, headers) {
+		return this.client.get(`${this.basePath}/${accountId}/hsmLimit`, headers);
+	}
+	/**
+	* Deletes a template. On a `whatsapp-business` connection it goes to the provider (and answers what it answers);
+	* a draft of another connection type is deleted locally (answers the stored template). An unknown id answers 500.
+	* @permissions hsm.view OR hsm.destroy
+	*/
+	deleteById(id, headers) {
+		return super.deleteById(id, headers);
+	}
+	/**
+	* SENDS the template to Meta for approval (through the provider of the connection). An unknown or archived
+	* template answers 500 before anything is sent.
+	* @permissions hsm.view OR hsm.send OR hsm.send.before.expire
+	*/
+	sendToReview(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/send-to-review`, void 0, headers);
+	}
+	/**
+	* Reads the templates of the connected `whatsapp-business` connections from the provider and syncs them (it may
+	* archive the local templates the provider no longer has). Resolves the text `'OK'`.
+	* @permissions hsm.view
+	*/
+	refreshTemplates(headers) {
+		return this.client.post(`${this.basePath}/refresh-templates`, void 0, headers);
+	}
+	/**
+	* Reads the template balance from 360Dialog. The backend looks for the 360Dialog connection on the whole platform,
+	* not only in the account, and calls 360Dialog when it finds one.
+	* @permissions hsm.view
+	*/
+	resume(headers) {
+		return this.client.get(`${this.basePath}/resume`, headers);
+	}
 };
 
 //#endregion

package/dist/apis/whatsappBusinessTemplates/WhatsappBusinessTemplatesApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"WhatsappBusinessTemplatesApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/whatsappBusinessTemplates/WhatsappBusinessTemplatesApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  WhatsappBusinessTemplate,\n  CreateWhatsappBusinessTemplatePayload,\n  UpdateWhatsappBusinessTemplatePayload,\n} from './types'\n\nexport class WhatsappBusinessTemplatesApi extends BaseCrudApi<\n  WhatsappBusinessTemplate,\n  CreateWhatsappBusinessTemplatePayload,\n  UpdateWhatsappBusinessTemplatePayload\n> {\n  constructor(client: ApiClient) {\n    super(client, '/whatsapp-business-templates')\n  }\n}\n"],"mappings":";;;;AAQA,IAAa,+BAAb,cAAkDA,qCAIhD;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,+BAA+B"}
+{"version":3,"file":"WhatsappBusinessTemplatesApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/whatsappBusinessTemplates/WhatsappBusinessTemplatesApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  WhatsappBusinessTemplate,\n  CreateWhatsappBusinessTemplatePayload,\n  UpdateWhatsappBusinessTemplatePayload,\n  WhatsappBusinessTemplateHsmLimit,\n} from './types'\n\n/**\n * WhatsApp Business templates. Create, update, reads and count are local; `sendToReview`, `refreshTemplates`,\n * `resume` and the delete of a template of a `whatsapp-business` connection call the provider (Meta, 360Dialog).\n * `getById` answers `null` for an unknown id.\n */\nexport class WhatsappBusinessTemplatesApi extends BaseCrudApi<\n  WhatsappBusinessTemplate,\n  CreateWhatsappBusinessTemplatePayload,\n  UpdateWhatsappBusinessTemplatePayload,\n  ListQuery<WhatsappBusinessTemplate>,\n  unknown\n> {\n  constructor(client: ApiClient) {\n    super(client, '/whatsapp-business-templates')\n  }\n\n  /**\n   * Counts the templates matching the query.\n   * @permissions hsm.view\n   */\n  count(\n    query?: ListQuery<WhatsappBusinessTemplate>,\n    headers?: Record<string, string>,\n  ): Promise<{ count: number }> {\n    return this.client.get<{ count: number }>(\n      `${this.basePath}/count${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Reads the template limit of the plan of the account. Send the `accountId` of the current user: the route is\n   * outside the error handler of the backend, so an unknown id gets no answer (the request waits for the timeout).\n   * @permissions hsm.view\n   */\n  getHsmLimit(\n    accountId: string,\n    headers?: Record<string, string>,\n  ): Promise<WhatsappBusinessTemplateHsmLimit> {\n    return this.client.get<WhatsappBusinessTemplateHsmLimit>(\n      `${this.basePath}/${accountId}/hsmLimit`,\n      headers,\n    )\n  }\n\n  /**\n   * Deletes a template. On a `whatsapp-business` connection it goes to the provider (and answers what it answers);\n   * a draft of another connection type is deleted locally (answers the stored template). An unknown id answers 500.\n   * @permissions hsm.view OR hsm.destroy\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<unknown> {\n    return super.deleteById(id, headers)\n  }\n\n  /**\n   * SENDS the template to Meta for approval (through the provider of the connection). An unknown or archived\n   * template answers 500 before anything is sent.\n   * @permissions hsm.view OR hsm.send OR hsm.send.before.expire\n   */\n  sendToReview(id: string, headers?: Record<string, string>): Promise<unknown> {\n    return this.client.post<unknown>(`${this.basePath}/${id}/send-to-review`, undefined, headers)\n  }\n\n  /**\n   * Reads the templates of the connected `whatsapp-business` connections from the provider and syncs them (it may\n   * archive the local templates the provider no longer has). Resolves the text `'OK'`.\n   * @permissions hsm.view\n   */\n  refreshTemplates(headers?: Record<string, string>): Promise<'OK'> {\n    return this.client.post<'OK'>(`${this.basePath}/refresh-templates`, undefined, headers)\n  }\n\n  /**\n   * Reads the template balance from 360Dialog. The backend looks for the 360Dialog connection on the whole platform,\n   * not only in the account, and calls 360Dialog when it finds one.\n   * @permissions hsm.view\n   */\n  resume(headers?: Record<string, string>): Promise<Record<string, unknown>[]> {\n    return this.client.get<Record<string, unknown>[]>(`${this.basePath}/resume`, headers)\n  }\n}\n"],"mappings":";;;;;;;;;AAeA,IAAa,+BAAb,cAAkDA,qCAMhD;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,+BAA+B;;;;;;CAO/C,MACE,OACA,SAC4B;AAC5B,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,QAAQ,KAAK,cAAc,MAAM,IAClD,QACD;;;;;;;CAQH,YACE,WACA,SAC2C;AAC3C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,GAAG,UAAU,YAC9B,QACD;;;;;;;CAQH,AAAS,WAAW,IAAY,SAAoD;AAClF,SAAO,MAAM,WAAW,IAAI,QAAQ;;;;;;;CAQtC,aAAa,IAAY,SAAoD;AAC3E,SAAO,KAAK,OAAO,KAAc,GAAG,KAAK,SAAS,GAAG,GAAG,kBAAkB,QAAW,QAAQ;;;;;;;CAQ/F,iBAAiB,SAAiD;AAChE,SAAO,KAAK,OAAO,KAAW,GAAG,KAAK,SAAS,qBAAqB,QAAW,QAAQ;;;;;;;CAQzF,OAAO,SAAsE;AAC3E,SAAO,KAAK,OAAO,IAA+B,GAAG,KAAK,SAAS,UAAU,QAAQ"}

package/dist/apis/whatsappBusinessTemplates/WhatsappBusinessTemplatesApi.d.ts

@@ -1,7 +1,50 @@
 import type { ApiClient } from '../../core/ApiClient';
+import type { ListQuery } from '../../core/types';
 import { BaseCrudApi } from '../../core/BaseCrudApi';
-import type { WhatsappBusinessTemplate, CreateWhatsappBusinessTemplatePayload, UpdateWhatsappBusinessTemplatePayload } from './types';
-export declare class WhatsappBusinessTemplatesApi extends BaseCrudApi<WhatsappBusinessTemplate, CreateWhatsappBusinessTemplatePayload, UpdateWhatsappBusinessTemplatePayload> {
+import type { WhatsappBusinessTemplate, CreateWhatsappBusinessTemplatePayload, UpdateWhatsappBusinessTemplatePayload, WhatsappBusinessTemplateHsmLimit } from './types';
+/**
+ * WhatsApp Business templates. Create, update, reads and count are local; `sendToReview`, `refreshTemplates`,
+ * `resume` and the delete of a template of a `whatsapp-business` connection call the provider (Meta, 360Dialog).
+ * `getById` answers `null` for an unknown id.
+ */
+export declare class WhatsappBusinessTemplatesApi extends BaseCrudApi<WhatsappBusinessTemplate, CreateWhatsappBusinessTemplatePayload, UpdateWhatsappBusinessTemplatePayload, ListQuery<WhatsappBusinessTemplate>, unknown> {
     constructor(client: ApiClient);
+    /**
+     * Counts the templates matching the query.
+     * @permissions hsm.view
+     */
+    count(query?: ListQuery<WhatsappBusinessTemplate>, headers?: Record<string, string>): Promise<{
+        count: number;
+    }>;
+    /**
+     * Reads the template limit of the plan of the account. Send the `accountId` of the current user: the route is
+     * outside the error handler of the backend, so an unknown id gets no answer (the request waits for the timeout).
+     * @permissions hsm.view
+     */
+    getHsmLimit(accountId: string, headers?: Record<string, string>): Promise<WhatsappBusinessTemplateHsmLimit>;
+    /**
+     * Deletes a template. On a `whatsapp-business` connection it goes to the provider (and answers what it answers);
+     * a draft of another connection type is deleted locally (answers the stored template). An unknown id answers 500.
+     * @permissions hsm.view OR hsm.destroy
+     */
+    deleteById(id: string, headers?: Record<string, string>): Promise<unknown>;
+    /**
+     * SENDS the template to Meta for approval (through the provider of the connection). An unknown or archived
+     * template answers 500 before anything is sent.
+     * @permissions hsm.view OR hsm.send OR hsm.send.before.expire
+     */
+    sendToReview(id: string, headers?: Record<string, string>): Promise<unknown>;
+    /**
+     * Reads the templates of the connected `whatsapp-business` connections from the provider and syncs them (it may
+     * archive the local templates the provider no longer has). Resolves the text `'OK'`.
+     * @permissions hsm.view
+     */
+    refreshTemplates(headers?: Record<string, string>): Promise<'OK'>;
+    /**
+     * Reads the template balance from 360Dialog. The backend looks for the 360Dialog connection on the whole platform,
+     * not only in the account, and calls 360Dialog when it finds one.
+     * @permissions hsm.view
+     */
+    resume(headers?: Record<string, string>): Promise<Record<string, unknown>[]>;
 }
 //# sourceMappingURL=WhatsappBusinessTemplatesApi.d.ts.map

package/dist/apis/whatsappBusinessTemplates/WhatsappBusinessTemplatesApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WhatsappBusinessTemplatesApi.d.ts","sourceRoot":"","sources":["../../../src/apis/whatsappBusinessTemplates/WhatsappBusinessTemplatesApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EACV,wBAAwB,EACxB,qCAAqC,EACrC,qCAAqC,EACtC,MAAM,SAAS,CAAA;AAEhB,qBAAa,4BAA6B,SAAQ,WAAW,CAC3D,wBAAwB,EACxB,qCAAqC,EACrC,qCAAqC,CACtC;gBACa,MAAM,EAAE,SAAS;CAG9B"}
+{"version":3,"file":"WhatsappBusinessTemplatesApi.d.ts","sourceRoot":"","sources":["../../../src/apis/whatsappBusinessTemplates/WhatsappBusinessTemplatesApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EACV,wBAAwB,EACxB,qCAAqC,EACrC,qCAAqC,EACrC,gCAAgC,EACjC,MAAM,SAAS,CAAA;AAEhB;;;;GAIG;AACH,qBAAa,4BAA6B,SAAQ,WAAW,CAC3D,wBAAwB,EACxB,qCAAqC,EACrC,qCAAqC,EACrC,SAAS,CAAC,wBAAwB,CAAC,EACnC,OAAO,CACR;gBACa,MAAM,EAAE,SAAS;IAI7B;;;OAGG;IACH,KAAK,CACH,KAAK,CAAC,EAAE,SAAS,CAAC,wBAAwB,CAAC,EAC3C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAO7B;;;;OAIG;IACH,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,gCAAgC,CAAC;IAO5C;;;;OAIG;IACM,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAInF;;;;OAIG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5E;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjE;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;CAG7E"}

package/dist/apis/whatsappBusinessTemplates/WhatsappBusinessTemplatesApi.mjs

@@ -1,10 +1,62 @@
 import { BaseCrudApi } from "../../core/BaseCrudApi.mjs";
 
 //#region src/apis/whatsappBusinessTemplates/WhatsappBusinessTemplatesApi.ts
+/**
+* WhatsApp Business templates. Create, update, reads and count are local; `sendToReview`, `refreshTemplates`,
+* `resume` and the delete of a template of a `whatsapp-business` connection call the provider (Meta, 360Dialog).
+* `getById` answers `null` for an unknown id.
+*/
 var WhatsappBusinessTemplatesApi = class extends BaseCrudApi {
 	constructor(client) {
 		super(client, "/whatsapp-business-templates");
 	}
+	/**
+	* Counts the templates matching the query.
+	* @permissions hsm.view
+	*/
+	count(query, headers) {
+		return this.client.get(`${this.basePath}/count${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* Reads the template limit of the plan of the account. Send the `accountId` of the current user: the route is
+	* outside the error handler of the backend, so an unknown id gets no answer (the request waits for the timeout).
+	* @permissions hsm.view
+	*/
+	getHsmLimit(accountId, headers) {
+		return this.client.get(`${this.basePath}/${accountId}/hsmLimit`, headers);
+	}
+	/**
+	* Deletes a template. On a `whatsapp-business` connection it goes to the provider (and answers what it answers);
+	* a draft of another connection type is deleted locally (answers the stored template). An unknown id answers 500.
+	* @permissions hsm.view OR hsm.destroy
+	*/
+	deleteById(id, headers) {
+		return super.deleteById(id, headers);
+	}
+	/**
+	* SENDS the template to Meta for approval (through the provider of the connection). An unknown or archived
+	* template answers 500 before anything is sent.
+	* @permissions hsm.view OR hsm.send OR hsm.send.before.expire
+	*/
+	sendToReview(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/send-to-review`, void 0, headers);
+	}
+	/**
+	* Reads the templates of the connected `whatsapp-business` connections from the provider and syncs them (it may
+	* archive the local templates the provider no longer has). Resolves the text `'OK'`.
+	* @permissions hsm.view
+	*/
+	refreshTemplates(headers) {
+		return this.client.post(`${this.basePath}/refresh-templates`, void 0, headers);
+	}
+	/**
+	* Reads the template balance from 360Dialog. The backend looks for the 360Dialog connection on the whole platform,
+	* not only in the account, and calls 360Dialog when it finds one.
+	* @permissions hsm.view
+	*/
+	resume(headers) {
+		return this.client.get(`${this.basePath}/resume`, headers);
+	}
 };
 
 //#endregion

package/dist/apis/whatsappBusinessTemplates/WhatsappBusinessTemplatesApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"WhatsappBusinessTemplatesApi.mjs","names":[],"sources":["../../../src/apis/whatsappBusinessTemplates/WhatsappBusinessTemplatesApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  WhatsappBusinessTemplate,\n  CreateWhatsappBusinessTemplatePayload,\n  UpdateWhatsappBusinessTemplatePayload,\n} from './types'\n\nexport class WhatsappBusinessTemplatesApi extends BaseCrudApi<\n  WhatsappBusinessTemplate,\n  CreateWhatsappBusinessTemplatePayload,\n  UpdateWhatsappBusinessTemplatePayload\n> {\n  constructor(client: ApiClient) {\n    super(client, '/whatsapp-business-templates')\n  }\n}\n"],"mappings":";;;AAQA,IAAa,+BAAb,cAAkD,YAIhD;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,+BAA+B"}
+{"version":3,"file":"WhatsappBusinessTemplatesApi.mjs","names":[],"sources":["../../../src/apis/whatsappBusinessTemplates/WhatsappBusinessTemplatesApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport type { ListQuery } from '../../core/types'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  WhatsappBusinessTemplate,\n  CreateWhatsappBusinessTemplatePayload,\n  UpdateWhatsappBusinessTemplatePayload,\n  WhatsappBusinessTemplateHsmLimit,\n} from './types'\n\n/**\n * WhatsApp Business templates. Create, update, reads and count are local; `sendToReview`, `refreshTemplates`,\n * `resume` and the delete of a template of a `whatsapp-business` connection call the provider (Meta, 360Dialog).\n * `getById` answers `null` for an unknown id.\n */\nexport class WhatsappBusinessTemplatesApi extends BaseCrudApi<\n  WhatsappBusinessTemplate,\n  CreateWhatsappBusinessTemplatePayload,\n  UpdateWhatsappBusinessTemplatePayload,\n  ListQuery<WhatsappBusinessTemplate>,\n  unknown\n> {\n  constructor(client: ApiClient) {\n    super(client, '/whatsapp-business-templates')\n  }\n\n  /**\n   * Counts the templates matching the query.\n   * @permissions hsm.view\n   */\n  count(\n    query?: ListQuery<WhatsappBusinessTemplate>,\n    headers?: Record<string, string>,\n  ): Promise<{ count: number }> {\n    return this.client.get<{ count: number }>(\n      `${this.basePath}/count${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Reads the template limit of the plan of the account. Send the `accountId` of the current user: the route is\n   * outside the error handler of the backend, so an unknown id gets no answer (the request waits for the timeout).\n   * @permissions hsm.view\n   */\n  getHsmLimit(\n    accountId: string,\n    headers?: Record<string, string>,\n  ): Promise<WhatsappBusinessTemplateHsmLimit> {\n    return this.client.get<WhatsappBusinessTemplateHsmLimit>(\n      `${this.basePath}/${accountId}/hsmLimit`,\n      headers,\n    )\n  }\n\n  /**\n   * Deletes a template. On a `whatsapp-business` connection it goes to the provider (and answers what it answers);\n   * a draft of another connection type is deleted locally (answers the stored template). An unknown id answers 500.\n   * @permissions hsm.view OR hsm.destroy\n   */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<unknown> {\n    return super.deleteById(id, headers)\n  }\n\n  /**\n   * SENDS the template to Meta for approval (through the provider of the connection). An unknown or archived\n   * template answers 500 before anything is sent.\n   * @permissions hsm.view OR hsm.send OR hsm.send.before.expire\n   */\n  sendToReview(id: string, headers?: Record<string, string>): Promise<unknown> {\n    return this.client.post<unknown>(`${this.basePath}/${id}/send-to-review`, undefined, headers)\n  }\n\n  /**\n   * Reads the templates of the connected `whatsapp-business` connections from the provider and syncs them (it may\n   * archive the local templates the provider no longer has). Resolves the text `'OK'`.\n   * @permissions hsm.view\n   */\n  refreshTemplates(headers?: Record<string, string>): Promise<'OK'> {\n    return this.client.post<'OK'>(`${this.basePath}/refresh-templates`, undefined, headers)\n  }\n\n  /**\n   * Reads the template balance from 360Dialog. The backend looks for the 360Dialog connection on the whole platform,\n   * not only in the account, and calls 360Dialog when it finds one.\n   * @permissions hsm.view\n   */\n  resume(headers?: Record<string, string>): Promise<Record<string, unknown>[]> {\n    return this.client.get<Record<string, unknown>[]>(`${this.basePath}/resume`, headers)\n  }\n}\n"],"mappings":";;;;;;;;AAeA,IAAa,+BAAb,cAAkD,YAMhD;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,+BAA+B;;;;;;CAO/C,MACE,OACA,SAC4B;AAC5B,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,QAAQ,KAAK,cAAc,MAAM,IAClD,QACD;;;;;;;CAQH,YACE,WACA,SAC2C;AAC3C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,GAAG,UAAU,YAC9B,QACD;;;;;;;CAQH,AAAS,WAAW,IAAY,SAAoD;AAClF,SAAO,MAAM,WAAW,IAAI,QAAQ;;;;;;;CAQtC,aAAa,IAAY,SAAoD;AAC3E,SAAO,KAAK,OAAO,KAAc,GAAG,KAAK,SAAS,GAAG,GAAG,kBAAkB,QAAW,QAAQ;;;;;;;CAQ/F,iBAAiB,SAAiD;AAChE,SAAO,KAAK,OAAO,KAAW,GAAG,KAAK,SAAS,qBAAqB,QAAW,QAAQ;;;;;;;CAQzF,OAAO,SAAsE;AAC3E,SAAO,KAAK,OAAO,IAA+B,GAAG,KAAK,SAAS,UAAU,QAAQ"}