|
| 1 | +// File generated from our OpenAPI spec by Stainless. |
| 2 | + |
| 3 | +package io.imagekit.models.accounts.contract |
| 4 | + |
| 5 | +import io.imagekit.core.Params |
| 6 | +import io.imagekit.core.http.Headers |
| 7 | +import io.imagekit.core.http.QueryParams |
| 8 | +import java.util.Objects |
| 9 | + |
| 10 | +/** |
| 11 | + * Get the account's contract terms and the usage consumed against them in the current contract |
| 12 | + * term. Bandwidth is in bytes; video processing units, extension units and purge cache requests are |
| 13 | + * counts. |
| 14 | + * |
| 15 | + * For an agency account, consumption includes the child accounts billed to it. A child account |
| 16 | + * billed to its parent cannot call this endpoint; call it with the parent account's credentials |
| 17 | + * instead. |
| 18 | + * |
| 19 | + * Contract terms are read live; consumption is refreshed periodically, not on every request. Use |
| 20 | + * `asOf` to check how fresh it is. Contracts of one month or less are reported as `hasContract: |
| 21 | + * false`. The response is cached for 5 minutes per account. |
| 22 | + * |
| 23 | + * Requires an API key with account management access. |
| 24 | + */ |
| 25 | +class ContractGetParams |
| 26 | +private constructor( |
| 27 | + private val additionalHeaders: Headers, |
| 28 | + private val additionalQueryParams: QueryParams, |
| 29 | +) : Params { |
| 30 | + |
| 31 | + /** Additional headers to send with the request. */ |
| 32 | + fun _additionalHeaders(): Headers = additionalHeaders |
| 33 | + |
| 34 | + /** Additional query param to send with the request. */ |
| 35 | + fun _additionalQueryParams(): QueryParams = additionalQueryParams |
| 36 | + |
| 37 | + fun toBuilder() = Builder().from(this) |
| 38 | + |
| 39 | + companion object { |
| 40 | + |
| 41 | + @JvmStatic fun none(): ContractGetParams = builder().build() |
| 42 | + |
| 43 | + /** Returns a mutable builder for constructing an instance of [ContractGetParams]. */ |
| 44 | + @JvmStatic fun builder() = Builder() |
| 45 | + } |
| 46 | + |
| 47 | + /** A builder for [ContractGetParams]. */ |
| 48 | + class Builder internal constructor() { |
| 49 | + |
| 50 | + private var additionalHeaders: Headers.Builder = Headers.builder() |
| 51 | + private var additionalQueryParams: QueryParams.Builder = QueryParams.builder() |
| 52 | + |
| 53 | + @JvmSynthetic |
| 54 | + internal fun from(contractGetParams: ContractGetParams) = apply { |
| 55 | + additionalHeaders = contractGetParams.additionalHeaders.toBuilder() |
| 56 | + additionalQueryParams = contractGetParams.additionalQueryParams.toBuilder() |
| 57 | + } |
| 58 | + |
| 59 | + fun additionalHeaders(additionalHeaders: Headers) = apply { |
| 60 | + this.additionalHeaders.clear() |
| 61 | + putAllAdditionalHeaders(additionalHeaders) |
| 62 | + } |
| 63 | + |
| 64 | + fun additionalHeaders(additionalHeaders: Map<String, Iterable<String>>) = apply { |
| 65 | + this.additionalHeaders.clear() |
| 66 | + putAllAdditionalHeaders(additionalHeaders) |
| 67 | + } |
| 68 | + |
| 69 | + fun putAdditionalHeader(name: String, value: String) = apply { |
| 70 | + additionalHeaders.put(name, value) |
| 71 | + } |
| 72 | + |
| 73 | + fun putAdditionalHeaders(name: String, values: Iterable<String>) = apply { |
| 74 | + additionalHeaders.put(name, values) |
| 75 | + } |
| 76 | + |
| 77 | + fun putAllAdditionalHeaders(additionalHeaders: Headers) = apply { |
| 78 | + this.additionalHeaders.putAll(additionalHeaders) |
| 79 | + } |
| 80 | + |
| 81 | + fun putAllAdditionalHeaders(additionalHeaders: Map<String, Iterable<String>>) = apply { |
| 82 | + this.additionalHeaders.putAll(additionalHeaders) |
| 83 | + } |
| 84 | + |
| 85 | + fun replaceAdditionalHeaders(name: String, value: String) = apply { |
| 86 | + additionalHeaders.replace(name, value) |
| 87 | + } |
| 88 | + |
| 89 | + fun replaceAdditionalHeaders(name: String, values: Iterable<String>) = apply { |
| 90 | + additionalHeaders.replace(name, values) |
| 91 | + } |
| 92 | + |
| 93 | + fun replaceAllAdditionalHeaders(additionalHeaders: Headers) = apply { |
| 94 | + this.additionalHeaders.replaceAll(additionalHeaders) |
| 95 | + } |
| 96 | + |
| 97 | + fun replaceAllAdditionalHeaders(additionalHeaders: Map<String, Iterable<String>>) = apply { |
| 98 | + this.additionalHeaders.replaceAll(additionalHeaders) |
| 99 | + } |
| 100 | + |
| 101 | + fun removeAdditionalHeaders(name: String) = apply { additionalHeaders.remove(name) } |
| 102 | + |
| 103 | + fun removeAllAdditionalHeaders(names: Set<String>) = apply { |
| 104 | + additionalHeaders.removeAll(names) |
| 105 | + } |
| 106 | + |
| 107 | + fun additionalQueryParams(additionalQueryParams: QueryParams) = apply { |
| 108 | + this.additionalQueryParams.clear() |
| 109 | + putAllAdditionalQueryParams(additionalQueryParams) |
| 110 | + } |
| 111 | + |
| 112 | + fun additionalQueryParams(additionalQueryParams: Map<String, Iterable<String>>) = apply { |
| 113 | + this.additionalQueryParams.clear() |
| 114 | + putAllAdditionalQueryParams(additionalQueryParams) |
| 115 | + } |
| 116 | + |
| 117 | + fun putAdditionalQueryParam(key: String, value: String) = apply { |
| 118 | + additionalQueryParams.put(key, value) |
| 119 | + } |
| 120 | + |
| 121 | + fun putAdditionalQueryParams(key: String, values: Iterable<String>) = apply { |
| 122 | + additionalQueryParams.put(key, values) |
| 123 | + } |
| 124 | + |
| 125 | + fun putAllAdditionalQueryParams(additionalQueryParams: QueryParams) = apply { |
| 126 | + this.additionalQueryParams.putAll(additionalQueryParams) |
| 127 | + } |
| 128 | + |
| 129 | + fun putAllAdditionalQueryParams(additionalQueryParams: Map<String, Iterable<String>>) = |
| 130 | + apply { |
| 131 | + this.additionalQueryParams.putAll(additionalQueryParams) |
| 132 | + } |
| 133 | + |
| 134 | + fun replaceAdditionalQueryParams(key: String, value: String) = apply { |
| 135 | + additionalQueryParams.replace(key, value) |
| 136 | + } |
| 137 | + |
| 138 | + fun replaceAdditionalQueryParams(key: String, values: Iterable<String>) = apply { |
| 139 | + additionalQueryParams.replace(key, values) |
| 140 | + } |
| 141 | + |
| 142 | + fun replaceAllAdditionalQueryParams(additionalQueryParams: QueryParams) = apply { |
| 143 | + this.additionalQueryParams.replaceAll(additionalQueryParams) |
| 144 | + } |
| 145 | + |
| 146 | + fun replaceAllAdditionalQueryParams(additionalQueryParams: Map<String, Iterable<String>>) = |
| 147 | + apply { |
| 148 | + this.additionalQueryParams.replaceAll(additionalQueryParams) |
| 149 | + } |
| 150 | + |
| 151 | + fun removeAdditionalQueryParams(key: String) = apply { additionalQueryParams.remove(key) } |
| 152 | + |
| 153 | + fun removeAllAdditionalQueryParams(keys: Set<String>) = apply { |
| 154 | + additionalQueryParams.removeAll(keys) |
| 155 | + } |
| 156 | + |
| 157 | + /** |
| 158 | + * Returns an immutable instance of [ContractGetParams]. |
| 159 | + * |
| 160 | + * Further updates to this [Builder] will not mutate the returned instance. |
| 161 | + */ |
| 162 | + fun build(): ContractGetParams = |
| 163 | + ContractGetParams(additionalHeaders.build(), additionalQueryParams.build()) |
| 164 | + } |
| 165 | + |
| 166 | + override fun _headers(): Headers = additionalHeaders |
| 167 | + |
| 168 | + override fun _queryParams(): QueryParams = additionalQueryParams |
| 169 | + |
| 170 | + override fun equals(other: Any?): Boolean { |
| 171 | + if (this === other) { |
| 172 | + return true |
| 173 | + } |
| 174 | + |
| 175 | + return other is ContractGetParams && |
| 176 | + additionalHeaders == other.additionalHeaders && |
| 177 | + additionalQueryParams == other.additionalQueryParams |
| 178 | + } |
| 179 | + |
| 180 | + override fun hashCode(): Int = Objects.hash(additionalHeaders, additionalQueryParams) |
| 181 | + |
| 182 | + override fun toString() = |
| 183 | + "ContractGetParams{additionalHeaders=$additionalHeaders, additionalQueryParams=$additionalQueryParams}" |
| 184 | +} |
0 commit comments