Skip to content

Commit 9e9eaa2

Browse files
committed
patch access_codes/update_multiple name param
1 parent 12db6b8 commit 9e9eaa2

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

src/lib/reference.ts

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,28 @@ export const reference = (
9393
files[k] = { contents: Buffer.from('\n') }
9494
const file = files[k] as unknown as File
9595
file.layout = 'api-endpoint.hbs'
96+
if (endpoint.path === '/access_codes/update_multiple') {
97+
endpoint.request.parameters = endpoint.request.parameters.map(
98+
(param) => {
99+
if (param.name === 'name') {
100+
return {
101+
...param,
102+
description: `Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
103+
104+
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as \`first_name\` and \`last_name\`.
105+
106+
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
107+
108+
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called \`appearance\`. This is an object with a \`name\` property and, optionally, \`first_name\` and \`last_name\` properties (for providers that break down a name into components).`,
109+
}
110+
}
111+
112+
return param
113+
},
114+
)
115+
116+
console.dir(endpoint.request.parameters)
117+
}
96118
setEndpointLayoutContext(
97119
file,
98120
endpoint,

0 commit comments

Comments
 (0)