|
| 1 | +// File generated from our OpenAPI spec by Stainless. |
| 2 | + |
| 3 | +package com.branddev.api.models.brand |
| 4 | + |
| 5 | +import com.branddev.api.core.Params |
| 6 | +import com.branddev.api.core.checkRequired |
| 7 | +import com.branddev.api.core.http.Headers |
| 8 | +import com.branddev.api.core.http.QueryParams |
| 9 | +import java.util.Objects |
| 10 | + |
| 11 | +/** |
| 12 | + * Scrapes the given URL and returns the raw HTML content of the page. Uses automatic proxy |
| 13 | + * escalation to handle blocked sites. |
| 14 | + */ |
| 15 | +class BrandWebScrapeHtmlParams |
| 16 | +private constructor( |
| 17 | + private val url: String, |
| 18 | + private val additionalHeaders: Headers, |
| 19 | + private val additionalQueryParams: QueryParams, |
| 20 | +) : Params { |
| 21 | + |
| 22 | + /** Full URL to scrape (must include http:// or https:// protocol) */ |
| 23 | + fun url(): String = url |
| 24 | + |
| 25 | + /** Additional headers to send with the request. */ |
| 26 | + fun _additionalHeaders(): Headers = additionalHeaders |
| 27 | + |
| 28 | + /** Additional query param to send with the request. */ |
| 29 | + fun _additionalQueryParams(): QueryParams = additionalQueryParams |
| 30 | + |
| 31 | + fun toBuilder() = Builder().from(this) |
| 32 | + |
| 33 | + companion object { |
| 34 | + |
| 35 | + /** |
| 36 | + * Returns a mutable builder for constructing an instance of [BrandWebScrapeHtmlParams]. |
| 37 | + * |
| 38 | + * The following fields are required: |
| 39 | + * ```java |
| 40 | + * .url() |
| 41 | + * ``` |
| 42 | + */ |
| 43 | + @JvmStatic fun builder() = Builder() |
| 44 | + } |
| 45 | + |
| 46 | + /** A builder for [BrandWebScrapeHtmlParams]. */ |
| 47 | + class Builder internal constructor() { |
| 48 | + |
| 49 | + private var url: String? = null |
| 50 | + private var additionalHeaders: Headers.Builder = Headers.builder() |
| 51 | + private var additionalQueryParams: QueryParams.Builder = QueryParams.builder() |
| 52 | + |
| 53 | + @JvmSynthetic |
| 54 | + internal fun from(brandWebScrapeHtmlParams: BrandWebScrapeHtmlParams) = apply { |
| 55 | + url = brandWebScrapeHtmlParams.url |
| 56 | + additionalHeaders = brandWebScrapeHtmlParams.additionalHeaders.toBuilder() |
| 57 | + additionalQueryParams = brandWebScrapeHtmlParams.additionalQueryParams.toBuilder() |
| 58 | + } |
| 59 | + |
| 60 | + /** Full URL to scrape (must include http:// or https:// protocol) */ |
| 61 | + fun url(url: String) = apply { this.url = url } |
| 62 | + |
| 63 | + fun additionalHeaders(additionalHeaders: Headers) = apply { |
| 64 | + this.additionalHeaders.clear() |
| 65 | + putAllAdditionalHeaders(additionalHeaders) |
| 66 | + } |
| 67 | + |
| 68 | + fun additionalHeaders(additionalHeaders: Map<String, Iterable<String>>) = apply { |
| 69 | + this.additionalHeaders.clear() |
| 70 | + putAllAdditionalHeaders(additionalHeaders) |
| 71 | + } |
| 72 | + |
| 73 | + fun putAdditionalHeader(name: String, value: String) = apply { |
| 74 | + additionalHeaders.put(name, value) |
| 75 | + } |
| 76 | + |
| 77 | + fun putAdditionalHeaders(name: String, values: Iterable<String>) = apply { |
| 78 | + additionalHeaders.put(name, values) |
| 79 | + } |
| 80 | + |
| 81 | + fun putAllAdditionalHeaders(additionalHeaders: Headers) = apply { |
| 82 | + this.additionalHeaders.putAll(additionalHeaders) |
| 83 | + } |
| 84 | + |
| 85 | + fun putAllAdditionalHeaders(additionalHeaders: Map<String, Iterable<String>>) = apply { |
| 86 | + this.additionalHeaders.putAll(additionalHeaders) |
| 87 | + } |
| 88 | + |
| 89 | + fun replaceAdditionalHeaders(name: String, value: String) = apply { |
| 90 | + additionalHeaders.replace(name, value) |
| 91 | + } |
| 92 | + |
| 93 | + fun replaceAdditionalHeaders(name: String, values: Iterable<String>) = apply { |
| 94 | + additionalHeaders.replace(name, values) |
| 95 | + } |
| 96 | + |
| 97 | + fun replaceAllAdditionalHeaders(additionalHeaders: Headers) = apply { |
| 98 | + this.additionalHeaders.replaceAll(additionalHeaders) |
| 99 | + } |
| 100 | + |
| 101 | + fun replaceAllAdditionalHeaders(additionalHeaders: Map<String, Iterable<String>>) = apply { |
| 102 | + this.additionalHeaders.replaceAll(additionalHeaders) |
| 103 | + } |
| 104 | + |
| 105 | + fun removeAdditionalHeaders(name: String) = apply { additionalHeaders.remove(name) } |
| 106 | + |
| 107 | + fun removeAllAdditionalHeaders(names: Set<String>) = apply { |
| 108 | + additionalHeaders.removeAll(names) |
| 109 | + } |
| 110 | + |
| 111 | + fun additionalQueryParams(additionalQueryParams: QueryParams) = apply { |
| 112 | + this.additionalQueryParams.clear() |
| 113 | + putAllAdditionalQueryParams(additionalQueryParams) |
| 114 | + } |
| 115 | + |
| 116 | + fun additionalQueryParams(additionalQueryParams: Map<String, Iterable<String>>) = apply { |
| 117 | + this.additionalQueryParams.clear() |
| 118 | + putAllAdditionalQueryParams(additionalQueryParams) |
| 119 | + } |
| 120 | + |
| 121 | + fun putAdditionalQueryParam(key: String, value: String) = apply { |
| 122 | + additionalQueryParams.put(key, value) |
| 123 | + } |
| 124 | + |
| 125 | + fun putAdditionalQueryParams(key: String, values: Iterable<String>) = apply { |
| 126 | + additionalQueryParams.put(key, values) |
| 127 | + } |
| 128 | + |
| 129 | + fun putAllAdditionalQueryParams(additionalQueryParams: QueryParams) = apply { |
| 130 | + this.additionalQueryParams.putAll(additionalQueryParams) |
| 131 | + } |
| 132 | + |
| 133 | + fun putAllAdditionalQueryParams(additionalQueryParams: Map<String, Iterable<String>>) = |
| 134 | + apply { |
| 135 | + this.additionalQueryParams.putAll(additionalQueryParams) |
| 136 | + } |
| 137 | + |
| 138 | + fun replaceAdditionalQueryParams(key: String, value: String) = apply { |
| 139 | + additionalQueryParams.replace(key, value) |
| 140 | + } |
| 141 | + |
| 142 | + fun replaceAdditionalQueryParams(key: String, values: Iterable<String>) = apply { |
| 143 | + additionalQueryParams.replace(key, values) |
| 144 | + } |
| 145 | + |
| 146 | + fun replaceAllAdditionalQueryParams(additionalQueryParams: QueryParams) = apply { |
| 147 | + this.additionalQueryParams.replaceAll(additionalQueryParams) |
| 148 | + } |
| 149 | + |
| 150 | + fun replaceAllAdditionalQueryParams(additionalQueryParams: Map<String, Iterable<String>>) = |
| 151 | + apply { |
| 152 | + this.additionalQueryParams.replaceAll(additionalQueryParams) |
| 153 | + } |
| 154 | + |
| 155 | + fun removeAdditionalQueryParams(key: String) = apply { additionalQueryParams.remove(key) } |
| 156 | + |
| 157 | + fun removeAllAdditionalQueryParams(keys: Set<String>) = apply { |
| 158 | + additionalQueryParams.removeAll(keys) |
| 159 | + } |
| 160 | + |
| 161 | + /** |
| 162 | + * Returns an immutable instance of [BrandWebScrapeHtmlParams]. |
| 163 | + * |
| 164 | + * Further updates to this [Builder] will not mutate the returned instance. |
| 165 | + * |
| 166 | + * The following fields are required: |
| 167 | + * ```java |
| 168 | + * .url() |
| 169 | + * ``` |
| 170 | + * |
| 171 | + * @throws IllegalStateException if any required field is unset. |
| 172 | + */ |
| 173 | + fun build(): BrandWebScrapeHtmlParams = |
| 174 | + BrandWebScrapeHtmlParams( |
| 175 | + checkRequired("url", url), |
| 176 | + additionalHeaders.build(), |
| 177 | + additionalQueryParams.build(), |
| 178 | + ) |
| 179 | + } |
| 180 | + |
| 181 | + override fun _headers(): Headers = additionalHeaders |
| 182 | + |
| 183 | + override fun _queryParams(): QueryParams = |
| 184 | + QueryParams.builder() |
| 185 | + .apply { |
| 186 | + put("url", url) |
| 187 | + putAll(additionalQueryParams) |
| 188 | + } |
| 189 | + .build() |
| 190 | + |
| 191 | + override fun equals(other: Any?): Boolean { |
| 192 | + if (this === other) { |
| 193 | + return true |
| 194 | + } |
| 195 | + |
| 196 | + return other is BrandWebScrapeHtmlParams && |
| 197 | + url == other.url && |
| 198 | + additionalHeaders == other.additionalHeaders && |
| 199 | + additionalQueryParams == other.additionalQueryParams |
| 200 | + } |
| 201 | + |
| 202 | + override fun hashCode(): Int = Objects.hash(url, additionalHeaders, additionalQueryParams) |
| 203 | + |
| 204 | + override fun toString() = |
| 205 | + "BrandWebScrapeHtmlParams{url=$url, additionalHeaders=$additionalHeaders, additionalQueryParams=$additionalQueryParams}" |
| 206 | +} |
0 commit comments