@osdk/typescript-sdk-docs 0.27.0 → 0.28.0

package/build/cjs/index.cjs

@@ -315,6 +315,12 @@ var snippets = {
         "loadObjectPageGuide": [{
           "template": 'import { {{objectType}} } from "{{{packageName}}}";\n// Edit this import if your client location differs\nimport { client } from "./client";\nimport { type Osdk, type PageResult } from "@osdk/client";\n\n// $select only the properties you read. Without it, the API loads its default property set,\n// and reading fewer properties afterwards does not avoid the cost of fetching them.\n// $pageSize is the size of one page, not a limit on the total number of objects.\n// fetchPage does not request a snapshot unless you pass $snapshot: true (a snapshot configured for\n// a function run still applies). Without one, if data changes between requests, later pages may\n// repeat or skip objects. Pass $snapshot: true on every request to page through one consistent\n// view, or use asyncIter(), which always requests a snapshot.\ntry {\n    const firstPage: PageResult<Osdk.Instance<{{objectType}}, never, "{{titleProperty}}">>\n        = await client({{objectType}}).fetchPage({ $select: ["{{titleProperty}}"], $pageSize: 30 });\n    if (firstPage.nextPageToken === undefined) {\n        console.log(firstPage.data);\n    }\n    const secondPage: PageResult<Osdk.Instance<{{objectType}}, never, "{{titleProperty}}">>\n        = await client({{objectType}}).fetchPage({\n            $select: ["{{titleProperty}}"],\n            $pageSize: 30,\n            $nextPageToken: firstPage.nextPageToken,\n        });\n    console.log([...firstPage.data, ...secondPage.data]);\n}\ncatch (e) {\n    throw e;\n}'
         }],
+        "selectPropertiesGuide": [{
+          "template": 'import { {{objectType}} } from "{{{packageName}}}";\n// Edit this import if your client location differs\nimport { client } from "./client";\n\nconst page = await client({{objectType}}).fetchPage({\n    $select: ["{{titleProperty}}"],\n});'
+        }],
+        "applyPropertyModifiersGuide": [{
+          "template": 'import { {{objectType}} } from "{{{packageName}}}";\n// Edit this import if your client location differs\nimport { client } from "./client";\n\nconst page = await client({{objectType}}).fetchPage({\n    $applyModifiers: {\n        {{arrayProperty}}: "applyReducers",\n    },\n});\n\nfor (const object of page.data) {\n    // The property type is the array element type, not the original array type.\n    const reducedValue = object.{{arrayProperty}};\n}'
+        }],
         "orderObjectsGuide": [{
           "template": 'import { {{objectType}} } from "{{{packageName}}}";\n// Edit this import if your client location differs\nimport { client } from "./client";\nimport { type Osdk, type PageResult } from "@osdk/client";\n\n// $select only the properties you read; without it, the default property set is loaded.\n// $pageSize is the size of one page, not a limit on the total number of objects.\ntry {\n    const page: PageResult<Osdk.Instance<{{objectType}}, never, "{{titleProperty}}">> = await client({{objectType}})\n        .fetchPage({\n            $select: ["{{titleProperty}}"],\n            $orderBy: {"{{titleProperty}}": "asc"},\n            $pageSize: 30\n        });\n    const objects = page.data;\n    const object = objects[0];\n} catch (e) {\n    throw e;\n}'
         }],
@@ -874,6 +880,9 @@ function renderType(type, majorVersion, context) {
     case "objectType": {
       return `"${type.objectTypeApiName}"`;
     }
+    case "scenarioReference": {
+      return `"${type.rid}"`;
+    }
     case "map": {
       if (type.keyType.type === "object") {
         return `{[${getMapKeyObjectName(type.keyType.apiName)}.$objectSpecifier]: ${renderType(type.valueType, majorVersion, context)}}`;