New code to generate sample code

code-generator/package.json

@@ -3,7 +3,8 @@
   "scripts": {
     "definitions": "rm -rf ../src/main/java/com/ringcentral/definitions/* && ts-node ./src/definitions.ts",
     "paths": "rm -rf ../src/main/java/com/ringcentral/paths/* && ts-node ./src/paths.ts",
-    "generate": "yarn definitions && yarn paths"
+    "samples": "ts-node ./src/samples.ts",
+    "generate": "yarn definitions && yarn paths && yarn samples"
   },
   "dependencies": {
     "change-case": "^4.1.2",

code-generator/src/samples.ts

@@ -0,0 +1,128 @@
+import fs from 'fs';
+import path from 'path';
+import {parsed} from 'ringcentral-open-api-parser';
+import R from 'ramda';
+import {camelCase} from 'change-case';
+import {capitalizeFirstLetter} from './utils';
+
+const markdown = ['# RingCentral Java SDK Code Samples'];
+
+const paths = R.sortBy(
+  R.path(['operations', 0, 'endpoint']) as any,
+  parsed.paths
+);
+
+const buildPath = (s: string): string => {
+  const tokens = s.split('/').filter(t => t.length > 0);
+  let result = '';
+  for (let i = 0; i < tokens.length; i++) {
+    const token = tokens[i];
+    if (token.startsWith('{')) {
+      result += `(${token.slice(1, token.length - 1)})`;
+    } else {
+      result += `.${camelCase(token)}`;
+      if (i >= tokens.length - 1 || !tokens[i + 1].startsWith('{')) {
+        result += '()';
+      }
+    }
+  }
+  return result;
+};
+
+for (const path of paths.filter(item => item.operations.length > 0)) {
+  for (const operation of path.operations) {
+    const parameters = [];
+    if (operation.bodyParameters) {
+      parameters.push(operation.bodyParameters);
+    }
+    if (operation.queryParameters) {
+      parameters.push(operation.queryParameters);
+    }
+    markdown.push(`\n\n## ${operation.operationId}`);
+    markdown.push(operation.summary ?? '');
+
+    markdown.push('\nName|Value');
+    markdown.push('-|-');
+    markdown.push(`HTTP Method|\`${operation.method.toUpperCase()}\``);
+    markdown.push(`Endpoint|\`${operation.endpoint}\``);
+    markdown.push(`Rate Limit Group|\`${operation.rateLimitGroup}\``);
+    markdown.push(`App Permission|\`${operation.appPermission ?? 'N/A'}\``);
+    markdown.push(`User Permission|\`${operation.userPermission ?? 'N/A'}\``);
+
+    markdown.push('\n```java');
+    markdown.push(
+      `RestClient rc = new RestClient(clientID, clientSecret, serverURL);
+rc.authorize(username, extension, password);`
+    );
+    let responseType = 'String';
+    if (operation.responseSchema?.$ref) {
+      responseType = operation.responseSchema?.$ref;
+    } else if (operation.responseSchema?.format === 'binary') {
+      responseType = 'byte[]';
+    }
+    markdown.push(
+      `${responseType} result = rc${buildPath(operation.endpoint)}.${
+        operation.method2
+      }(${parameters.join(', ')});`
+    );
+    markdown.push('rc.revoke();');
+    markdown.push('```\n');
+
+    if (operation.endpoint.indexOf('{apiVersion}') !== -1) {
+      markdown.push(
+        '- Parameter `apiVersion` is optional with default value `v1.0`'
+      );
+    }
+    if (operation.endpoint.indexOf('/scim/{version}') !== -1) {
+      markdown.push(
+        '- Parameter `version` is optional with default value `v2`'
+      );
+    }
+    if (operation.endpoint.indexOf('/account/{accountId}') !== -1) {
+      markdown.push(
+        '- Parameter `accountId` is optional with default value `~`'
+      );
+    }
+    if (operation.endpoint.indexOf('/extension/{extensionId}') !== -1) {
+      markdown.push(
+        '- Parameter `extensionId` is optional with default value `~`'
+      );
+    }
+
+    for (const parameter of parameters) {
+      markdown.push(
+        `- \`${parameter}\` is of type [${capitalizeFirstLetter(
+          parameter
+        )}](./src/main/java/com/ringcentral/definitions/${capitalizeFirstLetter(
+          parameter
+        )}.java)`
+      );
+    }
+
+    if (operation.responseSchema?.$ref) {
+      markdown.push(
+        `- \`result\` is of type [${operation.responseSchema.$ref}](./src/main/java/com/ringcentral/definitions/${operation.responseSchema.$ref}.java)`
+      );
+    } else if (!operation.responseSchema) {
+      markdown.push('- `result` is an empty string');
+    } else if (operation.responseSchema.format === 'binary') {
+      markdown.push('- `result` is of type `byte[]`');
+      markdown.push(`\n### ❗❗❗ Code sample above may not work
+\nPlease refer to [Binary content downloading](/README.md#Binary-content-downloading).`);
+    } else {
+      console.log(operation);
+    }
+
+    markdown.push(
+      `\n[Try it out](https://developer.ringcentral.com/api-reference#${operation.tags![0].replace(
+        / /g,
+        '-'
+      )}-${operation.operationId}) in API Explorer.`
+    );
+  }
+}
+
+fs.writeFileSync(
+  path.join(__dirname, '..', '..', 'samples.md'),
+  markdown.join('\n')
+);