{"id":"17705607-1f57-45c8-80bb-850f9a02b2cd","createdDate":"2024-07-23T09:11:56.711Z","updatedDate":"2024-07-23T09:11:56.711Z","resourceId":"09586fc2-a1f8-457b-80b7-182b269848a2","sdk":{"schema":{"name":"velo-deps_wix-loyalty.v2_tiers","fqn":"","slug":"velo-deps-wix-loyalty-v2-tiers","typesMap":{"Tier":{"name":"Tier","fqn":"Tier","slug":"tier","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the tier was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tier ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the tier was last updated."},{"name":"requiredPoints","slug":"required-points","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The amount of points required to be in this tier."},{"name":"revision","slug":"revision","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Revision number, which increments by 1 each time the loyalty tier is updated.\n\nTo prevent conflicting changes, the current `revision` must be passed when updating the loyalty tier."},{"name":"tierDefinition","slug":"tier-definition","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TierDefinition","referenceFqn":"TierDefinition"},"description":"Information about the tier."}]},"TierDefinition":{"name":"TierDefinition","fqn":"TierDefinition","slug":"tier-definition","actions":[],"properties":[{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tier description."},{"name":"icon","slug":"icon","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Details about the tier icon."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tier name."}]},"BulkCreateTiersResponse":{"name":"BulkCreateTiersResponse","fqn":"BulkCreateTiersResponse","slug":"bulk-create-tiers-response","actions":[],"properties":[{"name":"bulkActionMetadata","slug":"bulk-action-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BulkActionMetadata","referenceFqn":"BulkActionMetadata"},"description":"Bulk action metadata."},{"name":"results","slug":"results","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"BulkTierResult","referenceFqn":"BulkTierResult"}},"description":"Created tiers."}]},"BulkActionMetadata":{"name":"BulkActionMetadata","fqn":"BulkActionMetadata","slug":"bulk-action-metadata","actions":[],"properties":[{"name":"totalFailures","slug":"total-failures","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items that couldn't be processed."},{"name":"totalSuccesses","slug":"total-successes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items that were successfully processed."},{"name":"undetailedFailures","slug":"undetailed-failures","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of failures without details because detailed failure threshold was exceeded."}]},"BulkTierResult":{"name":"BulkTierResult","fqn":"BulkTierResult","slug":"bulk-tier-result","actions":[],"properties":[{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Tier","referenceFqn":"Tier"},"description":"Individual tier information."},{"name":"itemMetadata","slug":"item-metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemMetadata","referenceFqn":"ItemMetadata"},"description":"Individual tier metadata."}]},"ItemMetadata":{"name":"ItemMetadata","fqn":"ItemMetadata","slug":"item-metadata","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item)."},{"name":"error","slug":"error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ApplicationError","referenceFqn":"ApplicationError"},"description":"Details about the error in case of failure."},{"name":"originalIndex","slug":"original-index","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Index of the item within the request array. Allows for correlation between request and response items."},{"name":"success","slug":"success","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated."}]},"ApplicationError":{"name":"ApplicationError","fqn":"ApplicationError","slug":"application-error","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Error code."},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Data related to the error."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description of the error."}]},"TiersProgramSettings":{"name":"TiersProgramSettings","fqn":"TiersProgramSettings","slug":"tiers-program-settings","actions":[],"oneofProperties":{"period":[{"name":"rollingWindow","slug":"rolling-window","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RollingWindow","referenceFqn":"RollingWindow"},"description":"*Required.**\nPeriod of time used to calculate loyalty points for tier assignment.\n\nThe loyalty points accumulated during this period determine if the account meets a tier's required point threshold."}]},"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the loyalty tiers program was created."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the loyalty tiers program was last updated."},{"name":"baseTierDefinition","slug":"base-tier-definition","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TierDefinition","referenceFqn":"TierDefinition"},"description":"Information about the base loyalty tier.\n\nThe base tier is the default tier for any account that is unassigned for not meeting\nthe required points threshold of any other tier."},{"name":"revision","slug":"revision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Revision number, which increments by 1 each time the loyalty tiers settings are updated.\n\nTo prevent conflicting changes, the current `revision` must be passed when updating the loyalty tiers settings."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Status","referenceFqn":"Status"},"description":"Tiers program status."}]},"RollingWindow":{"name":"RollingWindow","fqn":"RollingWindow","slug":"rolling-window","actions":[],"properties":[{"name":"durationInMonths","slug":"duration-in-months","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of months to use for the rolling window period.\n\nMin: `12`\n\nMax: `36`"}]},"Status":{"name":"Status","fqn":"Status","slug":"status","actions":[],"enumValues":["ACTIVE","DISABLED","DRAFT","PAUSED","UNKNOWN"],"properties":[]},"CreateTiersProgramSettingsResponse":{"name":"CreateTiersProgramSettingsResponse","fqn":"CreateTiersProgramSettingsResponse","slug":"create-tiers-program-settings-response","actions":[],"properties":[{"name":"programSettings","slug":"program-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TiersProgramSettings","referenceFqn":"TiersProgramSettings"},"description":"Created tiers program settings."}]},"GetTiersProgramResponse":{"name":"GetTiersProgramResponse","fqn":"GetTiersProgramResponse","slug":"get-tiers-program-response","actions":[],"properties":[{"name":"programSettings","slug":"program-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TiersProgramSettings","referenceFqn":"TiersProgramSettings"},"description":"Tiers program settings."},{"name":"tiers","slug":"tiers","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Tier","referenceFqn":"Tier"}},"description":"Tiers."}]},"GetTiersProgramSettingsResponse":{"name":"GetTiersProgramSettingsResponse","fqn":"GetTiersProgramSettingsResponse","slug":"get-tiers-program-settings-response","actions":[],"properties":[{"name":"programSettings","slug":"program-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TiersProgramSettings","referenceFqn":"TiersProgramSettings"},"description":"Tiers program settings."}]},"ListTiersResponse":{"name":"ListTiersResponse","fqn":"ListTiersResponse","slug":"list-tiers-response","actions":[],"properties":[{"name":"tiers","slug":"tiers","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Tier","referenceFqn":"Tier"}},"description":"Retrieved loyalty tiers."}]},"UpdateTier":{"name":"UpdateTier","fqn":"UpdateTier","slug":"update-tier","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the tier was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tier ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the tier was last updated."},{"name":"requiredPoints","slug":"required-points","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The amount of points required to be in this tier."},{"name":"revision","slug":"revision","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Revision number, which increments by 1 each time the loyalty tier is updated.\n\nTo prevent conflicting changes, the current `revision` must be passed when updating the loyalty tier."},{"name":"tierDefinition","slug":"tier-definition","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TierDefinition","referenceFqn":"TierDefinition"},"description":"Information about the tier."}]},"UpdateTiersProgramSettingsResponse":{"name":"UpdateTiersProgramSettingsResponse","fqn":"UpdateTiersProgramSettingsResponse","slug":"update-tiers-program-settings-response","actions":[],"properties":[{"name":"programSettings","slug":"program-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TiersProgramSettings","referenceFqn":"TiersProgramSettings"},"description":"Updated program settings."}]}},"standaloneTypes":[],"actions":[{"name":"bulkCreateTiers","fqn":"bulkCreateTiers","slug":"bulk-create-tiers","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["tiers"],"permissions":["Manage Loyalty"],"permissionsScopesIds":["SCOPE.DC-LOYALTY.MANAGE-LOYALTY"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"BulkCreateTiersResponse","referenceFqn":"BulkCreateTiersResponse"}},"examples":[{"title":"Bulk create tiers (export from backend code) ","description":"","content":"import { tiers } from \"wix-loyalty.v2\";\nimport { webMethod, Permissions } from \"wix-web-module\";\nimport { elevate } from \"wix-auth\";\n\n/* Sample tiers object:\n *\n * {\n * \"tiers\": [\n * {\n * \"required_points\": 50,\n * \"tierDefinition\": {\n * \"name\": \"Elite Member Tier\",\n * \"description\": \"Exclusive tier for elite members\"\n * }\n * }\n * ]\n * }\n */\n\nconst elevatedBulkCreateTiers = elevate(tiers.bulkCreateTiers);\n\nexport const bulkCreateTiers = webMethod(\n Permissions.Anyone, \n async (tiers) => {\n try {\n const result = await elevatedBulkCreateTiers(tiers);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n *\n * {\n * \"bulkActionMetadata\": {\n * \"totalFailures\": 0,\n * \"totalSuccesses\": 1,\n * \"undetailedFailures\": 0\n * },\n * \"results\": [\n * {\n * \"item\": {\n * \"tierDefinition\": {\n * \"name\": \"Elite Member Tier\",\n * \"description\": \"Exclusive tier for elite members\"\n * },\n * \"_createdDate\": \"2024-06-10T07:09:04.213Z\",\n * \"_id\": \"dd43f55d-6d6f-45eb-b76e-13a161a436a1\",\n * \"_updatedDate\": \"2024-06-10T07:09:04.213Z\",\n * \"requiredPoints\": 50,\n * \"revision\": \"1\"\n * },\n * \"itemMetadata\": {\n * \"_id\": \"dd43f55d-6d6f-45eb-b76e-13a161a436a1\",\n * \"originalIndex\": 0,\n * \"success\": true\n * }\n * }\n * ]\n * }\n */"},{"title":"Bulk create tiers (dashboard page code) @description:","content":"import { tiers } from \"wix-loyalty.v2\";\n\n/* Sample tiers object:\n *\n * {\n * \"tiers\": [\n * {\n * \"required_points\": 50,\n * \"tierDefinition\": {\n * \"name\": \"Elite Member Tier\",\n * \"description\": \"Exclusive tier for elite members\"\n * }\n * }\n * ]\n * }\n */\n\nasync function bulkCreateTiers(tiers) {\n try {\n const result = await tiers.bulkCreateTiers(tiers);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n *\n * {\n * \"bulkActionMetadata\": {\n * \"totalFailures\": 0,\n * \"totalSuccesses\": 1,\n * \"undetailedFailures\": 0\n * },\n * \"results\": [\n * {\n * \"item\": {\n * \"tierDefinition\": {\n * \"name\": \"Elite Member Tier\",\n * \"description\": \"Exclusive tier for elite members\"\n * },\n * \"_createdDate\": \"2024-06-10T07:09:04.213Z\",\n * \"_id\": \"dd43f55d-6d6f-45eb-b76e-13a161a436a1\",\n * \"_updatedDate\": \"2024-06-10T07:09:04.213Z\",\n * \"requiredPoints\": 50,\n * \"revision\": \"1\"\n * },\n * \"itemMetadata\": {\n * \"_id\": \"dd43f55d-6d6f-45eb-b76e-13a161a436a1\",\n * \"originalIndex\": 0,\n * \"success\": true\n * }\n * }\n * ]\n * }\n */"}],"actionParams":[{"name":"tiers","slug":"tiers","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Tier","referenceFqn":"Tier"}},"description":"Tiers to create."}],"description":"Creates up to 20 tiers.\n\nThe name for a tier and the amount of required points to qualify for a tier can only exist for a single tier.\nAttempts to create a tier with a `tierDefinition.name` or `requiredPoints` that already exists will return an error.\n\nTo create a single tier, use [`createTier()`](#createtier).\n\n>**Note:** You must have a [Business VIP Premium plan](https://support.wix.com/en/article/business-vip-premium-plan-overview) or a [Scale Premium plan](https://support.wix.com/en/article/editor-x-scale-premium-plan-overview) to add tiers."},{"name":"createTier","fqn":"createTier","slug":"create-tier","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["tier"],"permissions":["Manage Loyalty"],"permissionsScopesIds":["SCOPE.DC-LOYALTY.MANAGE-LOYALTY"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Tier","referenceFqn":"Tier"},"description":"Created loyalty tier."},"examples":[{"title":"Create a new tier (export from backend code) ","description":"","content":"import { tiers } from \"wix-loyalty.v2\";\nimport { webMethod, Permissions } from \"wix-web-module\";\nimport { elevate } from \"wix-auth\";\n\n/* Sample tier value:\n * {\n * \"tier\": {\n * \"required_points\": 1000,\n * \"tierDefinition\": {\n * \"name\": \"Jadeite Tier\",\n * \"description\": \"Jadeite Tier Benefits\",\n * \"icon\": {\n * \"url\": \"shapes/cca51dde12d348379113f2201cbe4e6c.svg\"\n * }\n * }\n * }\n * }\n */\n\nconst elevatedCreateTier = elevate(tiers.createTier);\n\nexport const createTier = webMethod(\n Permissions.Anyone, \n async (tier) => {\n try {\n const result = await elevatedCreateTier(tier);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n * {\n * \"tier\": {\n * \"_createdDate\": \"2024-06-11T12:38:35.490Z\",\n * \"_id\": \"8edeea05-2c90-43fa-bd15-b2352620fd51\",\n * \"_updatedDate\": \"2024-06-11T12:38:35.490Z\",\n * \"requiredPoints\": 1000,\n * \"revision\": \"1\",\n * \"tierDefinition\": {\n * \"description\": \"Jadeite Tier Benefits\",\n * \"icon\": {\n * \"id\": \"\",\n * \"url\": \"shapes/cca51dde12d348379113f2201cbe4e6c.svg\",\n * \"height\": 0,\n * \"width\": 0,\n * \"altText\": null,\n * \"urlExpirationDate\": null,\n * \"filename\": null,\n * \"sizeInBytes\": null\n * },\n * \"name\": \"Jadeite Tier\"\n * }\n * }\n * }\n */"},{"title":"Create tier (dashboard page code) ","description":"","content":"import { tiers } from \"wix-loyalty.v2\";\n\n/* Sample tier value:\n * {\n * \"tier\": {\n * \"required_points\": 1000,\n * \"tierDefinition\": {\n * \"name\": \"Jadeite Tier\",\n * \"description\": \"Jadeite Tier Benefits\",\n * \"icon\": {\n * \"url\": \"shapes/cca51dde12d348379113f2201cbe4e6c.svg\"\n * }\n * }\n * }\n * }\n */\n\nasync function createTier(tier) {\n try {\n const result = await tiers.createTier(tier);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * {\n * \"tier\": {\n * \"_createdDate\": \"2024-06-11T12:38:35.490Z\",\n * \"_id\": \"8edeea05-2c90-43fa-bd15-b2352620fd51\",\n * \"_updatedDate\": \"2024-06-11T12:38:35.490Z\",\n * \"requiredPoints\": 1000,\n * \"revision\": \"1\",\n * \"tierDefinition\": {\n * \"description\": \"Jadeite Tier Benefits\",\n * \"icon\": {\n * \"id\": \"\",\n * \"url\": \"shapes/cca51dde12d348379113f2201cbe4e6c.svg\",\n * \"height\": 0,\n * \"width\": 0,\n * \"altText\": null,\n * \"urlExpirationDate\": null,\n * \"filename\": null,\n * \"sizeInBytes\": null\n * },\n * \"name\": \"Jadeite Tier\"\n * }\n * }\n * }\n */"}],"actionParams":[{"name":"tier","slug":"tier","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Tier","referenceFqn":"Tier"},"description":"Tier to create."}],"description":"Creates a tier.\n\nThe name for a tier and the amount of required points to qualify for a tier can only exist for a single tier.\nAttempts to create a tier with a `tierDefinition.name` or `requiredPoints` that already exists will return an error.\n\nTo create up to 20 tiers at once, use [`bulkCreateTiers()`](#bulkcreatetiers).\n\n>**Note:** You must have a [Business VIP Premium plan](https://support.wix.com/en/article/business-vip-premium-plan-overview) or a [Scale Premium plan](https://support.wix.com/en/article/editor-x-scale-premium-plan-overview) to add tiers."},{"name":"createTiersProgramSettings","fqn":"createTiersProgramSettings","slug":"create-tiers-program-settings","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["programSettings"],"permissions":["Manage Loyalty"],"permissionsScopesIds":["SCOPE.DC-LOYALTY.MANAGE-LOYALTY"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CreateTiersProgramSettingsResponse","referenceFqn":"CreateTiersProgramSettingsResponse"}},"examples":[{"title":"createTiersProgramSettings example for dashboard page code","content":"import { tiers } from 'wix-loyalty.v2';\n\nasync function createTiersProgramSettings(programSettings) {\n try {\n const result = await tiers.createTiersProgramSettings(programSettings);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"createTiersProgramSettings example for exporting from backend code","content":"import { tiers } from 'wix-loyalty.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedCreateTiersProgramSettings = elevate(tiers.createTiersProgramSettings);\n\nexport const createTiersProgramSettings = webMethod(\n Permissions.Anyone,\n async (programSettings) => {\n try {\n const result = await elevatedCreateTiersProgramSettings(programSettings);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"programSettings","slug":"program-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TiersProgramSettings","referenceFqn":"TiersProgramSettings"},"description":"Tiers program settings."}],"description":"Create tiers program settings.\n\nTiers program settings apply globally to all tiers in the program."},{"name":"deleteTier","fqn":"deleteTier","slug":"delete-tier","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["revision","tierId"],"permissions":["Manage Loyalty"],"permissionsScopesIds":["SCOPE.DC-LOYALTY.MANAGE-LOYALTY"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"Delete a tier (export from backend code) ","description":"","content":"import { tiers } from \"wix-loyalty.v2\";\nimport { webMethod, Permissions } from \"wix-web-module\";\nimport { elevate } from \"wix-auth\";\n\n/* Sample parameter values:\n * \n * {\n * \"tierId\": \"0a429348-48c3-4085-a889-6858f33ce78a\",\n * \"revision\": \"2\"\n * }\n */\n\nconst elevatedDeleteTier = elevate(tiers.deleteTier);\n\nexport const deleteTier = webMethod(\n Permissions.Anyone,\n async (tierId, revision) => {\n try {\n const result = await elevatedDeleteTier(tierId, revision);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n },\n);"},{"title":"Delete tier (dashboard page code) ","description":"","content":"import { tiers } from \"wix-loyalty.v2\";\n\n/* Sample parameter values:\n * \n * {\n * \"tierId\": \"0a429348-48c3-4085-a889-6858f33ce78a\",\n * \"revision\": \"2\"\n * }\n */\n\nasync function deleteTier(tierId, revision) {\n try {\n const result = await tiers.deleteTier(tierId, revision);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"}],"actionParams":[{"name":"tierId","slug":"tier-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the tier to delete."},{"name":"revision","slug":"revision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Current `revision` of the tier to delete."}],"description":"Deletes a loyalty tier."},{"name":"getTier","fqn":"getTier","slug":"get-tier","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["tierId"],"permissions":["Read Loyalty","Manage Loyalty"],"permissionsScopesIds":["SCOPE.DC-LOYALTY.READ-LOYALTY","SCOPE.DC-LOYALTY.MANAGE-LOYALTY"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Tier","referenceFqn":"Tier"},"description":"Retrieved loyalty tier."},"examples":[{"title":"Get tier (export from backend code) @description:","content":"import { tiers } from \"wix-loyalty.v2\";\nimport { webMethod, Permissions } from \"wix-web-module\";\n\n/* Sample tierId value:\n *\n * {\n * \"tierId\": \"f882b4b5-44c4-42b4-a380-9662b55bbe71\"\n * }\n */ \n\nexport const getTier = webMethod(\n Permissions.Anyone, \n async (tierId) => {\n try {\n const result = await tiers.getTier(tierId);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to:\n *\n * {\n * \"_createdDate\": \"2024-06-10T07:07:35.686Z\",\n * \"_id\": \"f882b4b5-44c4-42b4-a380-9662b55bbe71\",\n * \"_updatedDate\": \"2024-06-10T07:07:35.686Z\",\n * \"requiredPoints\": 40,\n * \"revision\": \"1\",\n * \"tierDefinition\": {\n * \"name\": \"Super API Tier\",\n * \"description\": \"Tiers created from API\"\n * }\n * }\n */ "},{"title":"Get tier (dashboard page code) ","description":"","content":"import { tiers } from \"wix-loyalty.v2\";\n\n/* Sample tierId value:\n *\n * {\n * \"tierId\": \"f882b4b5-44c4-42b4-a380-9662b55bbe71\"\n * }\n */ \n\nasync function getTier(tierId) {\n try {\n const result = await tiers.getTier(tierId);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n *\n * {\n * \"_createdDate\": \"2024-06-10T07:07:35.686Z\",\n * \"_id\": \"f882b4b5-44c4-42b4-a380-9662b55bbe71\",\n * \"_updatedDate\": \"2024-06-10T07:07:35.686Z\",\n * \"requiredPoints\": 40,\n * \"revision\": \"1\",\n * \"tierDefinition\": {\n * \"name\": \"Super API Tier\",\n * \"description\": \"Tiers created from API\"\n * }\n * }\n */\n"}],"actionParams":[{"name":"tierId","slug":"tier-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the tier to retrieve."}],"description":"Retrieves a loyalty tier.\n\nTo retrieve a list of all of a site's tiers, use [`listTiers()`](#listtiers)."},{"name":"getTiersProgram","fqn":"getTiersProgram","slug":"get-tiers-program","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","permissions":["Read Loyalty","Manage Loyalty"],"permissionsScopesIds":["SCOPE.DC-LOYALTY.READ-LOYALTY","SCOPE.DC-LOYALTY.MANAGE-LOYALTY"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"GetTiersProgramResponse","referenceFqn":"GetTiersProgramResponse"}},"examples":[{"title":"Get `Tiers` and `ProgramSettings` (export from backend code) ","description":"","content":"import { tiers } from \"wix-loyalty.v2\";\nimport { webMethod, Permissions } from \"wix-web-module\";\n\nexport const getTiersProgram = webMethod(\n Permissions.Anyone,\n async () => {\n try {\n const result = await tiers.getTiersProgram();\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n },\n);\n\n/* Promise resolves to:\n *\n * {\n * \"programSettings\": {\n * \"_createdDate\": \"2024-06-05T20:27:19.147Z\",\n * \"_updatedDate\": \"2024-06-06T10:30:05.261Z\",\n * \"baseTierDefinition\": {\n * \"icon\": \"shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg\",\n * \"name\": \"Basic\",\n * \"description\": \"\"\n * },\n * \"revision\": \"2\",\n * \"status\": \"ACTIVE\",\n * \"rollingWindow\": {\n * \"durationInMonths\": 12\n * }\n * },\n * \"tiers\": [\n * {\n * \"_createdDate\": \"2024-06-06T10:33:19.121Z\",\n * \"_id\": \"7e26e41b-3bb6-40c9-bb7e-855b9f4f69e2\",\n * \"_updatedDate\": \"2024-06-11T12:17:05.000Z\",\n * \"requiredPoints\": 100,\n * \"revision\": \"6\",\n * \"tierDefinition\": {\n * \"icon\": \"shapes/11062b_667183149f4c40809fd860a1d7109296.svg\",\n * \"name\": \"Silver Tier\",\n * \"description\": \"Silver Tier Benefits\"\n * }\n * },\n * {\n * \"_createdDate\": \"2024-06-06T10:33:56.430Z\",\n * \"_id\": \"b8501f07-a34f-4608-b9b0-168e6c6c505a\",\n * \"_updatedDate\": \"2024-06-11T12:17:12.382Z\",\n * \"requiredPoints\": 200,\n * \"revision\": \"4\",\n * \"tierDefinition\": {\n * \"icon\": \"shapes/c0bec42304a6414990bfd882f637ac0a.svg\",\n * \"name\": \"Gold\",\n * \"description\": \"Gold Tier Benefits\"\n * }\n * },\n * {\n * \"_createdDate\": \"2024-06-11T12:14:14.809Z\",\n * \"_id\": \"a9fc3669-1cf4-4dff-8f4c-d6a22c62eadb\",\n * \"_updatedDate\": \"2024-06-11T12:17:24.724Z\",\n * \"requiredPoints\": 500,\n * \"revision\": \"2\",\n * \"tierDefinition\": {\n * \"icon\": \"shapes/43e4c49bed6b47e8a85bc1dd5fbcfd71.svg\",\n * \"name\": \"Diamond\",\n * \"description\": \"Diamond Tier Benefits\"\n * }\n * },\n * {\n * \"_createdDate\": \"2024-06-11T12:38:35.490Z\",\n * \"_id\": \"8edeea05-2c90-43fa-bd15-b2352620fd51\",\n * \"_updatedDate\": \"2024-06-11T12:38:35.490Z\",\n * \"requiredPoints\": 1000,\n * \"revision\": \"1\",\n * \"tierDefinition\": {\n * \"icon\": \"shapes/cca51dde12d348379113f2201cbe4e6c.svg\",\n * \"name\": \"Jadeite Tier\",\n * \"description\": \"Jadeite Tier Benefits\"\n * }\n * }\n * ]\n * }\n */ "},{"title":"Get tiers program (dashboard page code) ","description":"","content":"import { tiers } from \"wix-loyalty.v2\";\n\nasync function getTiersProgram() {\n try {\n const result = await tiers.getTiersProgram();\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n *\n * {\n * \"programSettings\": {\n * \"_createdDate\": \"2024-06-05T20:27:19.147Z\",\n * \"_updatedDate\": \"2024-06-06T10:30:05.261Z\",\n * \"baseTierDefinition\": {\n * \"icon\": \"shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg\",\n * \"name\": \"Basic\",\n * \"description\": \"\"\n * },\n * \"revision\": \"2\",\n * \"status\": \"ACTIVE\",\n * \"rollingWindow\": {\n * \"durationInMonths\": 12\n * }\n * },\n * \"tiers\": [\n * {\n * \"_createdDate\": \"2024-06-06T10:33:19.121Z\",\n * \"_id\": \"7e26e41b-3bb6-40c9-bb7e-855b9f4f69e2\",\n * \"_updatedDate\": \"2024-06-11T12:17:05.000Z\",\n * \"requiredPoints\": 100,\n * \"revision\": \"6\",\n * \"tierDefinition\": {\n * \"icon\": \"shapes/11062b_667183149f4c40809fd860a1d7109296.svg\",\n * \"name\": \"Silver Tier\",\n * \"description\": \"Silver Tier Benefits\"\n * }\n * },\n * {\n * \"_createdDate\": \"2024-06-06T10:33:56.430Z\",\n * \"_id\": \"b8501f07-a34f-4608-b9b0-168e6c6c505a\",\n * \"_updatedDate\": \"2024-06-11T12:17:12.382Z\",\n * \"requiredPoints\": 200,\n * \"revision\": \"4\",\n * \"tierDefinition\": {\n * \"icon\": \"shapes/c0bec42304a6414990bfd882f637ac0a.svg\",\n * \"name\": \"Gold\",\n * \"description\": \"Gold Tier Benefits\"\n * }\n * },\n * {\n * \"_createdDate\": \"2024-06-11T12:14:14.809Z\",\n * \"_id\": \"a9fc3669-1cf4-4dff-8f4c-d6a22c62eadb\",\n * \"_updatedDate\": \"2024-06-11T12:17:24.724Z\",\n * \"requiredPoints\": 500,\n * \"revision\": \"2\",\n * \"tierDefinition\": {\n * \"icon\": \"shapes/43e4c49bed6b47e8a85bc1dd5fbcfd71.svg\",\n * \"name\": \"Diamond\",\n * \"description\": \"Diamond Tier Benefits\"\n * }\n * },\n * {\n * \"_createdDate\": \"2024-06-11T12:38:35.490Z\",\n * \"_id\": \"8edeea05-2c90-43fa-bd15-b2352620fd51\",\n * \"_updatedDate\": \"2024-06-11T12:38:35.490Z\",\n * \"requiredPoints\": 1000,\n * \"revision\": \"1\",\n * \"tierDefinition\": {\n * \"icon\": \"shapes/cca51dde12d348379113f2201cbe4e6c.svg\",\n * \"name\": \"Jadeite Tier\",\n * \"description\": \"Jadeite Tier Benefits\"\n * }\n * }\n * ]\n * }\n */"}],"description":"Returns `Tiers` and `ProgramSettings` in a single response.\n\nIf `TiersProgramSettings` doesn't exist, default `TiersProgramSettings` are created."},{"name":"getTiersProgramSettings","fqn":"getTiersProgramSettings","slug":"get-tiers-program-settings","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","permissions":["Read Loyalty","Manage Loyalty"],"permissionsScopesIds":["SCOPE.DC-LOYALTY.READ-LOYALTY","SCOPE.DC-LOYALTY.MANAGE-LOYALTY"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"GetTiersProgramSettingsResponse","referenceFqn":"GetTiersProgramSettingsResponse"}},"examples":[{"title":"Get tiers program settings","description":"","content":"import { tier } from 'wix-loyalty-backend';\n\nexport async function myGetProgramSettingsFunction() {\n try {\n const tiersProgramSettings = await tier.getTiersProgramSettings();\n\n const status = tiersProgramSettings.programSettings.status;\n const revision = tiersProgramSettings.programSettings.revision;\n\n console.log('Success! Current status of tiers program: ', status);\n return tiersProgramSettings;\n } catch (error) {\n console.error(error);\n }\n}\n\n/* Promise resolves to:\n *\n * {\n * \"programSettings\": {\n * \"_createdDate\": \"2024-06-05T20:27:19.147Z\",\n * \"_updatedDate\": \"2024-06-06T10:30:05.261Z\",\n * \"baseTierDefinition\": {\n * \"icon\": \"shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg\",\n * \"name\": \"Basic\",\n * \"description\": \"\"\n * },\n * \"revision\": \"2\",\n * \"status\": \"ACTIVE\",\n * \"rollingWindow\": {\n * \"durationInMonths\": 12\n * }\n * }\n * }\n */ "},{"title":"Get tiers program settings (export from backend code)","description":"","content":"import { Permissions, webMethod } from \"wix-web-module\";\nimport { tiers } from \"wix-loyalty.v2\";\n\nexport const myGetProgramSettingsFunction = webMethod(\n Permissions.Anyone,\n async () => {\n try {\n const tiersProgramSettings = await tiers.getTiersProgramSettings();\n const status = tiersProgramSettings.programSettings.status;\n const revision = tiersProgramSettings.programSettings.revision;\n\n console.log(\"Success! Current status of tiers program: \", status);\n return tiersProgramSettings;\n } catch (error) {\n console.error(error);\n }\n },\n);\n\n/* Promise resolves to:\n *\n * {\n * \"programSettings\": {\n * \"_createdDate\": \"2024-06-05T20:27:19.147Z\",\n * \"_updatedDate\": \"2024-06-06T10:30:05.261Z\",\n * \"baseTierDefinition\": {\n * \"icon\": \"shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg\",\n * \"name\": \"Basic\",\n * \"description\": \"\"\n * },\n * \"revision\": \"2\",\n * \"status\": \"ACTIVE\",\n * \"rollingWindow\": {\n * \"durationInMonths\": 12\n * }\n * }\n * }\n */ "},{"title":"Get tiers program settings (dashboard page code) @description:","content":"import { tier } from \"wix-loyalty-backend\";\n\nexport async function myGetProgramSettingsFunction() {\n try {\n const tiersProgramSettings = await tier.getTiersProgramSettings();\n\n const status = tiersProgramSettings.programSettings.status;\n const revision = tiersProgramSettings.programSettings.revision;\n\n console.log(\"Success! Current status of tiers program: \", status);\n return tiersProgramSettings;\n } catch (error) {\n console.error(error);\n }\n}\n\n/* Promise resolves to:\n *\n * {\n * \"programSettings\": {\n * \"_createdDate\": \"2024-06-05T20:27:19.147Z\",\n * \"_updatedDate\": \"2024-06-06T10:30:05.261Z\",\n * \"baseTierDefinition\": {\n * \"icon\": \"shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg\",\n * \"name\": \"Basic\",\n * \"description\": \"\"\n * },\n * \"revision\": \"2\",\n * \"status\": \"ACTIVE\",\n * \"rollingWindow\": {\n * \"durationInMonths\": 12\n * }\n * }\n * }\n */"}],"description":"Retrieves the settings for the tiers program.\n\nTiers program settings apply globally to all tiers in the program."},{"name":"listTiers","fqn":"listTiers","slug":"list-tiers","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","permissions":["Read Loyalty","Manage Loyalty"],"permissionsScopesIds":["SCOPE.DC-LOYALTY.READ-LOYALTY","SCOPE.DC-LOYALTY.MANAGE-LOYALTY"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ListTiersResponse","referenceFqn":"ListTiersResponse"}},"examples":[{"title":"Get a list of loyalty tiers","description":"","content":"import { tier } from 'wix-loyalty-backend';\n\nexport async function myListTiersFunction() {\n try {\n const tiersList = await tier.listTiers();\n\n const firstTierId = tiersList.tiers[0]._id;\n const firstTierPointsRequired = tiersList.tiers[0].requiredPoints;\n\n console.log('Success! First tier ID: ', firstTierId, ' requires ', firstTierPointsRequired, ' points.');\n return tiersList;\n } catch (error) {\n console.error(error);\n }\n}\n\n/* Promise resolves to:\n *\n * {\n * \"tiers\": [\n * {\n * \"tierDefinition\": {\n * \"icon\": \"shapes/11062b_667183149f4c40809fd860a1d7109296.svg\",\n * \"name\": \"Silver Tier\",\n * \"description\": \"Silver Tier Benefits\"\n * },\n * \"_createdDate\": \"2024-06-06T10:33:19.121Z\",\n * \"_id\": \"7e26e41b-3bb6-40c9-bb7e-855b9f4f69e2\",\n * \"_updatedDate\": \"2024-06-11T12:17:05.000Z\",\n * \"requiredPoints\": 100,\n * \"revision\": \"6\"\n * },\n * {\n * \"tierDefinition\": {\n * \"icon\": \"shapes/c0bec42304a6414990bfd882f637ac0a.svg\",\n * \"name\": \"Gold\",\n * \"description\": \"Gold Tier Benefits\"\n * },\n * \"_createdDate\": \"2024-06-06T10:33:56.430Z\",\n * \"_id\": \"b8501f07-a34f-4608-b9b0-168e6c6c505a\",\n * \"_updatedDate\": \"2024-06-11T12:17:12.382Z\",\n * \"requiredPoints\": 200,\n * \"revision\": \"4\"\n * },\n * {\n * \"tierDefinition\": {\n * \"icon\": \"shapes/43e4c49bed6b47e8a85bc1dd5fbcfd71.svg\",\n * \"name\": \"Diamond\",\n * \"description\": \"Diamond Tier Benefits\"\n * },\n * \"_createdDate\": \"2024-06-11T12:14:14.809Z\",\n * \"_id\": \"a9fc3669-1cf4-4dff-8f4c-d6a22c62eadb\",\n * \"_updatedDate\": \"2024-06-11T12:17:24.724Z\",\n * \"requiredPoints\": 500,\n * \"revision\": \"2\"\n * }\n * ]\n */ "},{"title":"Get a list of loyalty tiers (export from backend code)","description":"","content":"import { Permissions, webMethod } from \"wix-web-module\";\nimport { tiers } from \"wix-loyalty.v2\";\n\nexport const myListTiersFunction = webMethod(\n Permissions.Anyone, \n async () => {\n try {\n const tiersList = await tiers.listTiers();\n\n const firstTierId = tiersList.tiers[0]._id;\n const firstTierPointsRequired = tiersList.tiers[0].requiredPoints;\n\n console.log(\n \"Success! First tier ID: \",\n firstTierId,\n \" requires \",\n firstTierPointsRequired,\n \" points.\",\n );\n return tiersList;\n } catch (error) {\n console.error(error);\n }\n});\n\n/* Promise resolves to:\n *\n * {\n * \"tiers\": [\n * {\n * \"tierDefinition\": {\n * \"icon\": \"shapes/11062b_667183149f4c40809fd860a1d7109296.svg\",\n * \"name\": \"Silver Tier\",\n * \"description\": \"Silver Tier Benefits\"\n * },\n * \"_createdDate\": \"2024-06-06T10:33:19.121Z\",\n * \"_id\": \"7e26e41b-3bb6-40c9-bb7e-855b9f4f69e2\",\n * \"_updatedDate\": \"2024-06-11T12:17:05.000Z\",\n * \"requiredPoints\": 100,\n * \"revision\": \"6\"\n * },\n * {\n * \"tierDefinition\": {\n * \"icon\": \"shapes/c0bec42304a6414990bfd882f637ac0a.svg\",\n * \"name\": \"Gold\",\n * \"description\": \"Gold Tier Benefits\"\n * },\n * \"_createdDate\": \"2024-06-06T10:33:56.430Z\",\n * \"_id\": \"b8501f07-a34f-4608-b9b0-168e6c6c505a\",\n * \"_updatedDate\": \"2024-06-11T12:17:12.382Z\",\n * \"requiredPoints\": 200,\n * \"revision\": \"4\"\n * },\n * {\n * \"tierDefinition\": {\n * \"icon\": \"shapes/43e4c49bed6b47e8a85bc1dd5fbcfd71.svg\",\n * \"name\": \"Diamond\",\n * \"description\": \"Diamond Tier Benefits\"\n * },\n * \"_createdDate\": \"2024-06-11T12:14:14.809Z\",\n * \"_id\": \"a9fc3669-1cf4-4dff-8f4c-d6a22c62eadb\",\n * \"_updatedDate\": \"2024-06-11T12:17:24.724Z\",\n * \"requiredPoints\": 500,\n * \"revision\": \"2\"\n * }\n * ]\n */ "}],"description":"Retrieves a list of a site's tiers.\n\nTo retrieve a specific tier, use [`getTier()`](#gettier)."},{"name":"updateTier","fqn":"updateTier","slug":"update-tier","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["_id","tier","tier.revision"],"permissions":["Manage Loyalty"],"permissionsScopesIds":["SCOPE.DC-LOYALTY.MANAGE-LOYALTY"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Tier","referenceFqn":"Tier"},"description":"Updated loyalty tier."},"examples":[{"title":"Update tier (export from backend code) @description:","content":"import { tiers } from \"wix-loyalty.v2\";\nimport { webMethod, Permissions } from \"wix-web-module\";\nimport { elevate } from \"wix-auth\";\n\n /* Sample parameter values:\n *\n * {\n * \"tier\": {\n * \"_id\": \"7e26e41b-3bb6-40c9-bb7e-855b9f4f69e2\",\n * \"required_points\": 80,\n * \"tierDefinition\": {\n * \"name\": \"Updated Tier\",\n * \"description\": \"Updated tier name\"\n * }\n * }\n * }\n */ \n\nconst elevatedUpdateTier = elevate(tiers.updateTier);\n\nexport const updateTier = webMethod(\n Permissions.Anyone, \n async (_id, tier) => {\n try {\n const result = await elevatedUpdateTier(_id, tier);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2024-06-06T10:33:19.121Z\",\n * \"_id\": \"7e26e41b-3bb6-40c9-bb7e-855b9f4f69e2\",\n * \"_updatedDate\": \"2024-06-10T12:48:59.740Z\",\n * \"requiredPoints\": 80,\n * \"revision\": \"3\",\n * \"tierDefinition\": {\n * \"name\": \"Updated Tier\",\n * \"description\": \"Updated tier name\"\n * }\n * }\n */ "},{"title":"Update tier (dashboard page code) @description:","content":"import { tiers } from \"wix-loyalty.v2\";\n\n /* Sample parameter values:\n *\n * {\n * \"tier\": {\n * \"_id\": \"7e26e41b-3bb6-40c9-bb7e-855b9f4f69e2\",\n * \"required_points\": 80,\n * \"tierDefinition\": {\n * \"name\": \"Updated Tier\",\n * \"description\": \"Updated tier name\"\n * }\n * }\n * }\n */ \n\nasync function updateTier(id, tier) {\n try {\n const result = await tiers.updateTier(id, tier);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n/* Promise resolves to:\n * {\n * \"_createdDate\": \"2024-06-06T10:33:19.121Z\",\n * \"_id\": \"7e26e41b-3bb6-40c9-bb7e-855b9f4f69e2\",\n * \"_updatedDate\": \"2024-06-10T12:48:59.740Z\",\n * \"requiredPoints\": 80,\n * \"revision\": \"3\",\n * \"tierDefinition\": {\n * \"name\": \"Updated Tier\",\n * \"description\": \"Updated tier name\"\n * }\n * }\n */ \n"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tier ID."},{"name":"tier","slug":"tier","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateTier","referenceFqn":"UpdateTier"},"description":"Tier info to update."}],"description":"Updates a loyalty tier.\n\nUse this endpoint to update tier-specific settings, such as the name and the required points\nthreshold of an individual loyalty tier. To update global settings that apply to all of a site's loyalty tiers,\nuse [`updateTiersProgramSettings()`](#updatetiersprogramsettings)."},{"name":"updateTiersProgramSettings","fqn":"updateTiersProgramSettings","slug":"update-tiers-program-settings","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["programSettings","programSettings.revision","programSettings.status"],"permissions":["Manage Loyalty"],"permissionsScopesIds":["SCOPE.DC-LOYALTY.MANAGE-LOYALTY"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"UpdateTiersProgramSettingsResponse","referenceFqn":"UpdateTiersProgramSettingsResponse"}},"examples":[{"title":"Update global settings of a loyalty tier program (export from backend code) ","description":"","content":"import { tiers } from \"wix-loyalty.v2\";\nimport { webMethod, Permissions } from \"wix-web-module\";\nimport { elevate } from \"wix-auth\";\n\n/* Sample programSettings object:\n *\n * {\n * \"programSettings\": {\n * \"revision\": \"2\",\n * \"status\": \"PAUSED\",\n * \"rollingWindow\": {\n * \"durationInMonths\": 12\n * }\n * }\n * }\n */ \n \nconst elevatedUpdateTiersProgramSettings = elevate(\n tiers.updateTiersProgramSettings,\n);\n\nexport const updateTiersProgramSettings = webMethod(\n Permissions.Anyone,\n async (programSettings) => {\n try {\n const result = await elevatedUpdateTiersProgramSettings(programSettings);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n },\n);\n\n /* Promise resolves to:\n *\n * {\n * \"programSettings\": {\n * \"_createdDate\": \"2024-06-05T20:27:19.147Z\",\n * \"_updatedDate\": \"2024-06-11T14:12:48.551Z\",\n * \"status\": \"PAUSED\",\n * \"revision\": \"3\",\n * \"rollingWindow\": {\n * \"durationInMonths\": 12\n * }\n * }\n * }\n */"},{"title":"Update tiers program settings (dashboard page code) ","description":"","content":"import { tiers } from \"wix-loyalty.v2\";\n\n/* Sample programSettings object:\n *\n * {\n * \"programSettings\": {\n * \"revision\": \"2\",\n * \"status\": \"PAUSED\",\n * \"rollingWindow\": {\n * \"durationInMonths\": 12\n * }\n * }\n * }\n */ \n\nasync function updateTiersProgramSettings(programSettings) {\n try {\n const result = await tiers.updateTiersProgramSettings(programSettings);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n\n /* Promise resolves to:\n *\n * {\n * \"programSettings\": {\n * \"_createdDate\": \"2024-06-05T20:27:19.147Z\",\n * \"_updatedDate\": \"2024-06-11T14:12:48.551Z\",\n * \"status\": \"PAUSED\",\n * \"revision\": \"3\",\n * \"rollingWindow\": {\n * \"durationInMonths\": 12\n * }\n * }\n * }\n */\n"}],"actionParams":[{"name":"programSettings","slug":"program-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TiersProgramSettings","referenceFqn":"TiersProgramSettings"},"description":"Settings for the tiers program."}],"description":"Updates the global settings of a loyalty tier program.\n\nUse this endpoint to update settings that apply to all of a site's loyalty tiers.\nTo update tier-specific settings for an individual tier, use\n[`updateTier()`](#updatetier).\n\nBy default, the `status` of a tiers program is set to `\"DISABLED\"` and must be manually updated to `\"ACTIVE\"` using\nthis endpoint or through a site owner's [dashboard](https://manage.wix.com/account/site-selector/?actionUrl=https%3A%2F%2Fwww.wix.com%2Fdashboard%2F%7BmetaSiteId%7D%2Floyalty-accounts%2Fmanage%3Ftab%3Dpoints-and-rewards&title=Select+a+Site&primaryButtonText=Select+Site).\n\n>**Note:** The `status`, `revision`, and `rollingWindow` parameters must be passed to update the tiers program settings. The `baseTierDefinition` fields are not required, however, if you don't pass them they will reset to their default values of empty fields."}],"webhooks":[],"articles":[{"content":"---\ntitle: Introduction\n---\n\n# Introduction\n \n

\n Developer Preview\n
\n APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.\n

\n\n \n\nThe Loyalty Tiers API allows you to create a levels-based program that assigns loyalty accounts to different tiers based on the amount of points they have earned. \n\nWith the Loyalty Tiers API, you can:\n- [Create](#createtier) and [update](#updatetier) individual tiers.\n- [Update](#updatetiersprogramsettings) settings that apply globally to the tiers program. \n\nFor more information about loyalty tiers, see [Adding Tiers to Your Loyalty Program](https://support.wix.com/en/article/wix-loyalty-program-adding-tiers-to-your-loyalty-program). \n\nTo use the Loyalty Tiers API, import `{ tiers }` from the `wix-loyalty.v2` module. \n\n```javascript\nimport { tiers } from 'wix-loyalty.v2';\n```\n\n## Before you begin \n\nIt's important to note the following points before starting to code:\n- The site must have a [Business VIP Premium Plan](https://support.wix.com/en/article/business-vip-premium-plan-overview) or a [Scale Premium Plan](https://support.wix.com/en/article/editor-x-scale-premium-plan-overview) to add tiers.\n- The site must have at least one of these apps: Wix Bookings, Wix Events, Wix Pricing Plans, or Wix Stores.\n >**Note:** Currently, tiers cannot be added to Wix Restaurants loyalty programs.\n- The tiers program `status` must be manually set to `ACTIVE`. Use [`updateTiersProgramSettings()`](#updatetiersprogramsettings) to update the `status` or enable tiers from a site owner's [dashboard](https://manage.wix.com/account/site-selector/?actionUrl=https%3A%2F%2Fwww.wix.com%2Fdashboard%2F%7BmetaSiteId%7D%2Floyalty-accounts%2Fmanage%3Ftab%3Dpoints-and-rewards&title=Select+a+Site&primaryButtonText=Select+Site).\n- The Loyalty Tiers API does not handle rules for earning points based on your tier. A site owner may adjust those settings from their dashboard. See [Assign ways to earn to each tier](https://support.wix.com/en/article/wix-loyalty-program-adding-tiers-to-your-loyalty-program#step-2-assign-ways-to-earn-and-rewards-to-each-tier).\n\n## Terminology \n\n- **Tiers program settings:** Settings that apply globally to the overall tiers program. \n- **Base tier:** A default tier for any loyalty account that is unassigned for not meeting the required points threshold of any other tier. The base tier requires `0` points, has no `tierId`, and is not returned as a tier when [`listTiers()`](#listtiers) is called. When a tiers program status is `PAUSED` or `DISABLED` all of the loyalty accounts are assigned to the base tier.\n- **Rolling window:** Period of time used to calculate loyalty points for tier assignment. The total points earned and adjusted during this period determine if the account meets a tier's required point threshold. The window is recalculated every 15 minutes or if a new tier event triggers.\n- **Points earned and adjusted:** Tier assignment is based on the total amount of loyalty points earned and adjusted over the period of time in a `rollingWindow`. If an account redeems points during that period, the points that were earned still count towards tier assignment even if that leaves the remaining points balance below the tier's required point threshold. Similarly, if the current points balance for a loyalty account is above a tier's required points threshold, but those points were earned in a time period earlier than the `rollingWindow` then those points are not considered for tier assignment.\n","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[],"namespaces":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.116"}}

getTiersProgramSettings( )