|
| 1 | +import * as runtime from '../../../lib/runtime.js'; |
| 2 | +import type { InitOverride, ApiResponse } from '../../../lib/runtime.js'; |
| 3 | +import type { |
| 4 | + CreateConnectionProfileRequestContent, |
| 5 | + CreateConnectionProfileResponseContent, |
| 6 | + GetConnectionProfileResponseContent, |
| 7 | + GetConnectionProfileTemplateResponseContent, |
| 8 | + ListConnectionProfileTemplateResponseContent, |
| 9 | + ListConnectionProfilesPaginatedResponseContent, |
| 10 | + UpdateConnectionProfileRequestContent, |
| 11 | + UpdateConnectionProfileResponseContent, |
| 12 | + DeleteConnectionProfilesByIdRequest, |
| 13 | + GetConnectionProfileTemplateRequest, |
| 14 | + GetConnectionProfilesRequest, |
| 15 | + GetConnectionProfilesByIdRequest, |
| 16 | + PatchConnectionProfilesByIdRequest, |
| 17 | +} from '../models/index.js'; |
| 18 | + |
| 19 | +const { BaseAPI } = runtime; |
| 20 | + |
| 21 | +/** |
| 22 | + * |
| 23 | + */ |
| 24 | +export class ConnectionProfilesManager extends BaseAPI { |
| 25 | + /** |
| 26 | + * Delete a single Connection Profile specified by ID. |
| 27 | + * |
| 28 | + * Delete Connection Profile |
| 29 | + * |
| 30 | + * @throws {RequiredError} |
| 31 | + */ |
| 32 | + async delete( |
| 33 | + requestParameters: DeleteConnectionProfilesByIdRequest, |
| 34 | + initOverrides?: InitOverride |
| 35 | + ): Promise<ApiResponse<void>> { |
| 36 | + runtime.validateRequiredRequestParams(requestParameters, ['id']); |
| 37 | + |
| 38 | + const response = await this.request( |
| 39 | + { |
| 40 | + path: `/connection-profiles/{id}`.replace( |
| 41 | + '{id}', |
| 42 | + encodeURIComponent(String(requestParameters.id)) |
| 43 | + ), |
| 44 | + method: 'DELETE', |
| 45 | + }, |
| 46 | + initOverrides |
| 47 | + ); |
| 48 | + |
| 49 | + return runtime.VoidApiResponse.fromResponse(response); |
| 50 | + } |
| 51 | + |
| 52 | + /** |
| 53 | + * Retrieve a Connection Profile Template. |
| 54 | + * |
| 55 | + * Get Connection Profile Template |
| 56 | + * |
| 57 | + * @throws {RequiredError} |
| 58 | + */ |
| 59 | + async getTemplate( |
| 60 | + requestParameters: GetConnectionProfileTemplateRequest, |
| 61 | + initOverrides?: InitOverride |
| 62 | + ): Promise<ApiResponse<GetConnectionProfileTemplateResponseContent>> { |
| 63 | + runtime.validateRequiredRequestParams(requestParameters, ['id']); |
| 64 | + |
| 65 | + const response = await this.request( |
| 66 | + { |
| 67 | + path: `/connection-profiles/templates/{id}`.replace( |
| 68 | + '{id}', |
| 69 | + encodeURIComponent(String(requestParameters.id)) |
| 70 | + ), |
| 71 | + method: 'GET', |
| 72 | + }, |
| 73 | + initOverrides |
| 74 | + ); |
| 75 | + |
| 76 | + return runtime.JSONApiResponse.fromResponse(response); |
| 77 | + } |
| 78 | + |
| 79 | + /** |
| 80 | + * Retrieve a list of Connection Profile Templates. |
| 81 | + * |
| 82 | + * Get Connection Profile Templates |
| 83 | + * |
| 84 | + * @throws {RequiredError} |
| 85 | + */ |
| 86 | + async getAllTemplates( |
| 87 | + initOverrides?: InitOverride |
| 88 | + ): Promise<ApiResponse<ListConnectionProfileTemplateResponseContent>> { |
| 89 | + const response = await this.request( |
| 90 | + { |
| 91 | + path: `/connection-profiles/templates`, |
| 92 | + method: 'GET', |
| 93 | + }, |
| 94 | + initOverrides |
| 95 | + ); |
| 96 | + |
| 97 | + return runtime.JSONApiResponse.fromResponse(response); |
| 98 | + } |
| 99 | + |
| 100 | + /** |
| 101 | + * Retrieve a list of Connection Profiles. This endpoint supports Checkpoint pagination. |
| 102 | + * |
| 103 | + * Get Connection Profiles |
| 104 | + * |
| 105 | + * @throws {RequiredError} |
| 106 | + */ |
| 107 | + async getAll( |
| 108 | + requestParameters: GetConnectionProfilesRequest = {}, |
| 109 | + initOverrides?: InitOverride |
| 110 | + ): Promise<ApiResponse<ListConnectionProfilesPaginatedResponseContent>> { |
| 111 | + const queryParameters = runtime.applyQueryParams(requestParameters, [ |
| 112 | + { |
| 113 | + key: 'from', |
| 114 | + config: {}, |
| 115 | + }, |
| 116 | + { |
| 117 | + key: 'take', |
| 118 | + config: {}, |
| 119 | + }, |
| 120 | + ]); |
| 121 | + |
| 122 | + const response = await this.request( |
| 123 | + { |
| 124 | + path: `/connection-profiles`, |
| 125 | + method: 'GET', |
| 126 | + query: queryParameters, |
| 127 | + }, |
| 128 | + initOverrides |
| 129 | + ); |
| 130 | + |
| 131 | + return runtime.JSONApiResponse.fromResponse(response); |
| 132 | + } |
| 133 | + |
| 134 | + /** |
| 135 | + * Retrieve details about a single Connection Profile specified by ID. |
| 136 | + * |
| 137 | + * Get Connection Profile |
| 138 | + * |
| 139 | + * @throws {RequiredError} |
| 140 | + */ |
| 141 | + async get( |
| 142 | + requestParameters: GetConnectionProfilesByIdRequest, |
| 143 | + initOverrides?: InitOverride |
| 144 | + ): Promise<ApiResponse<GetConnectionProfileResponseContent>> { |
| 145 | + runtime.validateRequiredRequestParams(requestParameters, ['id']); |
| 146 | + |
| 147 | + const response = await this.request( |
| 148 | + { |
| 149 | + path: `/connection-profiles/{id}`.replace( |
| 150 | + '{id}', |
| 151 | + encodeURIComponent(String(requestParameters.id)) |
| 152 | + ), |
| 153 | + method: 'GET', |
| 154 | + }, |
| 155 | + initOverrides |
| 156 | + ); |
| 157 | + |
| 158 | + return runtime.JSONApiResponse.fromResponse(response); |
| 159 | + } |
| 160 | + |
| 161 | + /** |
| 162 | + * Update the details of a specific Connection Profile. |
| 163 | + * |
| 164 | + * Modify a Connection Profile |
| 165 | + * |
| 166 | + * @throws {RequiredError} |
| 167 | + */ |
| 168 | + async update( |
| 169 | + requestParameters: PatchConnectionProfilesByIdRequest, |
| 170 | + bodyParameters: UpdateConnectionProfileRequestContent, |
| 171 | + initOverrides?: InitOverride |
| 172 | + ): Promise<ApiResponse<UpdateConnectionProfileResponseContent>> { |
| 173 | + runtime.validateRequiredRequestParams(requestParameters, ['id']); |
| 174 | + |
| 175 | + const headerParameters: runtime.HTTPHeaders = {}; |
| 176 | + |
| 177 | + headerParameters['Content-Type'] = 'application/json'; |
| 178 | + |
| 179 | + const response = await this.request( |
| 180 | + { |
| 181 | + path: `/connection-profiles/{id}`.replace( |
| 182 | + '{id}', |
| 183 | + encodeURIComponent(String(requestParameters.id)) |
| 184 | + ), |
| 185 | + method: 'PATCH', |
| 186 | + headers: headerParameters, |
| 187 | + body: bodyParameters, |
| 188 | + }, |
| 189 | + initOverrides |
| 190 | + ); |
| 191 | + |
| 192 | + return runtime.JSONApiResponse.fromResponse(response); |
| 193 | + } |
| 194 | + |
| 195 | + /** |
| 196 | + * Create a Connection Profile. |
| 197 | + * |
| 198 | + * Create a connection profile |
| 199 | + * |
| 200 | + * @throws {RequiredError} |
| 201 | + */ |
| 202 | + async create( |
| 203 | + bodyParameters: CreateConnectionProfileRequestContent, |
| 204 | + initOverrides?: InitOverride |
| 205 | + ): Promise<ApiResponse<CreateConnectionProfileResponseContent>> { |
| 206 | + const headerParameters: runtime.HTTPHeaders = {}; |
| 207 | + |
| 208 | + headerParameters['Content-Type'] = 'application/json'; |
| 209 | + |
| 210 | + const response = await this.request( |
| 211 | + { |
| 212 | + path: `/connection-profiles`, |
| 213 | + method: 'POST', |
| 214 | + headers: headerParameters, |
| 215 | + body: bodyParameters, |
| 216 | + }, |
| 217 | + initOverrides |
| 218 | + ); |
| 219 | + |
| 220 | + return runtime.JSONApiResponse.fromResponse(response); |
| 221 | + } |
| 222 | +} |
0 commit comments