@osdk/typescript-sdk-docs 0.13.0 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @osdk/typescript-sdk-docs
2
2
 
3
+ ## 0.14.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 0bd4a2e: Document array element-subtype filters via $contains
8
+
3
9
  ## 0.13.0
4
10
 
5
11
  ### Minor Changes
@@ -381,30 +381,30 @@ export const snippets = {
381
381
  "computedVariables": ["functionInputValuesV2"]
382
382
  }],
383
383
  "stringStartsWithTemplate": [{
384
- "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}ObjectSet = client({{objectType}})\n .where({\n {{#structSubPropertyApiName}}\n {{property}}: { {{structSubPropertyApiName}}: { $startsWith: \"foo\" }}\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $startsWith: \"foo\" }\n {{/structSubPropertyApiName}}\n })"
384
+ "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}ObjectSet = client({{objectType}})\n .where({\n {{#arrayContains}}\n {{#structSubPropertyApiName}}\n {{property}}: { $contains: { {{structSubPropertyApiName}}: { $startsWith: \"foo\" } } }\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $contains: { $startsWith: \"foo\" } }\n {{/structSubPropertyApiName}}\n {{/arrayContains}}\n {{^arrayContains}}\n {{#structSubPropertyApiName}}\n {{property}}: { {{structSubPropertyApiName}}: { $startsWith: \"foo\" }}\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $startsWith: \"foo\" }\n {{/structSubPropertyApiName}}\n {{/arrayContains}}\n })"
385
385
  }],
386
386
  "containsAllTermsInOrderTemplate": [{
387
- "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}ObjectSet = client({{objectType}})\n .where({\n {{#structSubPropertyApiName}}\n {{property}}: { {{structSubPropertyApiName}}: { $containsAllTermsInOrder: \"foo bar\" }}\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $containsAllTermsInOrder: \"foo bar\" }\n {{/structSubPropertyApiName}}\n })"
387
+ "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}ObjectSet = client({{objectType}})\n .where({\n {{#arrayContains}}\n {{#structSubPropertyApiName}}\n {{property}}: { $contains: { {{structSubPropertyApiName}}: { $containsAllTermsInOrder: \"foo bar\" } } }\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $contains: { $containsAllTermsInOrder: \"foo bar\" } }\n {{/structSubPropertyApiName}}\n {{/arrayContains}}\n {{^arrayContains}}\n {{#structSubPropertyApiName}}\n {{property}}: { {{structSubPropertyApiName}}: { $containsAllTermsInOrder: \"foo bar\" }}\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $containsAllTermsInOrder: \"foo bar\" }\n {{/structSubPropertyApiName}}\n {{/arrayContains}}\n })"
388
388
  }],
389
389
  "containsAnyTermTemplate": [{
390
- "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}ObjectSet = client({{objectType}})\n .where({\n {{#structSubPropertyApiName}}\n {{property}}: { {{structSubPropertyApiName}}: { $containsAnyTerm: \"foo bar\" }}\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $containsAnyTerm: \"foo bar\" }\n {{/structSubPropertyApiName}}\n })"
390
+ "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}ObjectSet = client({{objectType}})\n .where({\n {{#arrayContains}}\n {{#structSubPropertyApiName}}\n {{property}}: { $contains: { {{structSubPropertyApiName}}: { $containsAnyTerm: \"foo bar\" } } }\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $contains: { $containsAnyTerm: \"foo bar\" } }\n {{/structSubPropertyApiName}}\n {{/arrayContains}}\n {{^arrayContains}}\n {{#structSubPropertyApiName}}\n {{property}}: { {{structSubPropertyApiName}}: { $containsAnyTerm: \"foo bar\" }}\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $containsAnyTerm: \"foo bar\" }\n {{/structSubPropertyApiName}}\n {{/arrayContains}}\n })"
391
391
  }],
392
392
  "containsAllTermsTemplate": [{
393
- "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}ObjectSet = client({{objectType}})\n .where({\n {{#structSubPropertyApiName}}\n {{property}}: { {{structSubPropertyApiName}}: { $containsAllTerms: \"foo bar\" }}\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $containsAllTerms: \"foo bar\" }\n {{/structSubPropertyApiName}}\n })"
393
+ "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}ObjectSet = client({{objectType}})\n .where({\n {{#arrayContains}}\n {{#structSubPropertyApiName}}\n {{property}}: { $contains: { {{structSubPropertyApiName}}: { $containsAllTerms: \"foo bar\" } } }\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $contains: { $containsAllTerms: \"foo bar\" } }\n {{/structSubPropertyApiName}}\n {{/arrayContains}}\n {{^arrayContains}}\n {{#structSubPropertyApiName}}\n {{property}}: { {{structSubPropertyApiName}}: { $containsAllTerms: \"foo bar\" }}\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $containsAllTerms: \"foo bar\" }\n {{/structSubPropertyApiName}}\n {{/arrayContains}}\n })"
394
394
  }],
395
395
  "equalityTemplate": [{
396
- "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}ObjectSet = client({{objectType}})\n .where({\n {{#structSubPropertyApiName}}\n {{property}}: { {{structSubPropertyApiName}}: { $eq: {{{propertyValueV2}}} }}\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $eq: {{{propertyValueV2}}} }\n {{/structSubPropertyApiName}}\n });",
396
+ "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}ObjectSet = client({{objectType}})\n .where({\n {{#arrayContains}}\n {{#structSubPropertyApiName}}\n {{property}}: { $contains: { {{structSubPropertyApiName}}: { $eq: {{{propertyValueV2}}} } } }\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $contains: { $eq: {{{propertyValueV2}}} } }\n {{/structSubPropertyApiName}}\n {{/arrayContains}}\n {{^arrayContains}}\n {{#structSubPropertyApiName}}\n {{property}}: { {{structSubPropertyApiName}}: { $eq: {{{propertyValueV2}}} }}\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $eq: {{{propertyValueV2}}} }\n {{/structSubPropertyApiName}}\n {{/arrayContains}}\n });",
397
397
  "computedVariables": ["propertyValueV2"]
398
398
  }],
399
399
  "inFilterTemplate": [{
400
- "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}ObjectSet = client({{objectType}})\n .where({\n {{#structSubPropertyApiName}}\n {{property}}: { {{structSubPropertyApiName}}: { $in: [{{{propertyValueV2}}}] }}\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $in: [{{{propertyValueV2}}}] }\n {{/structSubPropertyApiName}}\n });",
400
+ "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}ObjectSet = client({{objectType}})\n .where({\n {{#arrayContains}}\n {{#structSubPropertyApiName}}\n {{property}}: { $contains: { {{structSubPropertyApiName}}: { $in: [{{{propertyValueV2}}}] } } }\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $contains: { $in: [{{{propertyValueV2}}}] } }\n {{/structSubPropertyApiName}}\n {{/arrayContains}}\n {{^arrayContains}}\n {{#structSubPropertyApiName}}\n {{property}}: { {{structSubPropertyApiName}}: { $in: [{{{propertyValueV2}}}] }}\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $in: [{{{propertyValueV2}}}] }\n {{/structSubPropertyApiName}}\n {{/arrayContains}}\n });",
401
401
  "computedVariables": ["propertyValueV2"]
402
402
  }],
403
403
  "nullTemplate": [{
404
404
  "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}ObjectSet = client({{objectType}})\n .where({\n {{#structSubPropertyApiName}}\n {{property}}: { {{structSubPropertyApiName}}: { $isNull: true }}\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $isNull: true }\n {{/structSubPropertyApiName}}\n });"
405
405
  }],
406
406
  "rangeTemplate": [{
407
- "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}ObjectSet = client({{objectType}})\n .where({\n {{#structSubPropertyApiName}}\n {{property}}: { {{structSubPropertyApiName}}: { ${{operation}}: {{{propertyValueV2}}} }}\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { ${{operation}}: {{{propertyValueV2}}} }\n {{/structSubPropertyApiName}}\n });",
407
+ "template": "import { {{objectType}} } from \"{{{packageName}}}\";\n// Edit this import if your client location differs\nimport { client } from \"./client\";\n\nconst {{objectType}}ObjectSet = client({{objectType}})\n .where({\n {{#arrayContains}}\n {{#structSubPropertyApiName}}\n {{property}}: { $contains: { {{structSubPropertyApiName}}: { ${{operation}}: {{{propertyValueV2}}} } } }\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { $contains: { ${{operation}}: {{{propertyValueV2}}} } }\n {{/structSubPropertyApiName}}\n {{/arrayContains}}\n {{^arrayContains}}\n {{#structSubPropertyApiName}}\n {{property}}: { {{structSubPropertyApiName}}: { ${{operation}}: {{{propertyValueV2}}} }}\n {{/structSubPropertyApiName}}\n {{^structSubPropertyApiName}}\n {{property}}: { ${{operation}}: {{{propertyValueV2}}} }\n {{/structSubPropertyApiName}}\n {{/arrayContains}}\n });",
408
408
  "computedVariables": ["propertyValueV2"]
409
409
  }],
410
410
  "withinDistanceTemplate": [{