@wix/auto_sdk_staff-time-clock_time-clock-settings 0.0.0-stage → 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,35 @@
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { GetTimeClockSettingsResponse, TimeClockSettings } from './index.typings.js';
+export { AccountInfo, ActionEvent, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, GetTimeClockSettingsRequest, IdentificationData, IdentificationDataIdOneOf, MessageEnvelope, RestoreInfo, Task, UpdateTimeClockSettingsRequest, UpdateTimeClockSettingsResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
+
+declare function getTimeClockSettings$1(httpClient: HttpClient): GetTimeClockSettingsSignature;
+interface GetTimeClockSettingsSignature {
+    /**
+     * Retrieves the site's time clock settings.
+     *
+     * If the settings were never updated, the defaults are returned: an empty task
+     * catalog and self clock-in disabled.
+     */
+    (): Promise<NonNullablePaths<GetTimeClockSettingsResponse, `timeClockSettings.tasks` | `timeClockSettings.tasks.${number}.label` | `timeClockSettings.tasks.${number}.paid` | `timeClockSettings.selfClockInEnabled`, 3>>;
+}
+declare function updateTimeClockSettings$1(httpClient: HttpClient): UpdateTimeClockSettingsSignature;
+interface UpdateTimeClockSettingsSignature {
+    /**
+     * Updates the site's time clock settings.
+     *
+     * Only the fields in `fieldMask` are updated. Without `fieldMask`, it's inferred
+     * from the fields you pass.
+     *
+     * `tasks` is replaced as a whole. To add, rename, or remove a task, pass the
+     * full task catalog. Keep the ID of each existing task, and leave the ID empty
+     * for a new task so one is assigned.
+     * @param - Settings to update; may be partial (see `field_mask`).
+     * @returns The settings after the update.
+     */
+    (timeClockSettings: TimeClockSettings): Promise<NonNullablePaths<TimeClockSettings, `tasks` | `tasks.${number}.label` | `tasks.${number}.paid` | `selfClockInEnabled`, 2>>;
+}
+
+declare const getTimeClockSettings: MaybeContext<BuildRESTFunction<typeof getTimeClockSettings$1> & typeof getTimeClockSettings$1>;
+declare const updateTimeClockSettings: MaybeContext<BuildRESTFunction<typeof updateTimeClockSettings$1> & typeof updateTimeClockSettings$1>;
+
+export { GetTimeClockSettingsResponse, TimeClockSettings, getTimeClockSettings, updateTimeClockSettings };

package/build/cjs/index.js

@@ -0,0 +1,209 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.ts
+var index_exports = {};
+__export(index_exports, {
+  WebhookIdentityType: () => WebhookIdentityType,
+  getTimeClockSettings: () => getTimeClockSettings4,
+  updateTimeClockSettings: () => updateTimeClockSettings4
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/staff-time-clock-v1-time-clock-settings-time-clock-settings.universal.ts
+var import_transform_error = require("@wix/sdk-runtime/transform-error");
+var import_rename_all_nested_keys = require("@wix/sdk-runtime/rename-all-nested-keys");
+
+// src/staff-time-clock-v1-time-clock-settings-time-clock-settings.http.ts
+var import_rest_modules = require("@wix/sdk-runtime/rest-modules");
+var import_timestamp = require("@wix/sdk-runtime/transformations/timestamp");
+var import_timestamp2 = require("@wix/sdk-runtime/transformations/timestamp");
+var import_field_mask = require("@wix/sdk-runtime/transformations/field-mask");
+var import_transform_paths = require("@wix/sdk-runtime/transformations/transform-paths");
+var import_rest_modules2 = require("@wix/sdk-runtime/rest-modules");
+var TRANSFORM_PATHS_0 = [
+  { path: "timeClockSettings.createdDate" },
+  { path: "timeClockSettings.updatedDate" }
+];
+var TRANSFORM_PATHS_1 = [{ path: "fieldMask" }];
+function resolveWixStaffTimeClockV1TimeClockSettingsServiceUrl(opts) {
+  const domainToMappings = {
+    "manage._base_domain_": [
+      {
+        srcPath: "/_api/time-clock-settings",
+        destPath: ""
+      }
+    ]
+  };
+  return (0, import_rest_modules2.resolveUrl)(Object.assign(opts, { domainToMappings }));
+}
+var PACKAGE_NAME = "@wix/auto_sdk_staff-time-clock_time-clock-settings";
+function getTimeClockSettings(payload) {
+  function __getTimeClockSettings({ host }) {
+    const metadata = {
+      entityFqdn: "wix.staff.time_clock.v1.time_clock_settings",
+      method: "GET",
+      methodFqn: "wix.staff.time_clock.v1.TimeClockSettingsService.GetTimeClockSettings",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixStaffTimeClockV1TimeClockSettingsServiceUrl({
+        protoPath: "/v1/time-clock-settings",
+        data: payload,
+        host
+      }),
+      params: (0, import_rest_modules.toURLSearchParams)(payload),
+      transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
+        {
+          transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
+          paths: TRANSFORM_PATHS_0
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __getTimeClockSettings;
+}
+function updateTimeClockSettings(payload) {
+  function __updateTimeClockSettings({ host }) {
+    const serializedData = (0, import_transform_paths.transformPaths)(payload, [
+      {
+        transformFn: import_field_mask.transformSDKFieldMaskToRESTFieldMask,
+        paths: TRANSFORM_PATHS_1
+      },
+      {
+        transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
+        paths: TRANSFORM_PATHS_0
+      }
+    ]);
+    const metadata = {
+      entityFqdn: "wix.staff.time_clock.v1.time_clock_settings",
+      method: "PATCH",
+      methodFqn: "wix.staff.time_clock.v1.TimeClockSettingsService.UpdateTimeClockSettings",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixStaffTimeClockV1TimeClockSettingsServiceUrl({
+        protoPath: "/v1/time-clock-settings",
+        data: serializedData,
+        host
+      }),
+      data: serializedData,
+      transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
+        {
+          transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
+          paths: TRANSFORM_PATHS_0
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __updateTimeClockSettings;
+}
+
+// src/staff-time-clock-v1-time-clock-settings-time-clock-settings.universal.ts
+var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
+  WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
+  WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+  WebhookIdentityType2["MEMBER"] = "MEMBER";
+  WebhookIdentityType2["WIX_USER"] = "WIX_USER";
+  WebhookIdentityType2["APP"] = "APP";
+  return WebhookIdentityType2;
+})(WebhookIdentityType || {});
+async function getTimeClockSettings2() {
+  const { httpClient, sideEffects } = arguments[0];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({});
+  const reqOpts = getTimeClockSettings(
+    payload
+  );
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {},
+        singleArgumentUnchanged: false
+      },
+      []
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function updateTimeClockSettings2(timeClockSettings) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    timeClockSettings
+  });
+  const reqOpts = updateTimeClockSettings(
+    payload
+  );
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data)?.timeClockSettings;
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { timeClockSettings: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["timeClockSettings"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+
+// src/staff-time-clock-v1-time-clock-settings-time-clock-settings.public.ts
+function getTimeClockSettings3(httpClient) {
+  return () => getTimeClockSettings2(
+    // @ts-ignore
+    { httpClient }
+  );
+}
+function updateTimeClockSettings3(httpClient) {
+  return (timeClockSettings) => updateTimeClockSettings2(
+    timeClockSettings,
+    // @ts-ignore
+    { httpClient }
+  );
+}
+
+// src/staff-time-clock-v1-time-clock-settings-time-clock-settings.context.ts
+var import_rest_modules3 = require("@wix/sdk-runtime/rest-modules");
+var getTimeClockSettings4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getTimeClockSettings3);
+var updateTimeClockSettings4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(updateTimeClockSettings3);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  WebhookIdentityType,
+  getTimeClockSettings,
+  updateTimeClockSettings
+});
+//# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts","../../src/staff-time-clock-v1-time-clock-settings-time-clock-settings.universal.ts","../../src/staff-time-clock-v1-time-clock-settings-time-clock-settings.http.ts","../../src/staff-time-clock-v1-time-clock-settings-time-clock-settings.public.ts","../../src/staff-time-clock-v1-time-clock-settings-time-clock-settings.context.ts"],"sourcesContent":["export * from './src/staff-time-clock-v1-time-clock-settings-time-clock-settings.context.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixStaffTimeClockV1TimeClockSettings from './staff-time-clock-v1-time-clock-settings-time-clock-settings.http.js';\n\n/**\n * A site's time clock settings: the tasks staff members can work on during a\n * shift, and whether they can clock themselves in. Each site has 1 set of time\n * clock settings.\n */\nexport interface TimeClockSettings {\n  /**\n   * Time clock settings ID.\n   * @format GUID\n   * @readonly\n   */\n  _id?: string | null;\n  /**\n   * Revision number, incremented on each update.\n   * @readonly\n   */\n  revision?: string | null;\n  /**\n   * Date and time the settings were created.\n   * @readonly\n   */\n  _createdDate?: Date | null;\n  /**\n   * Date and time the settings were last updated.\n   * @readonly\n   */\n  _updatedDate?: Date | null;\n  /**\n   * Task catalog: the tasks staff members can start during a timecard. Empty\n   * by default. Replaced as a whole on update.\n   * @maxSize 100\n   */\n  tasks?: Task[];\n  /**\n   * Whether staff members can clock themselves in and start tasks, for example\n   * from their own phone. When `false`, staff members who are already clocked\n   * in can still clock themselves out. Clocking in on behalf of a staff member,\n   * such as from a kiosk, isn't affected. Default: `false`.\n   */\n  selfClockInEnabled?: boolean;\n  /**\n   * How long, in seconds, a timecard can stay open before it's closed\n   * automatically. Default: `86400` (24 hours).\n   * @internal\n   * @min 60\n   * @max 86400\n   */\n  autoClockOutThresholdInSeconds?: number | null;\n}\n\n/**\n * A kind of work a staff member can start during a timecard, such as \"Front\n * desk\" or \"Lunch\". Time spent on an unpaid task isn't counted as paid working\n * time.\n */\nexport interface Task {\n  /**\n   * Task ID. Leave empty when adding a task, and one is assigned. Pass the\n   * existing ID when updating a task. Tasks are identified by ID, so 2 tasks\n   * can have the same label.\n   * @format GUID\n   */\n  _id?: string | null;\n  /**\n   * Task name shown to staff members and managers, such as \"Lunch\" or\n   * \"Training\".\n   * @maxLength 100\n   */\n  label?: string;\n  /** Whether time spent on this task counts as paid working time. */\n  paid?: boolean;\n}\n\nexport interface GetTimeClockSettingsRequest {}\n\nexport interface GetTimeClockSettingsResponse {\n  /** The current site's time-clock settings. */\n  timeClockSettings?: TimeClockSettings;\n}\n\nexport interface UpdateTimeClockSettingsRequest {\n  /** Settings to update; may be partial (see `field_mask`). */\n  timeClockSettings: TimeClockSettings;\n  /**\n   * Set of fields to update. Inferred from the payload when omitted.\n   * @internal\n   */\n  fieldMask?: string[];\n}\n\nexport interface UpdateTimeClockSettingsResponse {\n  /** The settings after the update. */\n  timeClockSettings?: TimeClockSettings;\n}\n\nexport interface DomainEvent extends DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */\n  _id?: string;\n  /**\n   * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\n   * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.\n   */\n  entityFqdn?: string;\n  /**\n   * Event action name, placed at the top level to make it easier for users to dispatch messages.\n   * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.\n   */\n  slug?: string;\n  /** ID of the entity associated with the event. */\n  entityId?: string;\n  /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */\n  eventTime?: Date | null;\n  /**\n   * Whether the event was triggered as a result of a privacy regulation application\n   * (for example, GDPR).\n   */\n  triggeredByAnonymizeRequest?: boolean | null;\n  /** If present, indicates the action that triggered the event. */\n  originatedFrom?: string | null;\n  /**\n   * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.\n   * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.\n   */\n  entityEventSequence?: string | null;\n}\n\n/** @oneof */\nexport interface DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n}\n\nexport interface EntityCreatedEvent {\n  entity?: string;\n}\n\nexport interface RestoreInfo {\n  deletedDate?: Date | null;\n}\n\nexport interface EntityUpdatedEvent {\n  /**\n   * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n   * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n   * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n   */\n  currentEntity?: string;\n}\n\nexport interface EntityDeletedEvent {\n  /** Entity that was deleted. */\n  deletedEntity?: string | null;\n}\n\nexport interface ActionEvent {\n  body?: string;\n}\n\nexport interface MessageEnvelope {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n  /** Stringify payload. */\n  data?: string;\n  /** Details related to the account */\n  accountInfo?: AccountInfo;\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: WebhookIdentityTypeWithLiterals;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n\nexport enum WebhookIdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\n/** @enumType */\nexport type WebhookIdentityTypeWithLiterals =\n  | WebhookIdentityType\n  | 'UNKNOWN'\n  | 'ANONYMOUS_VISITOR'\n  | 'MEMBER'\n  | 'WIX_USER'\n  | 'APP';\n\nexport interface AccountInfo {\n  /**\n   * ID of the Wix account associated with the event.\n   * @format GUID\n   */\n  accountId?: string | null;\n  /**\n   * ID of the parent Wix account. Only included when accountId belongs to a child account.\n   * @format GUID\n   */\n  parentAccountId?: string | null;\n  /**\n   * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.\n   * @format GUID\n   */\n  siteId?: string | null;\n}\n\n/**\n * Retrieves the site's time clock settings.\n *\n * If the settings were never updated, the defaults are returned: an empty task\n * catalog and self clock-in disabled.\n * @public\n * @documentationMaturity preview\n * @permissionId staff:time_clock:v1:time_clock_settings:get_time_clock_settings\n * @applicableIdentity APP\n * @fqn wix.staff.time_clock.v1.TimeClockSettingsService.GetTimeClockSettings\n */\nexport async function getTimeClockSettings(): Promise<\n  NonNullablePaths<\n    GetTimeClockSettingsResponse,\n    | `timeClockSettings.tasks`\n    | `timeClockSettings.tasks.${number}.label`\n    | `timeClockSettings.tasks.${number}.paid`\n    | `timeClockSettings.selfClockInEnabled`,\n    3\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[0] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({});\n\n  const reqOpts =\n    ambassadorWixStaffTimeClockV1TimeClockSettings.getTimeClockSettings(\n      payload\n    );\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {},\n        singleArgumentUnchanged: false,\n      },\n      []\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\n/**\n * Updates the site's time clock settings.\n *\n * Only the fields in `fieldMask` are updated. Without `fieldMask`, it's inferred\n * from the fields you pass.\n *\n * `tasks` is replaced as a whole. To add, rename, or remove a task, pass the\n * full task catalog. Keep the ID of each existing task, and leave the ID empty\n * for a new task so one is assigned.\n * @param timeClockSettings - Settings to update; may be partial (see `field_mask`).\n * @public\n * @documentationMaturity preview\n * @requiredField timeClockSettings\n * @permissionId staff:time_clock:v1:time_clock_settings:update_time_clock_settings\n * @applicableIdentity APP\n * @returns The settings after the update.\n * @fqn wix.staff.time_clock.v1.TimeClockSettingsService.UpdateTimeClockSettings\n */\nexport async function updateTimeClockSettings(\n  timeClockSettings: TimeClockSettings\n): Promise<\n  NonNullablePaths<\n    TimeClockSettings,\n    | `tasks`\n    | `tasks.${number}.label`\n    | `tasks.${number}.paid`\n    | `selfClockInEnabled`,\n    2\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[1] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    timeClockSettings: timeClockSettings,\n  });\n\n  const reqOpts =\n    ambassadorWixStaffTimeClockV1TimeClockSettings.updateTimeClockSettings(\n      payload\n    );\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)\n      ?.timeClockSettings!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { timeClockSettings: '$[0]' },\n        singleArgumentUnchanged: false,\n      },\n      ['timeClockSettings']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformSDKTimestampToRESTTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformSDKFieldMaskToRESTFieldMask } from '@wix/sdk-runtime/transformations/field-mask';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nconst TRANSFORM_PATHS_0 = [\n  { path: 'timeClockSettings.createdDate' },\n  { path: 'timeClockSettings.updatedDate' },\n];\nconst TRANSFORM_PATHS_1 = [{ path: 'fieldMask' }];\n\nfunction resolveWixStaffTimeClockV1TimeClockSettingsServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'manage._base_domain_': [\n      {\n        srcPath: '/_api/time-clock-settings',\n        destPath: '',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_staff-time-clock_time-clock-settings';\n\n/**\n * Retrieves the site's time clock settings.\n *\n * If the settings were never updated, the defaults are returned: an empty task\n * catalog and self clock-in disabled.\n */\nexport function getTimeClockSettings(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __getTimeClockSettings({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.staff.time_clock.v1.time_clock_settings',\n      method: 'GET' as any,\n      methodFqn:\n        'wix.staff.time_clock.v1.TimeClockSettingsService.GetTimeClockSettings',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixStaffTimeClockV1TimeClockSettingsServiceUrl({\n        protoPath: '/v1/time-clock-settings',\n        data: payload,\n        host,\n      }),\n      params: toURLSearchParams(payload),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: TRANSFORM_PATHS_0,\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __getTimeClockSettings;\n}\n\n/**\n * Updates the site's time clock settings.\n *\n * Only the fields in `fieldMask` are updated. Without `fieldMask`, it's inferred\n * from the fields you pass.\n *\n * `tasks` is replaced as a whole. To add, rename, or remove a task, pass the\n * full task catalog. Keep the ID of each existing task, and leave the ID empty\n * for a new task so one is assigned.\n */\nexport function updateTimeClockSettings(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __updateTimeClockSettings({ host }: any) {\n    const serializedData = transformPaths(payload, [\n      {\n        transformFn: transformSDKFieldMaskToRESTFieldMask,\n        paths: TRANSFORM_PATHS_1,\n      },\n      {\n        transformFn: transformSDKTimestampToRESTTimestamp,\n        paths: TRANSFORM_PATHS_0,\n      },\n    ]);\n    const metadata = {\n      entityFqdn: 'wix.staff.time_clock.v1.time_clock_settings',\n      method: 'PATCH' as any,\n      methodFqn:\n        'wix.staff.time_clock.v1.TimeClockSettingsService.UpdateTimeClockSettings',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixStaffTimeClockV1TimeClockSettingsServiceUrl({\n        protoPath: '/v1/time-clock-settings',\n        data: serializedData,\n        host,\n      }),\n      data: serializedData,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: TRANSFORM_PATHS_0,\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __updateTimeClockSettings;\n}\n","import { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport {\n  GetTimeClockSettingsResponse,\n  TimeClockSettings,\n  getTimeClockSettings as universalGetTimeClockSettings,\n  updateTimeClockSettings as universalUpdateTimeClockSettings,\n} from './staff-time-clock-v1-time-clock-settings-time-clock-settings.universal.js';\n\nexport const __metadata = { PACKAGE_NAME: '@wix/staff-time-clock' };\n\nexport function getTimeClockSettings(\n  httpClient: HttpClient\n): GetTimeClockSettingsSignature {\n  return () =>\n    universalGetTimeClockSettings(\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface GetTimeClockSettingsSignature {\n  /**\n   * Retrieves the site's time clock settings.\n   *\n   * If the settings were never updated, the defaults are returned: an empty task\n   * catalog and self clock-in disabled.\n   */\n  (): Promise<\n    NonNullablePaths<\n      GetTimeClockSettingsResponse,\n      | `timeClockSettings.tasks`\n      | `timeClockSettings.tasks.${number}.label`\n      | `timeClockSettings.tasks.${number}.paid`\n      | `timeClockSettings.selfClockInEnabled`,\n      3\n    >\n  >;\n}\n\nexport function updateTimeClockSettings(\n  httpClient: HttpClient\n): UpdateTimeClockSettingsSignature {\n  return (timeClockSettings: TimeClockSettings) =>\n    universalUpdateTimeClockSettings(\n      timeClockSettings,\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface UpdateTimeClockSettingsSignature {\n  /**\n   * Updates the site's time clock settings.\n   *\n   * Only the fields in `fieldMask` are updated. Without `fieldMask`, it's inferred\n   * from the fields you pass.\n   *\n   * `tasks` is replaced as a whole. To add, rename, or remove a task, pass the\n   * full task catalog. Keep the ID of each existing task, and leave the ID empty\n   * for a new task so one is assigned.\n   * @param - Settings to update; may be partial (see `field_mask`).\n   * @returns The settings after the update.\n   */\n  (timeClockSettings: TimeClockSettings): Promise<\n    NonNullablePaths<\n      TimeClockSettings,\n      | `tasks`\n      | `tasks.${number}.label`\n      | `tasks.${number}.paid`\n      | `selfClockInEnabled`,\n      2\n    >\n  >;\n}\n\nexport {\n  AccountInfo,\n  ActionEvent,\n  DomainEvent,\n  DomainEventBodyOneOf,\n  EntityCreatedEvent,\n  EntityDeletedEvent,\n  EntityUpdatedEvent,\n  GetTimeClockSettingsRequest,\n  GetTimeClockSettingsResponse,\n  IdentificationData,\n  IdentificationDataIdOneOf,\n  MessageEnvelope,\n  RestoreInfo,\n  Task,\n  TimeClockSettings,\n  UpdateTimeClockSettingsRequest,\n  UpdateTimeClockSettingsResponse,\n  WebhookIdentityType,\n} from './staff-time-clock-v1-time-clock-settings-time-clock-settings.universal.js';\n","import {\n  getTimeClockSettings as publicGetTimeClockSettings,\n  updateTimeClockSettings as publicUpdateTimeClockSettings,\n} from './staff-time-clock-v1-time-clock-settings-time-clock-settings.public.js';\nimport { createRESTModule } from '@wix/sdk-runtime/rest-modules';\nimport { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';\n\nexport const getTimeClockSettings: MaybeContext<\n  BuildRESTFunction<typeof publicGetTimeClockSettings> &\n    typeof publicGetTimeClockSettings\n> = /*#__PURE__*/ createRESTModule(publicGetTimeClockSettings);\nexport const updateTimeClockSettings: MaybeContext<\n  BuildRESTFunction<typeof publicUpdateTimeClockSettings> &\n    typeof publicUpdateTimeClockSettings\n> = /*#__PURE__*/ createRESTModule(publicUpdateTimeClockSettings);\n\nexport { WebhookIdentityType } from './staff-time-clock-v1-time-clock-settings-time-clock-settings.universal.js';\nexport {\n  TimeClockSettings,\n  Task,\n  GetTimeClockSettingsRequest,\n  GetTimeClockSettingsResponse,\n  UpdateTimeClockSettingsRequest,\n  UpdateTimeClockSettingsResponse,\n  DomainEvent,\n  DomainEventBodyOneOf,\n  EntityCreatedEvent,\n  RestoreInfo,\n  EntityUpdatedEvent,\n  EntityDeletedEvent,\n  ActionEvent,\n  MessageEnvelope,\n  IdentificationData,\n  IdentificationDataIdOneOf,\n  AccountInfo,\n} from './staff-time-clock-v1-time-clock-settings-time-clock-settings.universal.js';\nexport { WebhookIdentityTypeWithLiterals } from './staff-time-clock-v1-time-clock-settings-time-clock-settings.universal.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA,8BAAAA;AAAA,EAAA,+BAAAC;AAAA;AAAA;;;ACAA,6BAAoD;AACpD,oCAGO;;;ACJP,0BAAkC;AAClC,uBAAqD;AACrD,IAAAC,oBAAqD;AACrD,wBAAqD;AACrD,6BAA+B;AAC/B,IAAAC,uBAA2B;AAI3B,IAAM,oBAAoB;AAAA,EACxB,EAAE,MAAM,gCAAgC;AAAA,EACxC,EAAE,MAAM,gCAAgC;AAC1C;AACA,IAAM,oBAAoB,CAAC,EAAE,MAAM,YAAY,CAAC;AAEhD,SAAS,sDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAQd,SAAS,qBACd,SAC4B;AAC5B,WAAS,uBAAuB,EAAE,KAAK,GAAQ;AAC7C,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,QACT;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAYO,SAAS,wBACd,SAC4B;AAC5B,WAAS,0BAA0B,EAAE,KAAK,GAAQ;AAChD,UAAM,qBAAiB,uCAAe,SAAS;AAAA,MAC7C;AAAA,QACE,aAAa;AAAA,QACb,OAAO;AAAA,MACT;AAAA,MACA;AAAA,QACE,aAAa;AAAA,QACb,OAAO;AAAA,MACT;AAAA,IACF,CAAC;AACD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACA,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,QACT;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADoHO,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,uBAAoB;AACpB,EAAAA,qBAAA,YAAS;AACT,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,SAAM;AALI,SAAAA;AAAA,GAAA;AA8CZ,eAAsBC,wBASpB;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC,CAAC,CAAC;AAExD,QAAM,UAC2C;AAAA,IAC7C;AAAA,EACF;AAEF,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAC;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,CAAC;AAAA,QAC3B,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC;AAAA,IACH;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAoBA,eAAsBC,yBACpB,mBAUA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD;AAAA,EACF,CAAC;AAED,QAAM,UAC2C;AAAA,IAC7C;AAAA,EACF;AAEF,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI,GACtD;AAAA,EACN,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAD;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,mBAAmB,OAAO;AAAA,QACtD,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,mBAAmB;AAAA,IACtB;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;;;AEnYO,SAASE,sBACd,YAC+B;AAC/B,SAAO,MACLA;AAAA;AAAA,IAEE,EAAE,WAAW;AAAA,EACf;AACJ;AAqBO,SAASC,yBACd,YACkC;AAClC,SAAO,CAAC,sBACNA;AAAA,IACE;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;;;AC5CA,IAAAC,uBAAiC;AAG1B,IAAMC,wBAGK,2DAAiBA,qBAA0B;AACtD,IAAMC,2BAGK,2DAAiBA,wBAA6B;","names":["getTimeClockSettings","updateTimeClockSettings","import_timestamp","import_rest_modules","payload","WebhookIdentityType","getTimeClockSettings","sdkTransformError","updateTimeClockSettings","getTimeClockSettings","updateTimeClockSettings","import_rest_modules","getTimeClockSettings","updateTimeClockSettings"]}

package/build/cjs/index.typings.d.ts

@@ -0,0 +1,265 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+/**
+ * A site's time clock settings: the tasks staff members can work on during a
+ * shift, and whether they can clock themselves in. Each site has 1 set of time
+ * clock settings.
+ */
+interface TimeClockSettings {
+    /**
+     * Time clock settings ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, incremented on each update.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the settings were created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the settings were last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Task catalog: the tasks staff members can start during a timecard. Empty
+     * by default. Replaced as a whole on update.
+     * @maxSize 100
+     */
+    tasks?: Task[];
+    /**
+     * Whether staff members can clock themselves in and start tasks, for example
+     * from their own phone. When `false`, staff members who are already clocked
+     * in can still clock themselves out. Clocking in on behalf of a staff member,
+     * such as from a kiosk, isn't affected. Default: `false`.
+     */
+    selfClockInEnabled?: boolean;
+}
+/**
+ * A kind of work a staff member can start during a timecard, such as "Front
+ * desk" or "Lunch". Time spent on an unpaid task isn't counted as paid working
+ * time.
+ */
+interface Task {
+    /**
+     * Task ID. Leave empty when adding a task, and one is assigned. Pass the
+     * existing ID when updating a task. Tasks are identified by ID, so 2 tasks
+     * can have the same label.
+     * @format GUID
+     */
+    _id?: string | null;
+    /**
+     * Task name shown to staff members and managers, such as "Lunch" or
+     * "Training".
+     * @maxLength 100
+     */
+    label?: string;
+    /** Whether time spent on this task counts as paid working time. */
+    paid?: boolean;
+}
+interface GetTimeClockSettingsRequest {
+}
+interface GetTimeClockSettingsResponse {
+    /** The current site's time-clock settings. */
+    timeClockSettings?: TimeClockSettings;
+}
+interface UpdateTimeClockSettingsRequest {
+    /** Settings to update; may be partial (see `field_mask`). */
+    timeClockSettings: TimeClockSettings;
+}
+interface UpdateTimeClockSettingsResponse {
+    /** The settings after the update. */
+    timeClockSettings?: TimeClockSettings;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+/**
+ * Retrieves the site's time clock settings.
+ *
+ * If the settings were never updated, the defaults are returned: an empty task
+ * catalog and self clock-in disabled.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId staff:time_clock:v1:time_clock_settings:get_time_clock_settings
+ * @applicableIdentity APP
+ * @fqn wix.staff.time_clock.v1.TimeClockSettingsService.GetTimeClockSettings
+ */
+declare function getTimeClockSettings(): Promise<NonNullablePaths<GetTimeClockSettingsResponse, `timeClockSettings.tasks` | `timeClockSettings.tasks.${number}.label` | `timeClockSettings.tasks.${number}.paid` | `timeClockSettings.selfClockInEnabled`, 3>>;
+/**
+ * Updates the site's time clock settings.
+ *
+ * Only the fields in `fieldMask` are updated. Without `fieldMask`, it's inferred
+ * from the fields you pass.
+ *
+ * `tasks` is replaced as a whole. To add, rename, or remove a task, pass the
+ * full task catalog. Keep the ID of each existing task, and leave the ID empty
+ * for a new task so one is assigned.
+ * @param timeClockSettings - Settings to update; may be partial (see `field_mask`).
+ * @public
+ * @documentationMaturity preview
+ * @requiredField timeClockSettings
+ * @permissionId staff:time_clock:v1:time_clock_settings:update_time_clock_settings
+ * @applicableIdentity APP
+ * @returns The settings after the update.
+ * @fqn wix.staff.time_clock.v1.TimeClockSettingsService.UpdateTimeClockSettings
+ */
+declare function updateTimeClockSettings(timeClockSettings: TimeClockSettings): Promise<NonNullablePaths<TimeClockSettings, `tasks` | `tasks.${number}.label` | `tasks.${number}.paid` | `selfClockInEnabled`, 2>>;
+
+export { type AccountInfo, type ActionEvent, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type GetTimeClockSettingsRequest, type GetTimeClockSettingsResponse, type IdentificationData, type IdentificationDataIdOneOf, type MessageEnvelope, type RestoreInfo, type Task, type TimeClockSettings, type UpdateTimeClockSettingsRequest, type UpdateTimeClockSettingsResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, getTimeClockSettings, updateTimeClockSettings };