|
| 1 | +// File generated from our OpenAPI spec by Stainless. |
| 2 | + |
| 3 | +package com.withorb.api.models |
| 4 | + |
| 5 | +import com.withorb.api.core.JsonValue |
| 6 | +import com.withorb.api.core.Params |
| 7 | +import com.withorb.api.core.http.Headers |
| 8 | +import com.withorb.api.core.http.QueryParams |
| 9 | +import com.withorb.api.core.toImmutable |
| 10 | +import java.util.Objects |
| 11 | +import java.util.Optional |
| 12 | +import kotlin.jvm.optionals.getOrNull |
| 13 | + |
| 14 | +/** |
| 15 | + * This endpoint deletes a credit block by its ID. |
| 16 | + * |
| 17 | + * When a credit block is deleted: |
| 18 | + * - The block is removed from the customer's credit ledger. |
| 19 | + * - Any usage of the credit block is reversed, and the ledger is replayed as if the block never |
| 20 | + * existed. |
| 21 | + * - If invoices were generated from the purchase of the credit block, they will be deleted if in |
| 22 | + * draft status, voided if issued, or a credit note will be issued if the invoice is paid. |
| 23 | + * |
| 24 | + * <Note> Issued invoices that had credits applied from this block will not be regenerated, but the |
| 25 | + * ledger will reflect the state as if credits from the deleted block were never applied. </Note> |
| 26 | + */ |
| 27 | +class CreditBlockDeleteParams |
| 28 | +private constructor( |
| 29 | + private val blockId: String?, |
| 30 | + private val additionalHeaders: Headers, |
| 31 | + private val additionalQueryParams: QueryParams, |
| 32 | + private val additionalBodyProperties: Map<String, JsonValue>, |
| 33 | +) : Params { |
| 34 | + |
| 35 | + fun blockId(): Optional<String> = Optional.ofNullable(blockId) |
| 36 | + |
| 37 | + /** Additional body properties to send with the request. */ |
| 38 | + fun _additionalBodyProperties(): Map<String, JsonValue> = additionalBodyProperties |
| 39 | + |
| 40 | + /** Additional headers to send with the request. */ |
| 41 | + fun _additionalHeaders(): Headers = additionalHeaders |
| 42 | + |
| 43 | + /** Additional query param to send with the request. */ |
| 44 | + fun _additionalQueryParams(): QueryParams = additionalQueryParams |
| 45 | + |
| 46 | + fun toBuilder() = Builder().from(this) |
| 47 | + |
| 48 | + companion object { |
| 49 | + |
| 50 | + @JvmStatic fun none(): CreditBlockDeleteParams = builder().build() |
| 51 | + |
| 52 | + /** Returns a mutable builder for constructing an instance of [CreditBlockDeleteParams]. */ |
| 53 | + @JvmStatic fun builder() = Builder() |
| 54 | + } |
| 55 | + |
| 56 | + /** A builder for [CreditBlockDeleteParams]. */ |
| 57 | + class Builder internal constructor() { |
| 58 | + |
| 59 | + private var blockId: String? = null |
| 60 | + private var additionalHeaders: Headers.Builder = Headers.builder() |
| 61 | + private var additionalQueryParams: QueryParams.Builder = QueryParams.builder() |
| 62 | + private var additionalBodyProperties: MutableMap<String, JsonValue> = mutableMapOf() |
| 63 | + |
| 64 | + @JvmSynthetic |
| 65 | + internal fun from(creditBlockDeleteParams: CreditBlockDeleteParams) = apply { |
| 66 | + blockId = creditBlockDeleteParams.blockId |
| 67 | + additionalHeaders = creditBlockDeleteParams.additionalHeaders.toBuilder() |
| 68 | + additionalQueryParams = creditBlockDeleteParams.additionalQueryParams.toBuilder() |
| 69 | + additionalBodyProperties = |
| 70 | + creditBlockDeleteParams.additionalBodyProperties.toMutableMap() |
| 71 | + } |
| 72 | + |
| 73 | + fun blockId(blockId: String?) = apply { this.blockId = blockId } |
| 74 | + |
| 75 | + /** Alias for calling [Builder.blockId] with `blockId.orElse(null)`. */ |
| 76 | + fun blockId(blockId: Optional<String>) = blockId(blockId.getOrNull()) |
| 77 | + |
| 78 | + fun additionalHeaders(additionalHeaders: Headers) = apply { |
| 79 | + this.additionalHeaders.clear() |
| 80 | + putAllAdditionalHeaders(additionalHeaders) |
| 81 | + } |
| 82 | + |
| 83 | + fun additionalHeaders(additionalHeaders: Map<String, Iterable<String>>) = apply { |
| 84 | + this.additionalHeaders.clear() |
| 85 | + putAllAdditionalHeaders(additionalHeaders) |
| 86 | + } |
| 87 | + |
| 88 | + fun putAdditionalHeader(name: String, value: String) = apply { |
| 89 | + additionalHeaders.put(name, value) |
| 90 | + } |
| 91 | + |
| 92 | + fun putAdditionalHeaders(name: String, values: Iterable<String>) = apply { |
| 93 | + additionalHeaders.put(name, values) |
| 94 | + } |
| 95 | + |
| 96 | + fun putAllAdditionalHeaders(additionalHeaders: Headers) = apply { |
| 97 | + this.additionalHeaders.putAll(additionalHeaders) |
| 98 | + } |
| 99 | + |
| 100 | + fun putAllAdditionalHeaders(additionalHeaders: Map<String, Iterable<String>>) = apply { |
| 101 | + this.additionalHeaders.putAll(additionalHeaders) |
| 102 | + } |
| 103 | + |
| 104 | + fun replaceAdditionalHeaders(name: String, value: String) = apply { |
| 105 | + additionalHeaders.replace(name, value) |
| 106 | + } |
| 107 | + |
| 108 | + fun replaceAdditionalHeaders(name: String, values: Iterable<String>) = apply { |
| 109 | + additionalHeaders.replace(name, values) |
| 110 | + } |
| 111 | + |
| 112 | + fun replaceAllAdditionalHeaders(additionalHeaders: Headers) = apply { |
| 113 | + this.additionalHeaders.replaceAll(additionalHeaders) |
| 114 | + } |
| 115 | + |
| 116 | + fun replaceAllAdditionalHeaders(additionalHeaders: Map<String, Iterable<String>>) = apply { |
| 117 | + this.additionalHeaders.replaceAll(additionalHeaders) |
| 118 | + } |
| 119 | + |
| 120 | + fun removeAdditionalHeaders(name: String) = apply { additionalHeaders.remove(name) } |
| 121 | + |
| 122 | + fun removeAllAdditionalHeaders(names: Set<String>) = apply { |
| 123 | + additionalHeaders.removeAll(names) |
| 124 | + } |
| 125 | + |
| 126 | + fun additionalQueryParams(additionalQueryParams: QueryParams) = apply { |
| 127 | + this.additionalQueryParams.clear() |
| 128 | + putAllAdditionalQueryParams(additionalQueryParams) |
| 129 | + } |
| 130 | + |
| 131 | + fun additionalQueryParams(additionalQueryParams: Map<String, Iterable<String>>) = apply { |
| 132 | + this.additionalQueryParams.clear() |
| 133 | + putAllAdditionalQueryParams(additionalQueryParams) |
| 134 | + } |
| 135 | + |
| 136 | + fun putAdditionalQueryParam(key: String, value: String) = apply { |
| 137 | + additionalQueryParams.put(key, value) |
| 138 | + } |
| 139 | + |
| 140 | + fun putAdditionalQueryParams(key: String, values: Iterable<String>) = apply { |
| 141 | + additionalQueryParams.put(key, values) |
| 142 | + } |
| 143 | + |
| 144 | + fun putAllAdditionalQueryParams(additionalQueryParams: QueryParams) = apply { |
| 145 | + this.additionalQueryParams.putAll(additionalQueryParams) |
| 146 | + } |
| 147 | + |
| 148 | + fun putAllAdditionalQueryParams(additionalQueryParams: Map<String, Iterable<String>>) = |
| 149 | + apply { |
| 150 | + this.additionalQueryParams.putAll(additionalQueryParams) |
| 151 | + } |
| 152 | + |
| 153 | + fun replaceAdditionalQueryParams(key: String, value: String) = apply { |
| 154 | + additionalQueryParams.replace(key, value) |
| 155 | + } |
| 156 | + |
| 157 | + fun replaceAdditionalQueryParams(key: String, values: Iterable<String>) = apply { |
| 158 | + additionalQueryParams.replace(key, values) |
| 159 | + } |
| 160 | + |
| 161 | + fun replaceAllAdditionalQueryParams(additionalQueryParams: QueryParams) = apply { |
| 162 | + this.additionalQueryParams.replaceAll(additionalQueryParams) |
| 163 | + } |
| 164 | + |
| 165 | + fun replaceAllAdditionalQueryParams(additionalQueryParams: Map<String, Iterable<String>>) = |
| 166 | + apply { |
| 167 | + this.additionalQueryParams.replaceAll(additionalQueryParams) |
| 168 | + } |
| 169 | + |
| 170 | + fun removeAdditionalQueryParams(key: String) = apply { additionalQueryParams.remove(key) } |
| 171 | + |
| 172 | + fun removeAllAdditionalQueryParams(keys: Set<String>) = apply { |
| 173 | + additionalQueryParams.removeAll(keys) |
| 174 | + } |
| 175 | + |
| 176 | + fun additionalBodyProperties(additionalBodyProperties: Map<String, JsonValue>) = apply { |
| 177 | + this.additionalBodyProperties.clear() |
| 178 | + putAllAdditionalBodyProperties(additionalBodyProperties) |
| 179 | + } |
| 180 | + |
| 181 | + fun putAdditionalBodyProperty(key: String, value: JsonValue) = apply { |
| 182 | + additionalBodyProperties.put(key, value) |
| 183 | + } |
| 184 | + |
| 185 | + fun putAllAdditionalBodyProperties(additionalBodyProperties: Map<String, JsonValue>) = |
| 186 | + apply { |
| 187 | + this.additionalBodyProperties.putAll(additionalBodyProperties) |
| 188 | + } |
| 189 | + |
| 190 | + fun removeAdditionalBodyProperty(key: String) = apply { |
| 191 | + additionalBodyProperties.remove(key) |
| 192 | + } |
| 193 | + |
| 194 | + fun removeAllAdditionalBodyProperties(keys: Set<String>) = apply { |
| 195 | + keys.forEach(::removeAdditionalBodyProperty) |
| 196 | + } |
| 197 | + |
| 198 | + /** |
| 199 | + * Returns an immutable instance of [CreditBlockDeleteParams]. |
| 200 | + * |
| 201 | + * Further updates to this [Builder] will not mutate the returned instance. |
| 202 | + */ |
| 203 | + fun build(): CreditBlockDeleteParams = |
| 204 | + CreditBlockDeleteParams( |
| 205 | + blockId, |
| 206 | + additionalHeaders.build(), |
| 207 | + additionalQueryParams.build(), |
| 208 | + additionalBodyProperties.toImmutable(), |
| 209 | + ) |
| 210 | + } |
| 211 | + |
| 212 | + fun _body(): Optional<Map<String, JsonValue>> = |
| 213 | + Optional.ofNullable(additionalBodyProperties.ifEmpty { null }) |
| 214 | + |
| 215 | + fun _pathParam(index: Int): String = |
| 216 | + when (index) { |
| 217 | + 0 -> blockId ?: "" |
| 218 | + else -> "" |
| 219 | + } |
| 220 | + |
| 221 | + override fun _headers(): Headers = additionalHeaders |
| 222 | + |
| 223 | + override fun _queryParams(): QueryParams = additionalQueryParams |
| 224 | + |
| 225 | + override fun equals(other: Any?): Boolean { |
| 226 | + if (this === other) { |
| 227 | + return true |
| 228 | + } |
| 229 | + |
| 230 | + return other is CreditBlockDeleteParams && |
| 231 | + blockId == other.blockId && |
| 232 | + additionalHeaders == other.additionalHeaders && |
| 233 | + additionalQueryParams == other.additionalQueryParams && |
| 234 | + additionalBodyProperties == other.additionalBodyProperties |
| 235 | + } |
| 236 | + |
| 237 | + override fun hashCode(): Int = |
| 238 | + Objects.hash(blockId, additionalHeaders, additionalQueryParams, additionalBodyProperties) |
| 239 | + |
| 240 | + override fun toString() = |
| 241 | + "CreditBlockDeleteParams{blockId=$blockId, additionalHeaders=$additionalHeaders, additionalQueryParams=$additionalQueryParams, additionalBodyProperties=$additionalBodyProperties}" |
| 242 | +} |
![stainless-app[bot]](https://avatars.githubusercontent.com/in/378072?v=4&size=40){kind=avatar}
0 commit comments