SWI-8856 Add OAuth

.openapi-generator/FILES

@@ -225,6 +225,10 @@ src/main/java/com/bandwidth/sdk/auth/ApiKeyAuth.java
 src/main/java/com/bandwidth/sdk/auth/Authentication.java
 src/main/java/com/bandwidth/sdk/auth/HttpBasicAuth.java
 src/main/java/com/bandwidth/sdk/auth/HttpBearerAuth.java
+src/main/java/com/bandwidth/sdk/auth/OAuth.java
+src/main/java/com/bandwidth/sdk/auth/OAuthFlow.java
+src/main/java/com/bandwidth/sdk/auth/OAuthOkHttpClient.java
+src/main/java/com/bandwidth/sdk/auth/RetryingOAuth.java
 src/main/java/com/bandwidth/sdk/model/AbstractOpenApiSchema.java
 src/main/java/com/bandwidth/sdk/model/AccountStatistics.java
 src/main/java/com/bandwidth/sdk/model/AdditionalDenialReason.java

README.md

@@ -98,6 +98,10 @@ public class Example {
     Basic.setUsername("YOUR USERNAME");
     Basic.setPassword("YOUR PASSWORD");
 
+    // Configure OAuth2 access token for authorization: OAuth2
+    OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
+    OAuth2.setAccessToken("YOUR ACCESS TOKEN");
+
     CallsApi apiInstance = new CallsApi(defaultClient);
     String accountId = "9900000"; // String | Your Bandwidth Account ID.
     CreateCall createCall = new CreateCall(); // CreateCall | JSON object containing information to create an outbound call
@@ -362,6 +366,14 @@ Authentication schemes defined for the API:
 
 - **Type**: HTTP basic authentication
 
+<a id="OAuth2"></a>
+### OAuth2
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: N/A
+
 
 ## Recommendation
 

api/openapi.yaml

@@ -11,6 +11,7 @@ servers:
 - url: /
 security:
 - Basic: []
+- OAuth2: []
 tags:
 - name: Messages
 - name: Media
@@ -14925,4 +14926,10 @@ components:
         - Example: `Authorization: Basic ZGVtbZpwQDU1dzByZA==`
       scheme: basic
       type: http
+    OAuth2:
+      flows:
+        clientCredentials:
+          scopes: {}
+          tokenUrl: https://api.bandwidth.com/api/v1/oauth2/token
+      type: oauth2
 

bandwidth.yml

@@ -9,6 +9,7 @@ info:
   version: 1.0.0
 security:
   - Basic: []
+  - OAuth2: []
 tags:
   - name: Messages
   - name: Media
@@ -8427,6 +8428,12 @@ components:
 
 
         - Example: `Authorization: Basic ZGVtbZpwQDU1dzByZA==`
+    OAuth2:
+      type: oauth2
+      flows:
+        clientCredentials:
+          tokenUrl: https://api.bandwidth.com/api/v1/oauth2/token
+          scopes: {}
   callbacks:
     inboundCallback:
       '{inboundCallbackUrl}':

build.gradle

@@ -113,6 +113,8 @@ dependencies {
     implementation 'io.gsonfire:gson-fire:1.9.0'
     implementation 'jakarta.ws.rs:jakarta.ws.rs-api:2.1.6'
     implementation 'org.openapitools:jackson-databind-nullable:0.2.8'
+    implementation group: 'org.json', name: 'json', version: '20250517'
+    implementation group: 'org.apache.oltu.oauth2', name: 'org.apache.oltu.oauth2.client', version: '1.0.2'
     implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.18.0'
     implementation "jakarta.annotation:jakarta.annotation-api:$jakarta_annotation_version"
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.3'

build.sbt

@@ -16,6 +16,8 @@ lazy val root = (project in file(".")).
       "org.apache.commons" % "commons-lang3" % "3.18.0",
       "jakarta.ws.rs" % "jakarta.ws.rs-api" % "2.1.6",
       "org.openapitools" % "jackson-databind-nullable" % "0.2.8",
+      "org.json" % "json" % "20250517",
+      "org.apache.oltu.oauth2" % "org.apache.oltu.oauth2.client" % "1.0.2",
       "io.gsonfire" % "gson-fire" % "1.9.0" % "compile",
       "jakarta.annotation" % "jakarta.annotation-api" % "1.3.5" % "compile",
       "com.google.code.findbugs" % "jsr305" % "3.0.2" % "compile",

custom_templates/build.gradle.mustache

@@ -0,0 +1,203 @@
+apply plugin: 'idea'
+apply plugin: 'eclipse'
+{{#sourceFolder}}
+apply plugin: 'java'
+{{/sourceFolder}}
+apply plugin: 'com.diffplug.spotless'
+
+group = '{{groupId}}'
+version = '{{artifactVersion}}'
+
+buildscript {
+    repositories {
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:2.3.+'
+        classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1'
+        classpath 'com.diffplug.spotless:spotless-plugin-gradle:6.11.0'
+    }
+}
+
+repositories {
+    mavenCentral()
+}
+{{#sourceFolder}}
+sourceSets {
+    main.java.srcDirs = ['{{sourceFolder}}']
+}
+
+{{/sourceFolder}}
+if(hasProperty('target') && target == 'android') {
+
+    apply plugin: 'com.android.library'
+    apply plugin: 'com.github.dcendents.android-maven'
+
+    android {
+        compileSdkVersion 25
+        buildToolsVersion '25.0.2'
+        defaultConfig {
+            minSdkVersion 14
+            targetSdkVersion 25
+        }
+        compileOptions {
+            sourceCompatibility JavaVersion.VERSION_1_8
+            targetCompatibility JavaVersion.VERSION_1_8
+        }
+
+        // Rename the aar correctly
+        libraryVariants.all { variant ->
+            variant.outputs.each { output ->
+                def outputFile = output.outputFile
+                if (outputFile != null && outputFile.name.endsWith('.aar')) {
+                    def fileName = "${project.name}-${variant.baseName}-${version}.aar"
+                    output.outputFile = new File(outputFile.parent, fileName)
+                }
+            }
+        }
+
+        dependencies {
+            provided "jakarta.annotation:jakarta.annotation-api:$jakarta_annotation_version"
+        }
+    }
+
+    afterEvaluate {
+        android.libraryVariants.all { variant ->
+            def task = project.tasks.create "jar${variant.name.capitalize()}", Jar
+            task.description = "Create jar artifact for ${variant.name}"
+            task.dependsOn variant.javaCompile
+            task.from variant.javaCompile.destinationDirectory
+            task.destinationDirectory = project.file("${project.buildDir}/outputs/jar")
+            task.archiveFileName = "${project.name}-${variant.baseName}-${version}.jar"
+            artifacts.add('archives', task)
+        }
+    }
+
+    task sourcesJar(type: Jar) {
+        from android.sourceSets.main.java.srcDirs
+        classifier = 'sources'
+    }
+
+    artifacts {
+        archives sourcesJar
+    }
+
+} else {
+
+    apply plugin: 'java'
+    apply plugin: 'maven-publish'
+
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
+
+    publishing {
+        publications {
+            maven(MavenPublication) {
+               artifactId = '{{artifactId}}'
+               from components.java
+            }
+        }
+    }
+
+    task execute(type:JavaExec) {
+       main = System.getProperty('mainClass')
+       classpath = sourceSets.main.runtimeClasspath
+    }
+}
+
+ext {
+    {{#swagger1AnnotationLibrary}}
+    swagger_annotations_version = "1.6.9"
+    {{/swagger1AnnotationLibrary}}
+    {{#swagger2AnnotationLibrary}}
+    swagger_annotations_version = "2.2.9"
+    {{/swagger2AnnotationLibrary}}
+    jakarta_annotation_version = "1.3.5"
+    {{#useBeanValidation}}
+    bean_validation_version = "2.0.2"
+    {{/useBeanValidation}}
+}
+
+dependencies {
+    {{#swagger1AnnotationLibrary}}
+    implementation "io.swagger:swagger-annotations:$swagger_annotations_version"
+    {{/swagger1AnnotationLibrary}}
+    {{#swagger2AnnotationLibrary}}
+    implementation "io.swagger.core.v3:swagger-annotations:$swagger_annotations_version"
+    {{/swagger2AnnotationLibrary}}
+    implementation "com.google.code.findbugs:jsr305:3.0.2"
+    implementation 'com.squareup.okhttp3:okhttp:4.12.0'
+    implementation 'com.squareup.okhttp3:logging-interceptor:4.12.0'
+    implementation 'com.google.code.gson:gson:2.9.1'
+    implementation 'io.gsonfire:gson-fire:1.9.0'
+    implementation 'jakarta.ws.rs:jakarta.ws.rs-api:2.1.6'
+    {{#openApiNullable}}
+    implementation 'org.openapitools:jackson-databind-nullable:0.2.8'
+    {{/openApiNullable}}
+    {{#withAWSV4Signature}}
+    implementation 'software.amazon.awssdk:auth:2.20.157'
+    {{/withAWSV4Signature}}
+    {{#hasOAuthMethods}}
+    implementation group: 'org.json', name: 'json', version: '20250517'
+    implementation group: 'org.apache.oltu.oauth2', name: 'org.apache.oltu.oauth2.client', version: '1.0.2'
+    {{/hasOAuthMethods}}
+    implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.18.0'
+    {{#joda}}
+    implementation 'joda-time:joda-time:2.9.9'
+    {{/joda}}
+    {{#dynamicOperations}}
+    implementation 'io.swagger.parser.v3:swagger-parser-v3:2.0.30'
+    {{/dynamicOperations}}
+    implementation "jakarta.annotation:jakarta.annotation-api:$jakarta_annotation_version"
+    {{#useBeanValidation}}
+    implementation "jakarta.validation:jakarta.validation-api:$bean_validation_version"
+    {{/useBeanValidation}}
+    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.3'
+    testImplementation 'org.mockito:mockito-core:3.12.4'
+    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.10.3'
+}
+
+javadoc {
+    options.tags = [ "http.response.details:a:Http Response Details" ]
+}
+
+// Use spotless plugin to automatically format code, remove unused import, etc
+// To apply changes directly to the file, run `gradlew spotlessApply`
+// Ref: https://github.com/diffplug/spotless/tree/main/plugin-gradle
+spotless {
+    // comment out below to run spotless as part of the `check` task
+    enforceCheck false
+
+    format 'misc', {
+        // define the files (e.g. '*.gradle', '*.md') to apply `misc` to
+        target '.gitignore'
+
+        // define the steps to apply to those files
+        trimTrailingWhitespace()
+        indentWithSpaces() // Takes an integer argument if you don't like 4
+        endWithNewline()
+    }
+    java {
+        // don't need to set target, it is inferred from java
+
+        // apply a specific flavor of google-java-format
+        googleJavaFormat('1.8').aosp().reflowLongStrings()
+
+        removeUnusedImports()
+        importOrder()
+    }
+}
+
+test {
+    // Enable JUnit 5 (Gradle 4.6+).
+    useJUnitPlatform()
+
+    // Always run tests, even when nothing changed.
+    dependsOn 'cleanTest'
+
+    // Show test results.
+    testLogging {
+        events "passed", "skipped", "failed"
+    }
+
+}

custom_templates/build.sbt.mustache

@@ -0,0 +1,42 @@
+lazy val root = (project in file(".")).
+  settings(
+    organization := "{{groupId}}",
+    name := "{{artifactId}}",
+    version := "{{artifactVersion}}",
+    scalaVersion := "2.11.12",
+    scalacOptions ++= Seq("-feature"),
+    compile / javacOptions ++= Seq("-Xlint:deprecation"),
+    Compile / packageDoc / publishArtifact := false,
+    resolvers += Resolver.mavenLocal,
+    libraryDependencies ++= Seq(
+      "io.swagger" % "swagger-annotations" % "1.6.5",
+      "com.squareup.okhttp3" % "okhttp" % "4.12.0",
+      "com.squareup.okhttp3" % "logging-interceptor" % "4.12.0",
+      "com.google.code.gson" % "gson" % "2.9.1",
+      "org.apache.commons" % "commons-lang3" % "3.18.0",
+      "jakarta.ws.rs" % "jakarta.ws.rs-api" % "2.1.6",
+      {{#openApiNullable}}
+      "org.openapitools" % "jackson-databind-nullable" % "0.2.8",
+      {{/openApiNullable}}
+      {{#withAWSV4Signature}}
+      "software.amazon.awssdk" % "auth" % "2.20.157",
+      {{/withAWSV4Signature}}
+      {{#hasOAuthMethods}}
+      "org.json" % "json" % "20250517",
+      "org.apache.oltu.oauth2" % "org.apache.oltu.oauth2.client" % "1.0.2",
+      {{/hasOAuthMethods}}
+      {{#joda}}
+      "joda-time" % "joda-time" % "2.9.9" % "compile",
+      {{/joda}}
+      {{#dynamicOperations}}
+      "io.swagger.parser.v3" % "swagger-parser-v3" "2.0.30" % "compile"
+      {{/dynamicOperations}}
+      "io.gsonfire" % "gson-fire" % "1.9.0" % "compile",
+      "jakarta.annotation" % "jakarta.annotation-api" % "1.3.5" % "compile",
+      "com.google.code.findbugs" % "jsr305" % "3.0.2" % "compile",
+      "jakarta.annotation" % "jakarta.annotation-api" % "1.3.5" % "compile",
+      "org.junit.jupiter" % "junit-jupiter-api" % "5.10.3" % "test",
+      "com.novocode" % "junit-interface" % "0.10" % "test",
+      "org.mockito" % "mockito-core" % "3.12.4" % "test"
+    )
+  )