From 353927580de6b861ed7a105f657e0940db4005ec Mon Sep 17 00:00:00 2001
From: "Erik C. Thauvin" <erik@thauvin.net>
Date: Tue, 3 Mar 2020 21:54:24 -0800
Subject: [PATCH] Added CallResponse docs.

---
 .gitignore                                    |  1 -
 .idea/codeStyles/codeStyleConfig.xml          |  5 ++++
 .idea/jarRepositories.xml                     |  5 ++++
 .idea/misc.xml                                |  3 +++
 .../-bitlinks/update.md                       | 20 ++++++++++++++
 .../-call-response/-init-.md                  |  8 ++++++
 .../-call-response/body.md                    |  5 ++++
 .../-call-response/index.md                   | 27 +++++++++++++++++++
 .../-call-response/is-successful.md           |  5 ++++
 .../-call-response/result-code.md             |  5 ++++
 .../-call-response/to-json.md                 |  5 ++++
 .../-constants/-f-a-l-s-e.md                  | 11 ++++++++
 .../-constants/-t-r-u-e.md                    | 11 ++++++++
 13 files changed, 110 insertions(+), 1 deletion(-)
 create mode 100644 .idea/codeStyles/codeStyleConfig.xml
 create mode 100644 docs/net.thauvin.erik.bitly/-bitlinks/update.md
 create mode 100644 docs/net.thauvin.erik.bitly/-call-response/-init-.md
 create mode 100644 docs/net.thauvin.erik.bitly/-call-response/body.md
 create mode 100644 docs/net.thauvin.erik.bitly/-call-response/index.md
 create mode 100644 docs/net.thauvin.erik.bitly/-call-response/is-successful.md
 create mode 100644 docs/net.thauvin.erik.bitly/-call-response/result-code.md
 create mode 100644 docs/net.thauvin.erik.bitly/-call-response/to-json.md
 create mode 100644 docs/net.thauvin.erik.bitly/-constants/-f-a-l-s-e.md
 create mode 100644 docs/net.thauvin.erik.bitly/-constants/-t-r-u-e.md

diff --git a/.gitignore b/.gitignore
index f007981..e9a64e1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,7 +3,6 @@
 !.vscode/launch.json
 !.vscode/settings.json
 !.vscode/tasks.json
-
 __pycache__
 .classpath
 .DS_Store
diff --git a/.idea/codeStyles/codeStyleConfig.xml b/.idea/codeStyles/codeStyleConfig.xml
new file mode 100644
index 0000000..d91f848
--- /dev/null
+++ b/.idea/codeStyles/codeStyleConfig.xml
@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="PREFERRED_PROJECT_CODE_STYLE" value="Erik's Code Style" />
+  </state>
+</component>
\ No newline at end of file
diff --git a/.idea/jarRepositories.xml b/.idea/jarRepositories.xml
index bc24525..c92108f 100644
--- a/.idea/jarRepositories.xml
+++ b/.idea/jarRepositories.xml
@@ -26,5 +26,10 @@
       <option name="name" value="MavenRepo" />
       <option name="url" value="https://repo.maven.apache.org/maven2/" />
     </remote-repository>
+    <remote-repository>
+      <option name="id" value="MavenLocal" />
+      <option name="name" value="MavenLocal" />
+      <option name="url" value="file:/K:/maven/repository/" />
+    </remote-repository>
   </component>
 </project>
\ No newline at end of file
diff --git a/.idea/misc.xml b/.idea/misc.xml
index f2d0337..9540c66 100644
--- a/.idea/misc.xml
+++ b/.idea/misc.xml
@@ -9,6 +9,9 @@
   <component name="FrameworkDetectionExcludesConfiguration">
     <file type="web" url="file://$PROJECT_DIR$" />
   </component>
+  <component name="JavaScriptSettings">
+    <option name="languageLevel" value="ES6" />
+  </component>
   <component name="ProjectRootManager" version="2" languageLevel="JDK_13" project-jdk-name="13" project-jdk-type="JavaSDK">
     <output url="file://$PROJECT_DIR$/build/classes" />
   </component>
diff --git a/docs/net.thauvin.erik.bitly/-bitlinks/update.md b/docs/net.thauvin.erik.bitly/-bitlinks/update.md
new file mode 100644
index 0000000..169f21b
--- /dev/null
+++ b/docs/net.thauvin.erik.bitly/-bitlinks/update.md
@@ -0,0 +1,20 @@
+[docs](../../index.md) / [net.thauvin.erik.bitly](../index.md) / [Bitlinks](index.md) / [update](./update.md)
+
+# update
+
+`@JvmOverloads fun update(bitlink: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, references: `[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`> = emptyMap(), archived: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false, tags: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`> = emptyArray(), created_at: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = Constants.EMPTY, title: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = Constants.EMPTY, deeplinks: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`Map`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`>> = emptyArray(), created_by: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = Constants.EMPTY, long_url: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = Constants.EMPTY, client_id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = Constants.EMPTY, custom_bitlinks: `[`Array`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)`<`[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`> = emptyArray(), link: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = Constants.EMPTY, id: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = Constants.EMPTY, toJson: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = false): `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/ethauvin/bitly-shorten/tree/master/src/main/kotlin/net/thauvin/erik/bitly/Bitlinks.kt#L222)
+
+Updates fields in the Bitlink.
+
+See the [Bit.ly API](https://dev.bitly.com/v4/#operation/updateBitlink) for more information.
+
+### Parameters
+
+`toJson` - Returns the full JSON response if `true`
+
+**Oaran**
+bitlink A Bitlink made of the domain and hash.
+
+**Return**
+`true` is the update was successful, `false` otherwise, or JSON response.
+
diff --git a/docs/net.thauvin.erik.bitly/-call-response/-init-.md b/docs/net.thauvin.erik.bitly/-call-response/-init-.md
new file mode 100644
index 0000000..d40e7c6
--- /dev/null
+++ b/docs/net.thauvin.erik.bitly/-call-response/-init-.md
@@ -0,0 +1,8 @@
+[docs](../../index.md) / [net.thauvin.erik.bitly](../index.md) / [CallResponse](index.md) / [&lt;init&gt;](./-init-.md)
+
+# &lt;init&gt;
+
+`CallResponse(body: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = Constants.EMPTY_JSON, resultCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = -1)`
+
+Provides a data class to hold the JSON response.
+
diff --git a/docs/net.thauvin.erik.bitly/-call-response/body.md b/docs/net.thauvin.erik.bitly/-call-response/body.md
new file mode 100644
index 0000000..c9bd5b9
--- /dev/null
+++ b/docs/net.thauvin.erik.bitly/-call-response/body.md
@@ -0,0 +1,5 @@
+[docs](../../index.md) / [net.thauvin.erik.bitly](../index.md) / [CallResponse](index.md) / [body](./body.md)
+
+# body
+
+`var body: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/ethauvin/bitly-shorten/tree/master/src/main/kotlin/net/thauvin/erik/bitly/CallResponse.kt#L40)
\ No newline at end of file
diff --git a/docs/net.thauvin.erik.bitly/-call-response/index.md b/docs/net.thauvin.erik.bitly/-call-response/index.md
new file mode 100644
index 0000000..db0dc84
--- /dev/null
+++ b/docs/net.thauvin.erik.bitly/-call-response/index.md
@@ -0,0 +1,27 @@
+[docs](../../index.md) / [net.thauvin.erik.bitly](../index.md) / [CallResponse](./index.md)
+
+# CallResponse
+
+`data class CallResponse` [(source)](https://github.com/ethauvin/bitly-shorten/tree/master/src/main/kotlin/net/thauvin/erik/bitly/CallResponse.kt#L40)
+
+Provides a data class to hold the JSON response.
+
+### Constructors
+
+| Name | Summary |
+|---|---|
+| [&lt;init&gt;](-init-.md) | Provides a data class to hold the JSON response.`CallResponse(body: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` = Constants.EMPTY_JSON, resultCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` = -1)` |
+
+### Properties
+
+| Name | Summary |
+|---|---|
+| [body](body.md) | `var body: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
+| [isSuccessful](is-successful.md) | `val isSuccessful: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) |
+| [resultCode](result-code.md) | `var resultCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) |
+
+### Functions
+
+| Name | Summary |
+|---|---|
+| [toJson](to-json.md) | `fun toJson(): JSONObject` |
diff --git a/docs/net.thauvin.erik.bitly/-call-response/is-successful.md b/docs/net.thauvin.erik.bitly/-call-response/is-successful.md
new file mode 100644
index 0000000..a93d2de
--- /dev/null
+++ b/docs/net.thauvin.erik.bitly/-call-response/is-successful.md
@@ -0,0 +1,5 @@
+[docs](../../index.md) / [net.thauvin.erik.bitly](../index.md) / [CallResponse](index.md) / [isSuccessful](./is-successful.md)
+
+# isSuccessful
+
+`val isSuccessful: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/ethauvin/bitly-shorten/tree/master/src/main/kotlin/net/thauvin/erik/bitly/CallResponse.kt#L41)
\ No newline at end of file
diff --git a/docs/net.thauvin.erik.bitly/-call-response/result-code.md b/docs/net.thauvin.erik.bitly/-call-response/result-code.md
new file mode 100644
index 0000000..17d20ee
--- /dev/null
+++ b/docs/net.thauvin.erik.bitly/-call-response/result-code.md
@@ -0,0 +1,5 @@
+[docs](../../index.md) / [net.thauvin.erik.bitly](../index.md) / [CallResponse](index.md) / [resultCode](./result-code.md)
+
+# resultCode
+
+`var resultCode: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) [(source)](https://github.com/ethauvin/bitly-shorten/tree/master/src/main/kotlin/net/thauvin/erik/bitly/CallResponse.kt#L40)
\ No newline at end of file
diff --git a/docs/net.thauvin.erik.bitly/-call-response/to-json.md b/docs/net.thauvin.erik.bitly/-call-response/to-json.md
new file mode 100644
index 0000000..dd05d24
--- /dev/null
+++ b/docs/net.thauvin.erik.bitly/-call-response/to-json.md
@@ -0,0 +1,5 @@
+[docs](../../index.md) / [net.thauvin.erik.bitly](../index.md) / [CallResponse](index.md) / [toJson](./to-json.md)
+
+# toJson
+
+`fun toJson(): JSONObject` [(source)](https://github.com/ethauvin/bitly-shorten/tree/master/src/main/kotlin/net/thauvin/erik/bitly/CallResponse.kt#L44)
\ No newline at end of file
diff --git a/docs/net.thauvin.erik.bitly/-constants/-f-a-l-s-e.md b/docs/net.thauvin.erik.bitly/-constants/-f-a-l-s-e.md
new file mode 100644
index 0000000..bff00e1
--- /dev/null
+++ b/docs/net.thauvin.erik.bitly/-constants/-f-a-l-s-e.md
@@ -0,0 +1,11 @@
+[docs](../../index.md) / [net.thauvin.erik.bitly](../index.md) / [Constants](index.md) / [FALSE](./-f-a-l-s-e.md)
+
+# FALSE
+
+`const val FALSE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/ethauvin/bitly-shorten/tree/master/src/main/kotlin/net/thauvin/erik/bitly/Constants.kt#L63)
+
+False
+
+**Value**
+`false`
+
diff --git a/docs/net.thauvin.erik.bitly/-constants/-t-r-u-e.md b/docs/net.thauvin.erik.bitly/-constants/-t-r-u-e.md
new file mode 100644
index 0000000..38eaaac
--- /dev/null
+++ b/docs/net.thauvin.erik.bitly/-constants/-t-r-u-e.md
@@ -0,0 +1,11 @@
+[docs](../../index.md) / [net.thauvin.erik.bitly](../index.md) / [Constants](index.md) / [TRUE](./-t-r-u-e.md)
+
+# TRUE
+
+`const val TRUE: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/ethauvin/bitly-shorten/tree/master/src/main/kotlin/net/thauvin/erik/bitly/Constants.kt#L70)
+
+True
+
+**Value**
+`true`
+