chore: adding support of PUT method (#573)

sbansla · web-flow · commit c581affdd96c · 2024-06-18T18:07:29.000+05:30
diff --git a/src/main/java/com/twilio/oai/api/ApiResourceBuilder.java b/src/main/java/com/twilio/oai/api/ApiResourceBuilder.java
@@ -59,6 +59,7 @@ protected ApiResourceBuilder(IApiActionTemplate template, List<CodegenOperation>
     public ApiResourceBuilder updateOperations(Resolver<CodegenParameter> codegenParameterIResolver) {
         this.codegenOperationList.forEach(codegenOperation -> {
             updateNestedContent(codegenOperation);
+            updateHttpMethod(codegenOperation);
             codegenOperation.allParams.forEach(param -> addModel(modelTree, param.baseType, param.dataType));
 
             codegenOperation.allParams.forEach(param -> resolveParam(codegenParameterIResolver, param));
@@ -91,6 +92,10 @@ public ApiResourceBuilder updateOperations(Resolver<CodegenParameter> codegenPar
         return this;
     }
 
+    public void updateHttpMethod(CodegenOperation co) {
+        
+    }
+
     protected void resolveParam(final Resolver<CodegenParameter> codegenParameterIResolver,
                                 final CodegenParameter param) {
         codegenParameterIResolver.resolve(param, this);
diff --git a/src/main/java/com/twilio/oai/api/CsharpApiResourceBuilder.java b/src/main/java/com/twilio/oai/api/CsharpApiResourceBuilder.java
@@ -4,6 +4,7 @@
 import com.twilio.oai.StringHelper;
 import com.twilio.oai.common.ApplicationConstants;
 import com.twilio.oai.common.EnumConstants;
+import com.twilio.oai.common.EnumConstants.CsharpHttpMethod;
 import com.twilio.oai.common.Utility;
 import com.twilio.oai.resolver.Resolver;
 import com.twilio.oai.resolver.csharp.OperationStore;
@@ -28,6 +29,7 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 
+import static com.twilio.oai.common.ApplicationConstants.HTTP_METHOD;
 import static com.twilio.oai.common.ApplicationConstants.PATH_SEPARATOR_PLACEHOLDER;
 
 public class CsharpApiResourceBuilder extends ApiResourceBuilder {
@@ -84,6 +86,23 @@ public ApiResourceBuilder updateOperations(Resolver<CodegenParameter> codegenPar
 
         return this;
     }
+    @Override
+    public void updateHttpMethod(CodegenOperation co) {
+        switch (co.httpMethod) {
+            case "GET":
+                co.vendorExtensions.put(HTTP_METHOD, CsharpHttpMethod.GET.getValue());
+                break;
+            case "POST":
+                co.vendorExtensions.put(HTTP_METHOD, CsharpHttpMethod.POST.getValue());
+                break;
+            case "PUT":
+                co.vendorExtensions.put(HTTP_METHOD, CsharpHttpMethod.PUT.getValue());
+                break;
+            case "DELETE":
+                co.vendorExtensions.put(HTTP_METHOD, CsharpHttpMethod.DELETE.getValue());
+                break;
+        }
+    }
 
     private void resolveIngressModel(CodegenOperation codegenOperation) {
         // Required params are used in parameters in C#, Check Params.mustache.
diff --git a/src/main/java/com/twilio/oai/api/JavaApiResourceBuilder.java b/src/main/java/com/twilio/oai/api/JavaApiResourceBuilder.java
@@ -6,6 +6,7 @@
 import com.twilio.oai.JsonRequestBodyResolver;
 import com.twilio.oai.StringHelper;
 import com.twilio.oai.common.EnumConstants;
+import com.twilio.oai.common.EnumConstants.JavaHttpMethod;
 import com.twilio.oai.common.Utility;
 import com.twilio.oai.resolver.Resolver;
 import com.twilio.oai.resolver.java.JavaConventionResolver;
@@ -16,11 +17,32 @@
 import org.openapitools.codegen.CodegenProperty;
 import org.openapitools.codegen.IJsonSchemaValidationProperties;
 
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.Set;
+import java.util.TreeSet;
 import java.util.function.Predicate;
 import java.util.stream.Collectors;
 
-import static com.twilio.oai.common.ApplicationConstants.*;
+import static com.twilio.oai.common.ApplicationConstants.ACCOUNT_SID_VEND_EXT;
+import static com.twilio.oai.common.ApplicationConstants.ARRAY;
+import static com.twilio.oai.common.ApplicationConstants.ENUM_VARS;
+import static com.twilio.oai.common.ApplicationConstants.HTTP_METHOD;
+import static com.twilio.oai.common.ApplicationConstants.LIST_END;
+import static com.twilio.oai.common.ApplicationConstants.LIST_START;
+import static com.twilio.oai.common.ApplicationConstants.PATH_SEPARATOR_PLACEHOLDER;
+import static com.twilio.oai.common.ApplicationConstants.REF_ENUM_EXTENSION_NAME;
+import static com.twilio.oai.common.ApplicationConstants.STRING;
+import static com.twilio.oai.common.ApplicationConstants.SUCCESS;
+import static com.twilio.oai.common.ApplicationConstants.TWILIO_EXTENSION_NAME;
 import static com.twilio.oai.template.AbstractApiActionTemplate.NESTED_MODELS;
 import static com.twilio.oai.template.JavaApiActionTemplate.API_TEMPLATE;
 
@@ -77,6 +99,7 @@ public ApiResourceBuilder updateOperations(Resolver<CodegenParameter> codegenPar
         JsonRequestBodyResolver jsonRequestBodyResolver = new JsonRequestBodyResolver(this, codegenPropertyIResolver);
         this.codegenOperationList.forEach(co -> {
             updateNestedContent(co);
+            updateHttpMethod(co);
             List<String> filePathArray = new ArrayList<>(Arrays.asList(co.baseName.split(PATH_SEPARATOR_PLACEHOLDER)));
             String resourceName = filePathArray.remove(filePathArray.size()-1);
             
@@ -147,6 +170,24 @@ public ApiResourceBuilder updateOperations(Resolver<CodegenParameter> codegenPar
         return this;
     }
 
+    @Override
+    public void updateHttpMethod(CodegenOperation co) {
+        switch (co.httpMethod) {
+            case "GET":
+                co.vendorExtensions.put(HTTP_METHOD, JavaHttpMethod.GET.getValue());
+                break;
+            case "POST":
+                co.vendorExtensions.put(HTTP_METHOD, JavaHttpMethod.POST.getValue());
+                break;
+            case "PUT":
+                co.vendorExtensions.put(HTTP_METHOD, JavaHttpMethod.PUT.getValue());
+                break;
+            case "DELETE":
+                co.vendorExtensions.put(HTTP_METHOD, JavaHttpMethod.DELETE.getValue());
+                break;
+        }
+    }
+
     private void updateHeaderParamsList(CodegenParameter cp) {
         List<CodegenProperty> codegenProperties = new ArrayList<>();
         if (cp.isEnum && cp.isHeaderParam) {
diff --git a/src/main/java/com/twilio/oai/api/NodeApiResourceBuilder.java b/src/main/java/com/twilio/oai/api/NodeApiResourceBuilder.java
@@ -17,6 +17,7 @@
 import org.openapitools.codegen.CodegenParameter;
 import org.openapitools.codegen.CodegenProperty;
 
+import static com.twilio.oai.common.ApplicationConstants.HTTP_METHOD;
 import static com.twilio.oai.common.ApplicationConstants.STRING;
 
 public class NodeApiResourceBuilder extends FluentApiResourceBuilder {
diff --git a/src/main/java/com/twilio/oai/api/PythonApiResourceBuilder.java b/src/main/java/com/twilio/oai/api/PythonApiResourceBuilder.java
@@ -3,6 +3,7 @@
 import com.twilio.oai.DirectoryStructureService;
 import com.twilio.oai.StringHelper;
 import com.twilio.oai.common.ApplicationConstants;
+import com.twilio.oai.common.EnumConstants;
 import com.twilio.oai.common.Utility;
 import com.twilio.oai.resolver.Resolver;
 import com.twilio.oai.resolver.python.PythonCodegenModelResolver;
@@ -19,6 +20,7 @@
 import org.openapitools.codegen.CodegenParameter;
 import org.openapitools.codegen.CodegenProperty;
 
+import static com.twilio.oai.common.ApplicationConstants.HTTP_METHOD;
 import static com.twilio.oai.common.ApplicationConstants.PATH_SEPARATOR_PLACEHOLDER;
 import static com.twilio.oai.common.ApplicationConstants.STRING;
 
@@ -65,6 +67,11 @@ public ApiResourceBuilder updateOperations(final Resolver<CodegenParameter> code
         return this;
     }
 
+    @Override
+    public void updateHttpMethod(CodegenOperation co) {
+        co.vendorExtensions.put(HTTP_METHOD, co.httpMethod);
+    }
+
     /**
      * Processes the response body and its models to resolve nested response models.
      * Returns the resource builder with resolved response body.
diff --git a/src/main/java/com/twilio/oai/common/ApplicationConstants.java b/src/main/java/com/twilio/oai/common/ApplicationConstants.java
@@ -48,6 +48,7 @@ public class ApplicationConstants {
     public static final String RESOURCE = "Resource";
     public static final String DOT = ".";
     public static final String ACCOUNT_SID_VEND_EXT = "x-is-account-sid";
+    public static final String HTTP_METHOD = "x-http-method";
     public static final String DEPENDENT_PROPERTIES = "dependentProperties";
 
     public static final String PREFIXED_COLLAPSIBLE_MAP = "prefixed-collapsible-map";
diff --git a/src/main/java/com/twilio/oai/common/EnumConstants.java b/src/main/java/com/twilio/oai/common/EnumConstants.java
@@ -98,4 +98,28 @@ public enum PhpDataTypes implements LanguageDataType {
 
         private final String value;
     }
+
+    @Getter
+    @RequiredArgsConstructor
+    public enum JavaHttpMethod {
+        GET("HttpMethod.GET"),
+        POST("HttpMethod.POST"),
+        PUT("HttpMethod.PUT"),
+        DELETE("HttpMethod.DELETE"),
+        HEAD("HttpMethod.HEAD"),
+        OPTIONS("HttpMethod.OPTIONS");
+
+        private final String value;
+    }
+
+    @Getter
+    @RequiredArgsConstructor
+    public enum CsharpHttpMethod {
+        GET("HttpMethod.Get"),
+        POST("HttpMethod.Post"),
+        PUT("HttpMethod.Put"),
+        DELETE("HttpMethod.Delete");
+
+        private final String value;
+    }
 }
diff --git a/src/main/resources/twilio-csharp/resource/CreateResource.mustache b/src/main/resources/twilio-csharp/resource/CreateResource.mustache
@@ -3,7 +3,7 @@
         {
             {{>resource/GeneratePath}}
             return new Request(
-                HttpMethod.Post,
+                {{vendorExtensions.x-http-method}},
                 Rest.Domain.{{domainPackage}},
                 path,
                 {{^vendorExtensions.x-is-json}}
diff --git a/src/main/resources/twilio-csharp/resource/DeleteResource.mustache b/src/main/resources/twilio-csharp/resource/DeleteResource.mustache
@@ -7,7 +7,7 @@
         {
             {{>resource/GeneratePath}}
             return new Request(
-                HttpMethod.Delete,
+                {{vendorExtensions.x-http-method}},
                 Rest.Domain.{{domainPackage}},
                 path,
                 queryParams: options.GetParams(),
diff --git a/src/main/resources/twilio-csharp/resource/FetchResource.mustache b/src/main/resources/twilio-csharp/resource/FetchResource.mustache
@@ -3,7 +3,7 @@
         {
             {{>resource/GeneratePath}}
             return new Request(
-                HttpMethod.Get,
+                {{vendorExtensions.x-http-method}},
                 Rest.Domain.{{domainPackage}},
                 path,
                 queryParams: options.GetParams(),
diff --git a/src/main/resources/twilio-csharp/resource/ReadResource.mustache b/src/main/resources/twilio-csharp/resource/ReadResource.mustache
@@ -3,7 +3,7 @@
         {
             {{>resource/GeneratePath}}
             return new Request(
-                HttpMethod.Get,
+                {{vendorExtensions.x-http-method}},
                 Rest.Domain.{{domainPackage}},
                 path,
                 queryParams: options.GetParams(),
diff --git a/src/main/resources/twilio-csharp/resource/UpdateResource.mustache b/src/main/resources/twilio-csharp/resource/UpdateResource.mustache
@@ -3,7 +3,7 @@
         {
             {{>resource/GeneratePath}}
             return new Request(
-                HttpMethod.Post,
+                {{vendorExtensions.x-http-method}},
                 Rest.Domain.{{domainPackage}},
                 path,
                 {{^vendorExtensions.x-is-json}}
diff --git a/src/main/resources/twilio-java/creator.mustache b/src/main/resources/twilio-java/creator.mustache
@@ -81,7 +81,7 @@ public class {{apiName}}Creator extends Creator<{{apiName}}>{
     public {{apiName}} create(final TwilioRestClient client){
 {{>generate_uri}}
         Request request = new Request(
-            HttpMethod.POST,
+            {{vendorExtensions.x-http-method}},
             Domains.{{#lambda.uppercase}}{{domainName}}{{/lambda.uppercase}}.toString(),
             path
         );
diff --git a/src/main/resources/twilio-java/deleter.mustache b/src/main/resources/twilio-java/deleter.mustache
@@ -74,7 +74,7 @@ public class {{apiName}}Deleter extends Deleter<{{apiName}}> {
     public boolean delete(final TwilioRestClient client) {
 {{>generate_uri}}
         Request request = new Request(
-            HttpMethod.DELETE,
+            {{vendorExtensions.x-http-method}},
             Domains.{{#lambda.uppercase}}{{domainName}}{{/lambda.uppercase}}.toString(),
             path
         );
diff --git a/src/main/resources/twilio-java/fetcher.mustache b/src/main/resources/twilio-java/fetcher.mustache
@@ -75,7 +75,7 @@ public class {{apiName}}Fetcher extends Fetcher<{{apiName}}> {
     public {{apiName}} fetch(final TwilioRestClient client) {
 {{>generate_uri}}
         Request request = new Request(
-            HttpMethod.GET,
+            {{vendorExtensions.x-http-method}},
             Domains.{{#lambda.uppercase}}{{domainName}}{{/lambda.uppercase}}.toString(),
             path
         );
diff --git a/src/main/resources/twilio-java/reader.mustache b/src/main/resources/twilio-java/reader.mustache
@@ -90,7 +90,7 @@ public class {{apiName}}Reader extends Reader<{{apiName}}> {
         {{/requiredParams}}
 
         Request request = new Request(
-            HttpMethod.GET,
+            {{vendorExtensions.x-http-method}},
             Domains.{{#lambda.uppercase}}{{domainName}}{{/lambda.uppercase}}.toString(),
             path
         );
@@ -132,7 +132,7 @@ public class {{apiName}}Reader extends Reader<{{apiName}}> {
     @Override
     public Page<{{apiName}}> previousPage(final Page<{{apiName}}> page, final TwilioRestClient client) {
         Request request = new Request(
-            HttpMethod.GET,
+            {{vendorExtensions.x-http-method}},
             page.getPreviousPageUrl(Domains.{{#lambda.uppercase}}{{domainName}}{{/lambda.uppercase}}.toString())
         );
         return pageForRequest(client, request);
@@ -142,7 +142,7 @@ public class {{apiName}}Reader extends Reader<{{apiName}}> {
     @Override
     public Page<{{apiName}}> nextPage(final Page<{{apiName}}> page, final TwilioRestClient client) {
         Request request = new Request(
-            HttpMethod.GET,
+            {{vendorExtensions.x-http-method}},
             page.getNextPageUrl(Domains.{{#lambda.uppercase}}{{domainName}}{{/lambda.uppercase}}.toString())
         );
         return pageForRequest(client, request);
diff --git a/src/main/resources/twilio-java/updater.mustache b/src/main/resources/twilio-java/updater.mustache
@@ -75,7 +75,7 @@ public class {{apiName}}Updater extends Updater<{{apiName}}>{
     public {{apiName}} update(final TwilioRestClient client){
 {{>generate_uri}}
         Request request = new Request(
-            HttpMethod.POST,
+            {{vendorExtensions.x-http-method}},
             Domains.{{#lambda.uppercase}}{{domainName}}{{/lambda.uppercase}}.toString(),
             path
         );
diff --git a/src/main/resources/twilio-php/listRead.mustache b/src/main/resources/twilio-php/listRead.mustache
@@ -94,7 +94,7 @@
             'PageSize' => $pageSize,
         ]);
 
-        $response = $this->version->page('GET', $this->uri, $params);
+        $response = $this->version->page('{{httpMethod}}', $this->uri, $params);
 
         return new {{apiName}}Page($this->version, $response, $this->solution);
     }
@@ -109,7 +109,7 @@
     public function getPage(string $targetUrl): {{apiName}}Page
     {
         $response = $this->version->getDomain()->getClient()->request(
-            'GET',
+            '{{httpMethod}}',
             $targetUrl
         );
 
diff --git a/src/main/resources/twilio-python/context.handlebars b/src/main/resources/twilio-python/context.handlebars
diff --git a/src/main/resources/twilio-python/listOperations.handlebars b/src/main/resources/twilio-python/listOperations.handlebars
diff --git a/src/main/resources/twilio-ruby/list.mustache b/src/main/resources/twilio-ruby/list.mustache

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`{`
`4`	`4`	`{{>resource/GeneratePath}}`
`5`	`5`	`return new Request(`
`6`		`- HttpMethod.Post,`
	`6`	`+ {{vendorExtensions.x-http-method}},`
`7`	`7`	`Rest.Domain.{{domainPackage}},`
`8`	`8`	`path,`
`9`	`9`	`{{^vendorExtensions.x-is-json}}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`{`
`8`	`8`	`{{>resource/GeneratePath}}`
`9`	`9`	`return new Request(`
`10`		`- HttpMethod.Delete,`
	`10`	`+ {{vendorExtensions.x-http-method}},`
`11`	`11`	`Rest.Domain.{{domainPackage}},`
`12`	`12`	`path,`
`13`	`13`	`queryParams: options.GetParams(),`