diff --git a/src/lib/blueprint.ts b/src/lib/blueprint.ts index 71e494fb..12b8916d 100644 --- a/src/lib/blueprint.ts +++ b/src/lib/blueprint.ts @@ -53,10 +53,12 @@ export interface Endpoint { path: string name: string description: string - isUndocumented: boolean isDeprecated: boolean - isDraft: boolean deprecationMessage: string + isUndocumented: boolean + undocumentedMessage: string + isDraft: boolean + draftMessage: string request: Request response: Response codeSamples: CodeSample[] @@ -64,12 +66,14 @@ export interface Endpoint { interface BaseParameter { name: string + description: string isRequired: boolean - isUndocumented: boolean isDeprecated: boolean - isDraft: boolean deprecationMessage: string - description: string + isUndocumented: boolean + undocumentedMessage: string + isDraft: boolean + draftMessage: string } interface StringParameter extends BaseParameter { @@ -165,7 +169,9 @@ interface BaseProperty { isDeprecated: boolean deprecationMessage: string isUndocumented: boolean + undocumentedMessage: string isDraft: boolean + draftMessage: string } export type Property = @@ -484,12 +490,13 @@ const createEndpoint = async ( const description = parsedOperation.description const isUndocumented = parsedOperation['x-undocumented'].length > 0 + const undocumentedMessage = parsedOperation['x-undocumented'] const isDeprecated = parsedOperation.deprecated + const deprecationMessage = parsedOperation['x-deprecated'] const isDraft = parsedOperation['x-draft'].length > 0 - - const deprecationMessage = parsedOperation['x-deprecated'] + const draftMessage = parsedOperation['x-draft'] const request = createRequest(methods, operation, path) @@ -498,10 +505,12 @@ const createEndpoint = async ( name, path: endpointPath, description, - isUndocumented, isDeprecated, - isDraft, deprecationMessage, + isUndocumented, + undocumentedMessage, + isDraft, + draftMessage, response: createResponse(operation, path), request, } @@ -618,7 +627,9 @@ const createParameter = ( isDeprecated: parsedProp['x-deprecated'].length > 0, deprecationMessage: parsedProp['x-deprecated'], isUndocumented: parsedProp['x-undocumented'].length > 0, + undocumentedMessage: parsedProp['x-undocumented'], isDraft: parsedProp['x-draft'].length > 0, + draftMessage: parsedProp['x-draft'], } switch (parsedProp.type) { @@ -831,7 +842,9 @@ const createProperty = ( isDeprecated: parsedProp['x-deprecated'].length > 0, deprecationMessage: parsedProp['x-deprecated'], isUndocumented: parsedProp['x-undocumented'].length > 0, + undocumentedMessage: parsedProp['x-undocumented'], isDraft: parsedProp['x-draft'].length > 0, + draftMessage: parsedProp['x-draft'], } switch (parsedProp.type) { diff --git a/test/snapshots/blueprint.test.ts.md b/test/snapshots/blueprint.test.ts.md index a1bbb93d..2d50f665 100644 --- a/test/snapshots/blueprint.test.ts.md +++ b/test/snapshots/blueprint.test.ts.md @@ -16,76 +16,91 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'Foo id', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'foo_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Foo name', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'name', + undocumentedMessage: '', }, { deprecationMessage: 'This prop will be removed in the next version', description: 'This prop is deprecated', + draftMessage: '', format: 'string', isDeprecated: true, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'deprecated_prop', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'This prop is undocumented', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: true, jsonType: 'string', name: 'undocumented_prop', + undocumentedMessage: 'This prop is intentionally left undocumented.', }, { deprecationMessage: '', description: 'This prop is draft', + draftMessage: 'This prop is intentionally left draft.', format: 'string', isDeprecated: false, isDraft: true, isUndocumented: false, jsonType: 'string', name: 'draft_prop', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'This prop is nullable', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'nullable_prop', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'This prop is a number', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'number', name: 'number_prop', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, @@ -96,24 +111,29 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'foo', + undocumentedMessage: '', }, ], + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'array', name: 'array_prop', + undocumentedMessage: '', }, ], resourceType: 'foo', @@ -124,22 +144,26 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'plane id', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'plane_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Planej name', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'name', + undocumentedMessage: '', }, ], resourceType: 'plane', @@ -244,6 +268,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -264,6 +289,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: 'Get a foo', + undocumentedMessage: '', }, { codeSamples: [ @@ -361,6 +387,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -381,6 +408,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: 'Get a foo', + undocumentedMessage: '', }, { codeSamples: [ @@ -479,6 +507,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -499,6 +528,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List foos', + undocumentedMessage: '', }, { codeSamples: [ @@ -597,6 +627,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -617,6 +648,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List foos', + undocumentedMessage: '', }, { codeSamples: [ @@ -714,6 +746,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -734,6 +767,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: 'Get a foo', + undocumentedMessage: '', }, { codeSamples: [ @@ -831,6 +865,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -851,6 +886,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: 'Get a foo', + undocumentedMessage: '', }, { codeSamples: [ @@ -949,6 +985,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -969,6 +1006,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List foos', + undocumentedMessage: '', }, { codeSamples: [ @@ -1067,6 +1105,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -1087,6 +1126,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List foos', + undocumentedMessage: '', }, { codeSamples: [ @@ -1184,6 +1224,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -1204,6 +1245,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: 'Get a foo', + undocumentedMessage: '', }, { codeSamples: [ @@ -1301,6 +1343,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -1321,6 +1364,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: 'Get a foo', + undocumentedMessage: '', }, { codeSamples: [ @@ -1419,6 +1463,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -1439,6 +1484,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List foos', + undocumentedMessage: '', }, { codeSamples: [ @@ -1537,6 +1583,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -1557,6 +1604,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List foos', + undocumentedMessage: '', }, ], isDeprecated: false, @@ -1651,6 +1699,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -1671,6 +1720,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List planes', + undocumentedMessage: '', }, { codeSamples: [ @@ -1754,6 +1804,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -1774,6 +1825,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List planes', + undocumentedMessage: '', }, { codeSamples: [ @@ -1857,6 +1909,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -1877,6 +1930,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List planes', + undocumentedMessage: '', }, ], isDeprecated: false, @@ -1969,6 +2023,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: true, isDraft: false, isUndocumented: true, @@ -1987,6 +2042,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Deprecated and undocumented endpoint', + undocumentedMessage: 'true', }, { codeSamples: [ @@ -2063,6 +2119,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: true, isDraft: false, isUndocumented: true, @@ -2081,6 +2138,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Deprecated and undocumented endpoint', + undocumentedMessage: 'true', }, { codeSamples: [ @@ -2157,6 +2215,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: true, isDraft: false, isUndocumented: true, @@ -2175,6 +2234,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Deprecated and undocumented endpoint', + undocumentedMessage: 'true', }, ], isDeprecated: true, @@ -2267,6 +2327,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: 'true', isDeprecated: false, isDraft: true, isUndocumented: false, @@ -2285,6 +2346,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Draft endpoint', + undocumentedMessage: '', }, { codeSamples: [ @@ -2361,6 +2423,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: 'true', isDeprecated: false, isDraft: true, isUndocumented: false, @@ -2379,6 +2442,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Draft endpoint', + undocumentedMessage: '', }, { codeSamples: [ @@ -2455,6 +2519,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: 'true', isDeprecated: false, isDraft: true, isUndocumented: false, @@ -2473,6 +2538,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Draft endpoint', + undocumentedMessage: '', }, ], isDeprecated: false, @@ -2499,76 +2565,91 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'Foo id', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'foo_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Foo name', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'name', + undocumentedMessage: '', }, { deprecationMessage: 'This prop will be removed in the next version', description: 'This prop is deprecated', + draftMessage: '', format: 'string', isDeprecated: true, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'deprecated_prop', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'This prop is undocumented', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: true, jsonType: 'string', name: 'undocumented_prop', + undocumentedMessage: 'This prop is intentionally left undocumented.', }, { deprecationMessage: '', description: 'This prop is draft', + draftMessage: 'This prop is intentionally left draft.', format: 'string', isDeprecated: false, isDraft: true, isUndocumented: false, jsonType: 'string', name: 'draft_prop', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'This prop is nullable', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'nullable_prop', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'This prop is a number', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'number', name: 'number_prop', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, @@ -2579,24 +2660,29 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'foo', + undocumentedMessage: '', }, ], + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'array', name: 'array_prop', + undocumentedMessage: '', }, ], resourceType: 'foo', @@ -2607,22 +2693,26 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'plane id', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'plane_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Planej name', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'name', + undocumentedMessage: '', }, ], resourceType: 'plane', @@ -2743,6 +2833,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2763,6 +2854,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: 'Get a foo', + undocumentedMessage: '', }, { codeSamples: [ @@ -2876,6 +2968,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2896,6 +2989,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: 'Get a foo', + undocumentedMessage: '', }, { codeSamples: [ @@ -3010,6 +3104,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3030,6 +3125,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List foos', + undocumentedMessage: '', }, { codeSamples: [ @@ -3144,6 +3240,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3164,6 +3261,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List foos', + undocumentedMessage: '', }, { codeSamples: [ @@ -3277,6 +3375,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3297,6 +3396,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: 'Get a foo', + undocumentedMessage: '', }, { codeSamples: [ @@ -3410,6 +3510,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3430,6 +3531,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: 'Get a foo', + undocumentedMessage: '', }, { codeSamples: [ @@ -3544,6 +3646,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3564,6 +3667,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List foos', + undocumentedMessage: '', }, { codeSamples: [ @@ -3678,6 +3782,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3698,6 +3803,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List foos', + undocumentedMessage: '', }, { codeSamples: [ @@ -3811,6 +3917,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3831,6 +3938,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: 'Get a foo', + undocumentedMessage: '', }, { codeSamples: [ @@ -3944,6 +4052,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3964,6 +4073,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: 'Get a foo', + undocumentedMessage: '', }, { codeSamples: [ @@ -4078,6 +4188,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -4098,6 +4209,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List foos', + undocumentedMessage: '', }, { codeSamples: [ @@ -4212,6 +4324,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -4232,6 +4345,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List foos', + undocumentedMessage: '', }, ], isDeprecated: false, @@ -4342,6 +4456,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -4362,6 +4477,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List planes', + undocumentedMessage: '', }, { codeSamples: [ @@ -4461,6 +4577,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -4481,6 +4598,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List planes', + undocumentedMessage: '', }, { codeSamples: [ @@ -4580,6 +4698,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -4600,6 +4719,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List planes', + undocumentedMessage: '', }, ], isDeprecated: false, @@ -4708,6 +4828,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: true, isDraft: false, isUndocumented: true, @@ -4726,6 +4847,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Deprecated and undocumented endpoint', + undocumentedMessage: 'true', }, { codeSamples: [ @@ -4818,6 +4940,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: true, isDraft: false, isUndocumented: true, @@ -4836,6 +4959,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Deprecated and undocumented endpoint', + undocumentedMessage: 'true', }, { codeSamples: [ @@ -4928,6 +5052,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: true, isDraft: false, isUndocumented: true, @@ -4946,6 +5071,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Deprecated and undocumented endpoint', + undocumentedMessage: 'true', }, ], isDeprecated: true, @@ -5054,6 +5180,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: 'true', isDeprecated: false, isDraft: true, isUndocumented: false, @@ -5072,6 +5199,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Draft endpoint', + undocumentedMessage: '', }, { codeSamples: [ @@ -5164,6 +5292,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: 'true', isDeprecated: false, isDraft: true, isUndocumented: false, @@ -5182,6 +5311,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Draft endpoint', + undocumentedMessage: '', }, { codeSamples: [ @@ -5274,6 +5404,7 @@ Generated by [AVA](https://avajs.dev). ], deprecationMessage: '', description: '', + draftMessage: 'true', isDeprecated: false, isDraft: true, isUndocumented: false, @@ -5292,6 +5423,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Draft endpoint', + undocumentedMessage: '', }, ], isDeprecated: false, diff --git a/test/snapshots/blueprint.test.ts.snap b/test/snapshots/blueprint.test.ts.snap index 0ce7e208..d0caeee1 100644 Binary files a/test/snapshots/blueprint.test.ts.snap and b/test/snapshots/blueprint.test.ts.snap differ diff --git a/test/snapshots/seam-blueprint.test.ts.md b/test/snapshots/seam-blueprint.test.ts.md index 9ec6d909..e2680733 100644 --- a/test/snapshots/seam-blueprint.test.ts.md +++ b/test/snapshots/seam-blueprint.test.ts.md @@ -16,12 +16,14 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: 'use external_type', description: '', + draftMessage: '', format: 'enum', isDeprecated: true, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'access_group_type', + undocumentedMessage: '', values: [ { name: 'pti_unit', @@ -40,62 +42,74 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: 'use external_type_display_name', description: '', + draftMessage: '', format: 'string', isDeprecated: true, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'access_group_type_display_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'acs_access_group_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'created_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'display_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'external_type', + undocumentedMessage: '', values: [ { name: 'pti_unit', @@ -114,42 +128,50 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'external_type_display_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'is_managed', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'workspace_id', + undocumentedMessage: '', }, ], resourceType: 'acs_access_group', @@ -160,12 +182,14 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'access_method', + undocumentedMessage: '', values: [ { name: 'code', @@ -181,112 +205,134 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'acs_credential_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'acs_credential_pool_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'card_number', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'code', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'created_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'display_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'ends_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'array', name: 'errors', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'external_type', + undocumentedMessage: '', values: [ { name: 'pti_card', @@ -308,96 +354,115 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'external_type_display_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'is_issued', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'is_latest_desired_state_synced_with_provider', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'is_managed', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'is_multi_phone_sync_credential', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'issued_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'latest_desired_state_synced_with_provider_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'parent_acs_credential_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'starts_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, @@ -408,22 +473,26 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'auto_join', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'card_function_type', + undocumentedMessage: '', values: [ { name: 'guest', @@ -436,84 +505,101 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'card_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'array', name: 'common_acs_entrance_ids', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'credential_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'array', name: 'guest_acs_entrance_ids', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'is_valid', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'array', name: 'joiner_acs_credential_ids', + undocumentedMessage: '', }, ], + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'array', name: 'warnings', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'workspace_id', + undocumentedMessage: '', }, ], resourceType: 'acs_credential', @@ -524,52 +610,62 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'acs_credential_pool_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'created_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'display_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'external_type', + undocumentedMessage: '', values: [ { name: 'hid_part_number', @@ -579,22 +675,26 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'external_type_display_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'workspace_id', + undocumentedMessage: '', }, ], resourceType: 'acs_credential_pool', @@ -605,52 +705,62 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'acs_credential_provisioning_automation_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'created_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'credential_manager_acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'user_identity_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'workspace_id', + undocumentedMessage: '', }, ], resourceType: 'acs_credential_provisioning_automation', @@ -661,56 +771,67 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'ID of the entrance.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'acs_entrance_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'ID of the access control system that contains the entrance.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Date and time at which the entrance was created.', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'created_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Display name for the entrance.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'display_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'array', name: 'errors', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, @@ -721,48 +842,58 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'accessibility_type', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'door_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'door_type', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'is_connected', + undocumentedMessage: '', }, ], + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, @@ -773,88 +904,106 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'battery_level', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'door_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'intrusion_alarm', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'left_open_alarm', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'lock_type', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'locked_state', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'online', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'privacy_mode', + undocumentedMessage: '', }, ], + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, @@ -865,12 +1014,14 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'door_category', + undocumentedMessage: '', values: [ { name: 'entrance', @@ -892,24 +1043,29 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'door_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'array', name: 'profiles', + undocumentedMessage: '', }, ], + undocumentedMessage: '', }, ], resourceType: 'acs_entrance', @@ -920,92 +1076,110 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'ID of the `acs_system`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'can_add_acs_users_to_acs_access_groups', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`.', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'can_automate_enrollment', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'can_create_acs_access_groups', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'can_remove_acs_users_from_acs_access_groups', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`.', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'array', name: 'connected_account_ids', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Date and time at which the `acs_system` was created.', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'created_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Errors associated with the `acs_system`.', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'array', name: 'errors', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Brand-specific terminology for the `acs_system` type.', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'external_type', + undocumentedMessage: '', values: [ { name: 'pti_site', @@ -1036,52 +1210,62 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'Display name that corresponds to the brand-specific terminology for the `acs_system` type.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'external_type_display_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Alternative text for the `acs_system` image.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'image_alt_text', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'URL for the image that represents the `acs_system`.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'image_url', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Name of the `acs_system`.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'name', + undocumentedMessage: '', }, { deprecationMessage: 'Use `external_type`.', description: '', + draftMessage: '', format: 'enum', isDeprecated: true, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'system_type', + undocumentedMessage: '', values: [ { name: 'pti_site', @@ -1112,16 +1296,19 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: 'Use `external_type_display_name`.', description: '', + draftMessage: '', format: 'string', isDeprecated: true, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'system_type_display_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, @@ -1132,54 +1319,65 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'IP address or hostname of the main Visionline server relative to the Seam Bridge on the local network.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'lan_address', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'mobile_access_uuid', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'system_id', + undocumentedMessage: '', }, ], + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Warnings associated with the `acs_system`.', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'array', name: 'warnings', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'workspace_id', + undocumentedMessage: '', }, ], resourceType: 'acs_system', @@ -1190,6 +1388,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '`starts_at` and `ends_at` timestamps for the `acs_user`\'s access.', + draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, @@ -1200,104 +1399,125 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'ends_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'starts_at', + undocumentedMessage: '', }, ], + undocumentedMessage: '', }, { deprecationMessage: '', description: 'ID of the access control system that contains the `acs_user`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'ID of the `acs_user`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Date and time at which the `acs_user` was created.', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'created_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Display name for the `acs_user`.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'display_name', + undocumentedMessage: '', }, { deprecationMessage: 'use email_address.', description: '', + draftMessage: '', format: 'string', isDeprecated: true, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'email', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Email address of the `acs_user`.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'email_address', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Errors associated with the `acs_user`.', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'array', name: 'errors', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Brand-specific terminology for the `acs_user` type.', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'external_type', + undocumentedMessage: '', values: [ { name: 'pti_user', @@ -1319,142 +1539,170 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'Display name that corresponds to the brand-specific terminology for the `acs_user` type.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'external_type_display_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Full name of the `acs_user`.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'full_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'hid_acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: true, jsonType: 'boolean', name: 'is_latest_desired_state_synced_with_provider', + undocumentedMessage: 'Only used internally.', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'is_managed', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'is_suspended', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: true, jsonType: 'string', name: 'latest_desired_state_synced_with_provider_at', + undocumentedMessage: 'Only used internally.', }, { deprecationMessage: '', description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'phone_number', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Email address of the user identity associated with the `acs_user`.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'user_identity_email_address', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Full name of the user identity associated with the `acs_user`.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'user_identity_full_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'ID of the user identity associated with the `acs_user`.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'user_identity_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'user_identity_phone_number', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Warnings associated with the `acs_user`.', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'array', name: 'warnings', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'workspace_id', + undocumentedMessage: '', }, ], resourceType: 'acs_user', @@ -1465,222 +1713,266 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'acs_credential_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'action_attempt_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'client_session_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'climate_preset_key', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'number', name: 'cooling_set_point_celsius', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'number', name: 'cooling_set_point_fahrenheit', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'created_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'enrollment_automation_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'event_description', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'event_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'event_type', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'fan_mode_setting', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'number', name: 'heating_set_point_celsius', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'number', name: 'heating_set_point_fahrenheit', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'hvac_mode_setting', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', name: 'is_fallback_climate_preset', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'occurred_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'thermostat_schedule_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'workspace_id', + undocumentedMessage: '', }, ], resourceType: 'event', @@ -1691,82 +1983,98 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'climate_preset_key', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'created_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'ends_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'number', name: 'max_override_period_minutes', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'starts_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', name: 'thermostat_schedule_id', + undocumentedMessage: '', }, ], resourceType: 'thermostat_schedule', @@ -1779,6 +2087,7 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -1792,6 +2101,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -1799,10 +2109,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_access_group_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -1810,6 +2122,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -1820,11 +2133,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -1838,6 +2153,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -1845,10 +2161,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_access_group_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -1856,6 +2174,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'PUT', @@ -1866,11 +2185,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -1884,6 +2205,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -1891,6 +2213,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_access_group_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -1903,11 +2226,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -1921,6 +2246,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -1928,10 +2254,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -1939,6 +2267,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -1951,11 +2280,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -1969,6 +2300,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -1976,6 +2308,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_access_group_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -1988,11 +2321,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2006,6 +2341,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2013,6 +2349,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_access_group_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -2025,11 +2362,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2043,6 +2382,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2050,10 +2390,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_access_group_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2061,6 +2403,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -2071,6 +2414,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, ], isDeprecated: false, @@ -2092,6 +2436,7 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2105,6 +2450,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2112,6 +2458,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_access_group_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -2124,11 +2471,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2142,6 +2491,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2149,10 +2499,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2160,6 +2512,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -2172,6 +2525,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: '', + undocumentedMessage: '', }, ], isDeprecated: false, @@ -2193,6 +2547,7 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2206,6 +2561,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2213,6 +2569,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_system_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -2225,6 +2582,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: '', + undocumentedMessage: '', }, ], isDeprecated: false, @@ -2246,6 +2604,7 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2259,6 +2618,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2266,10 +2626,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_credential_pool_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, @@ -2277,10 +2639,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'boolean', name: 'create_credential_manager_user', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2288,10 +2652,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'credential_manager_acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2299,10 +2665,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'credential_manager_acs_user_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2310,6 +2678,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'user_identity_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -2322,6 +2691,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: '', }, ], isDeprecated: false, @@ -2343,6 +2713,7 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2356,6 +2727,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2363,10 +2735,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_credential_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2374,6 +2748,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'PATCH', @@ -2384,11 +2759,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2402,6 +2779,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2409,10 +2787,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_credential_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2420,6 +2800,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -2430,11 +2811,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2448,6 +2831,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, @@ -2455,6 +2839,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'access_method', + undocumentedMessage: '', values: [ { name: 'code', @@ -2470,6 +2855,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2477,10 +2863,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, @@ -2488,10 +2876,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'array', name: 'allowed_acs_entrance_ids', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -2499,10 +2889,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'code', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2510,10 +2902,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'credential_manager_acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, @@ -2521,10 +2915,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'ends_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, @@ -2532,10 +2928,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'boolean', name: 'is_multi_phone_sync_credential', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, @@ -2543,10 +2941,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'starts_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, @@ -2558,6 +2958,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2565,10 +2966,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'assa_abloy_credential_service_mobile_endpoint_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, @@ -2576,10 +2979,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'boolean', name: 'auto_join', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, @@ -2587,6 +2992,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'card_format', + undocumentedMessage: '', values: [ { name: 'TLCode', @@ -2599,6 +3005,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, @@ -2606,6 +3013,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'card_function_type', + undocumentedMessage: '', values: [ { name: 'guest', @@ -2618,6 +3026,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: 'use override.', description: '', + draftMessage: '', format: 'boolean', isDeprecated: true, isDraft: false, @@ -2625,10 +3034,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'boolean', name: 'is_override_key', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, @@ -2636,10 +3047,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'array', name: 'joiner_acs_credential_ids', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, @@ -2647,8 +3060,10 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'boolean', name: 'override', + undocumentedMessage: '', }, ], + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -2661,11 +3076,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2679,6 +3096,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2686,6 +3104,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_credential_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -2696,11 +3115,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2714,6 +3135,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2721,6 +3143,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_credential_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -2733,11 +3156,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2758,11 +3183,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2776,6 +3203,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2783,6 +3211,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_credential_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -2795,11 +3224,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2813,6 +3244,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2820,10 +3252,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_credential_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2831,6 +3265,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'PATCH', @@ -2841,11 +3276,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2859,6 +3296,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2866,10 +3304,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_credential_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -2877,6 +3317,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -2887,11 +3328,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2905,6 +3348,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -2912,10 +3356,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_credential_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -2923,10 +3369,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'code', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, @@ -2934,6 +3382,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'ends_at', + undocumentedMessage: '', }, ], preferredMethod: 'PATCH', @@ -2944,11 +3393,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2962,6 +3413,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -2969,10 +3421,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_credential_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -2980,10 +3434,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'code', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, @@ -2991,6 +3447,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'ends_at', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -3001,6 +3458,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, ], isDeprecated: false, @@ -3022,6 +3480,7 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3035,6 +3494,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3042,6 +3502,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_credential_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -3054,11 +3515,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3079,6 +3542,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: '', + undocumentedMessage: '', }, ], isDeprecated: false, @@ -3100,6 +3564,7 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: true, @@ -3120,11 +3585,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: 'Encoding a card is currently unimplemented.', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: true, @@ -3145,11 +3612,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: '', + undocumentedMessage: 'Encoders are in alpha.', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: true, @@ -3170,6 +3639,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: 'Reading a card is currently unimplemented.', }, ], isDeprecated: false, @@ -3191,6 +3661,7 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3204,6 +3675,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3211,6 +3683,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_entrance_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -3223,11 +3696,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3241,6 +3716,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3248,10 +3724,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_entrance_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3259,6 +3737,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -3269,11 +3748,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3287,6 +3768,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3294,10 +3776,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_credential_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3305,6 +3789,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_system_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -3317,11 +3802,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3335,6 +3822,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3342,10 +3830,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_entrance_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, @@ -3353,6 +3843,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'array', name: 'include_if', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -3365,6 +3856,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: '', + undocumentedMessage: '', }, ], isDeprecated: false, @@ -3388,6 +3880,7 @@ Generated by [AVA](https://avajs.dev). description: `Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).␊ ␊ Specify the desired access control system by including the corresponding \`acs_system_id\` in the request body.`, + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3401,6 +3894,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'ID of the desired access control system.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3408,6 +3902,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_system_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -3420,6 +3915,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: 'Get an ACS System', + undocumentedMessage: '', }, { codeSamples: [], @@ -3429,6 +3925,7 @@ Generated by [AVA](https://avajs.dev). To filter the list of returned access control systems by a specific connected account ID, include the ␊ \`connected_account_id\` in the request body. If you omit the \`connected_account_id\` parameter, the ␊ response includes all access control systems connected to your workspace.`, + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3442,6 +3939,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'ID of the connected account by which to filter the list of returned access control systems.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3449,6 +3947,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'connected_account_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -3461,6 +3960,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List ACS Systems', + undocumentedMessage: '', }, { codeSamples: [], @@ -3470,6 +3970,7 @@ Generated by [AVA](https://avajs.dev). ␊ Specify the ACS system for which you want to retrieve all compatible credential manager ACS ␊ systems by including the corresponding \`acs_system_id\` in the request body.`, + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3483,6 +3984,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3490,6 +3992,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_system_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -3502,6 +4005,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List Compatible Credential Manager ACS Systems', + undocumentedMessage: '', }, ], isDeprecated: false, @@ -3523,6 +4027,7 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: 'Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3536,6 +4041,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'ID of the desired access group.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3543,10 +4049,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_access_group_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'ID of the desired `acs_user`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3554,6 +4062,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -3564,11 +4073,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Add an ACS User to an Access Group', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: 'Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3582,6 +4093,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'ID of the desired access group.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3589,10 +4101,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_access_group_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'ID of the desired `acs_user`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3600,6 +4114,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'PUT', @@ -3610,11 +4125,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Add an ACS User to an Access Group', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: 'Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3628,6 +4145,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '`starts_at` and `ends_at` timestamps for the new `acs_user`\'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems.', + draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, @@ -3639,6 +4157,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, @@ -3646,10 +4165,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'ends_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, @@ -3657,12 +4178,15 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'starts_at', + undocumentedMessage: '', }, ], + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`.', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, @@ -3670,10 +4194,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'array', name: 'acs_access_group_ids', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'ID of the `acs_system` to which to add the new `acs_user`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3681,10 +4207,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: 'use email_address.', description: '', + draftMessage: '', format: 'string', isDeprecated: true, isDraft: false, @@ -3692,10 +4220,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'email', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Email address of the `acs_user`.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -3703,10 +4233,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'email_address', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Full name of the `acs_user`.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -3714,10 +4246,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'full_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -3725,10 +4259,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'phone_number', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'ID of the user identity with which to associate the new `acs_user`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3736,6 +4272,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'user_identity_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -3748,11 +4285,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: 'Create an ACS User', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: 'Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user\'s [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3766,6 +4305,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'ID of the desired `acs_user`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3773,6 +4313,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -3783,11 +4324,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Delete an ACS User', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: 'Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3801,6 +4344,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'ID of the desired `acs_user`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3808,6 +4352,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -3820,11 +4365,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: 'Get an ACS User', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: 'Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3838,6 +4385,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'ID of the `acs_system` for which you want to retrieve all `acs_user`s.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3845,10 +4393,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, @@ -3856,10 +4406,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'created_before', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -3867,10 +4419,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'limit', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Email address of the user identity for which you want to retrieve all `acs_user`s.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -3878,10 +4432,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'user_identity_email_address', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'ID of the user identity for which you want to retrieve all `acs_user`s.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3889,10 +4445,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'user_identity_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -3900,6 +4458,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'user_identity_phone_number', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -3912,11 +4471,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List ACS Users', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: 'Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3930,6 +4491,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'ID of the desired `acs_user`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3937,6 +4499,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -3949,11 +4512,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: 'List ACS User-Accessible Entrances', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: 'Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -3967,6 +4532,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'ID of the desired access group.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3974,10 +4540,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_access_group_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'ID of the desired `acs_user`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -3985,6 +4553,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -3995,11 +4564,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Remove an ACS User from an Access Group', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: 'Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -4013,6 +4584,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'ID of the desired `acs_user`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -4020,6 +4592,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -4030,11 +4603,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Revoke ACS User Access to All Entrances', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user\'s access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -4048,6 +4623,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'ID of the desired `acs_user`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -4055,6 +4631,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -4065,11 +4642,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Suspend an ACS User', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access.', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -4083,6 +4662,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: 'ID of the desired `acs_user`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -4090,6 +4670,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -4100,11 +4681,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Unsuspend an ACS User', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: 'Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -4118,6 +4701,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '`starts_at` and `ends_at` timestamps for the `acs_user`\'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems.', + draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, @@ -4129,6 +4713,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, @@ -4136,10 +4721,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'ends_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, @@ -4147,12 +4734,15 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'starts_at', + undocumentedMessage: '', }, ], + undocumentedMessage: '', }, { deprecationMessage: '', description: 'ID of the `acs_user`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -4160,10 +4750,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, { deprecationMessage: 'use email_address.', description: '', + draftMessage: '', format: 'string', isDeprecated: true, isDraft: false, @@ -4171,10 +4763,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'email', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Email address of the `acs_user`.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -4182,10 +4776,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'email_address', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Full name of the `acs_user`.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -4193,10 +4789,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'full_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -4204,10 +4802,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'hid_acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -4215,6 +4815,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'phone_number', + undocumentedMessage: '', }, ], preferredMethod: 'PATCH', @@ -4225,11 +4826,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Update an ACS User', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: 'Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -4243,6 +4846,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '`starts_at` and `ends_at` timestamps for the `acs_user`\'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems.', + draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, @@ -4254,6 +4858,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, @@ -4261,10 +4866,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'ends_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, @@ -4272,12 +4879,15 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'starts_at', + undocumentedMessage: '', }, ], + undocumentedMessage: '', }, { deprecationMessage: '', description: 'ID of the `acs_user`.', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -4285,10 +4895,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, { deprecationMessage: 'use email_address.', description: '', + draftMessage: '', format: 'string', isDeprecated: true, isDraft: false, @@ -4296,10 +4908,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'email', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Email address of the `acs_user`.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -4307,10 +4921,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'email_address', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Full name of the `acs_user`.', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -4318,10 +4934,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'full_name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -4329,10 +4947,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'hid_acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -4340,6 +4960,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'phone_number', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -4350,6 +4971,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: 'Update an ACS User', + undocumentedMessage: '', }, ], isDeprecated: false, @@ -4371,6 +4993,7 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: true, @@ -4384,6 +5007,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -4391,6 +5015,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_user_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -4403,11 +5028,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: 'No unmanaged users are currently implemented.', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: true, @@ -4421,6 +5048,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -4428,10 +5056,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'acs_system_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -4439,10 +5069,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'limit', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -4450,10 +5082,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'user_identity_email_address', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -4461,10 +5095,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'user_identity_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -4472,6 +5108,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'user_identity_phone_number', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -4484,6 +5121,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: '', + undocumentedMessage: 'No unmanaged users are currently implemented.', }, ], isDeprecated: false, @@ -4505,6 +5143,7 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -4518,6 +5157,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -4525,10 +5165,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -4536,10 +5178,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'event_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -4547,6 +5191,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'event_type', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -4559,11 +5204,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -4577,6 +5224,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -4584,10 +5232,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'access_code_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, @@ -4595,10 +5245,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'array', name: 'access_code_ids', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, @@ -4606,10 +5258,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'array', name: 'between', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -4617,10 +5271,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'connect_webview_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -4628,10 +5284,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'connected_account_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -4639,10 +5297,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, @@ -4650,10 +5310,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'array', name: 'device_ids', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, @@ -4661,6 +5323,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'event_type', + undocumentedMessage: '', values: [ { name: 'device.accessory_keypad_connected', @@ -4859,6 +5522,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, @@ -4866,10 +5530,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'array', name: 'event_types', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -4877,10 +5543,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'limit', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -4888,6 +5556,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'since', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -4900,6 +5569,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: '', + undocumentedMessage: '', }, ], isDeprecated: false, @@ -4916,6 +5586,7 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -4929,6 +5600,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -4936,10 +5608,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'climate_preset_key', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -4947,6 +5621,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -4959,11 +5634,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -4977,6 +5654,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -4984,10 +5662,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'cooling_set_point_celsius', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -4995,10 +5675,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'cooling_set_point_fahrenheit', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -5006,10 +5688,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, @@ -5017,6 +5701,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'boolean', name: 'sync', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -5029,11 +5714,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -5047,6 +5734,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -5054,10 +5742,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'climate_preset_key', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -5065,10 +5755,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'cooling_set_point_celsius', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -5076,10 +5768,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'cooling_set_point_fahrenheit', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -5087,10 +5781,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, @@ -5098,6 +5794,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'fan_mode_setting', + undocumentedMessage: '', values: [ { name: 'auto', @@ -5113,6 +5810,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -5120,10 +5818,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'heating_set_point_celsius', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -5131,10 +5831,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'heating_set_point_fahrenheit', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, @@ -5142,6 +5844,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'hvac_mode_setting', + undocumentedMessage: '', values: [ { name: 'off', @@ -5160,6 +5863,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, @@ -5167,10 +5871,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'boolean', name: 'manual_override_allowed', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -5178,6 +5884,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'name', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -5188,11 +5895,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -5206,6 +5915,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -5213,10 +5923,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'climate_preset_key', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -5224,6 +5936,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -5234,11 +5947,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: 'Use `/devices/get` instead.', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -5252,6 +5967,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -5259,10 +5975,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -5270,6 +5988,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'name', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -5282,11 +6001,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -5300,6 +6021,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -5307,10 +6029,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -5318,10 +6042,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'heating_set_point_celsius', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -5329,10 +6055,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'heating_set_point_fahrenheit', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, @@ -5340,6 +6068,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'boolean', name: 'sync', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -5352,11 +6081,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -5370,6 +6101,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -5377,10 +6109,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'cooling_set_point_celsius', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -5388,10 +6122,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'cooling_set_point_fahrenheit', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -5399,10 +6135,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -5410,10 +6148,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'heating_set_point_celsius', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -5421,10 +6161,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'heating_set_point_fahrenheit', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, @@ -5432,6 +6174,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'boolean', name: 'sync', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -5444,11 +6187,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -5462,6 +6207,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -5469,10 +6215,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'connect_webview_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: 'List all devices owned by this connected account', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -5480,10 +6228,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'connected_account_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, @@ -5491,10 +6241,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'array', name: 'connected_account_ids', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, @@ -5502,10 +6254,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'created_before', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'record', isDeprecated: false, isDraft: false, @@ -5513,10 +6267,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'object', name: 'custom_metadata_has', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, @@ -5524,10 +6280,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'array', name: 'device_ids', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, @@ -5535,10 +6293,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'array', name: 'device_types', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, @@ -5546,10 +6306,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'array', name: 'exclude_if', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, @@ -5557,10 +6319,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'array', name: 'include_if', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -5568,10 +6332,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'limit', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, @@ -5579,6 +6345,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'manufacturer', + undocumentedMessage: '', values: [ { name: 'akuvox', @@ -5690,6 +6457,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -5697,6 +6465,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'user_identifier_key', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -5709,11 +6478,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -5727,6 +6498,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -5734,10 +6506,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, @@ -5745,6 +6519,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'boolean', name: 'sync', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -5757,11 +6532,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -5775,6 +6552,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -5782,10 +6560,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'climate_preset_key', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -5793,6 +6573,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -5803,11 +6584,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -5821,6 +6604,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -5828,10 +6612,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, { deprecationMessage: 'use fan_mode_setting instead.', description: '', + draftMessage: '', format: 'enum', isDeprecated: true, isDraft: false, @@ -5839,6 +6625,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'fan_mode', + undocumentedMessage: '', values: [ { name: 'auto', @@ -5854,6 +6641,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, @@ -5861,6 +6649,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'fan_mode_setting', + undocumentedMessage: '', values: [ { name: 'auto', @@ -5876,6 +6665,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, @@ -5883,6 +6673,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'boolean', name: 'sync', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -5895,11 +6686,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -5913,6 +6706,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -5920,10 +6714,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'climate_preset_key', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -5931,10 +6727,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'cooling_set_point_celsius', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -5942,10 +6740,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'cooling_set_point_fahrenheit', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -5953,10 +6753,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, @@ -5964,6 +6766,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'fan_mode_setting', + undocumentedMessage: '', values: [ { name: 'auto', @@ -5979,6 +6782,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -5986,10 +6790,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'heating_set_point_celsius', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -5997,10 +6803,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'heating_set_point_fahrenheit', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, @@ -6008,6 +6816,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'hvac_mode_setting', + undocumentedMessage: '', values: [ { name: 'off', @@ -6026,6 +6835,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, @@ -6033,10 +6843,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'boolean', name: 'manual_override_allowed', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -6044,6 +6856,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'name', + undocumentedMessage: '', }, ], preferredMethod: 'PATCH', @@ -6054,11 +6867,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -6072,6 +6887,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -6079,10 +6895,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'climate_preset_key', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -6090,10 +6908,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'cooling_set_point_celsius', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -6101,10 +6921,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'cooling_set_point_fahrenheit', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -6112,10 +6934,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, @@ -6123,6 +6947,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'fan_mode_setting', + undocumentedMessage: '', values: [ { name: 'auto', @@ -6138,6 +6963,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -6145,10 +6971,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'heating_set_point_celsius', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -6156,10 +6984,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'heating_set_point_fahrenheit', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, @@ -6167,6 +6997,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'hvac_mode_setting', + undocumentedMessage: '', values: [ { name: 'off', @@ -6185,6 +7016,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, @@ -6192,10 +7024,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'boolean', name: 'manual_override_allowed', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -6203,6 +7037,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'name', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -6213,6 +7048,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, ], isDeprecated: false, @@ -6229,6 +7065,7 @@ Generated by [AVA](https://avajs.dev). codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -6242,6 +7079,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -6249,10 +7087,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'climate_preset_key', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -6260,10 +7100,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -6271,10 +7113,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'ends_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -6282,10 +7126,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'max_override_period_minutes', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -6293,10 +7139,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -6304,6 +7152,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'starts_at', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -6316,11 +7165,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -6334,6 +7185,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -6341,6 +7193,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'thermostat_schedule_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -6351,11 +7204,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -6369,6 +7224,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -6376,6 +7232,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'thermostat_schedule_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -6388,11 +7245,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -6406,6 +7265,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -6413,10 +7273,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'device_id', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -6424,6 +7286,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'user_identifier_key', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -6436,11 +7299,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'resource_list', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -6454,6 +7319,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -6461,10 +7327,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'climate_preset_key', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -6472,10 +7340,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'ends_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -6483,10 +7353,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'max_override_period_minutes', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -6494,10 +7366,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -6505,10 +7379,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'starts_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -6516,6 +7392,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'thermostat_schedule_id', + undocumentedMessage: '', }, ], preferredMethod: 'PATCH', @@ -6526,11 +7403,13 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, { codeSamples: [], deprecationMessage: '', description: '', + draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -6544,6 +7423,7 @@ Generated by [AVA](https://avajs.dev). { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -6551,10 +7431,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'climate_preset_key', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -6562,10 +7444,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'ends_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, @@ -6573,10 +7457,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'number', name: 'max_override_period_minutes', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -6584,10 +7470,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'name', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, @@ -6595,10 +7483,12 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'starts_at', + undocumentedMessage: '', }, { deprecationMessage: '', description: '', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -6606,6 +7496,7 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, jsonType: 'string', name: 'thermostat_schedule_id', + undocumentedMessage: '', }, ], preferredMethod: 'POST', @@ -6616,6 +7507,7 @@ Generated by [AVA](https://avajs.dev). responseType: 'void', }, title: '', + undocumentedMessage: '', }, ], isDeprecated: false, diff --git a/test/snapshots/seam-blueprint.test.ts.snap b/test/snapshots/seam-blueprint.test.ts.snap index 16ddecad..d03c14d7 100644 Binary files a/test/snapshots/seam-blueprint.test.ts.snap and b/test/snapshots/seam-blueprint.test.ts.snap differ