GitVita
New repositoryImport repositoryNew issue
Your repositories Your dashboard Sign in

cloudflare/cloudflare-typescript

Public

mirrored from https://github.com/cloudflare/cloudflare-typescriptAvailable

Watch0Fork0Star0
CodeCommitsIssuesPull requestsActionsInsightsSecurity
598c552acc0522a0e174d9b85dff63bf3fb5b2bb

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

cloudflare-typescript/src

src/index.ts

591lines · modecode

RawDownload
Latest commit unavailable.
1// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
3import * as Errors from './error';
4import * as Uploads from './uploads';
5import { type Agent } from './_shims/index';
6import * as qs from 'qs';
7import * as Core from './core';
8import * as Pagination from './pagination';
9import * as API from './resources/index';
10
11export interface ClientOptions {
12 /**
13 * Defaults to process.env['CLOUDFLARE_API_TOKEN'].
14 */
15 apiToken?: string | null | undefined;
16
17 /**
18 * Defaults to process.env['CLOUDFLARE_API_KEY'].
19 */
20 apiKey?: string | null | undefined;
21
22 /**
23 * Defaults to process.env['CLOUDFLARE_EMAIL'].
24 */
25 apiEmail?: string | null | undefined;
26
27 /**
28 * Defaults to process.env['CLOUDFLARE_API_USER_SERVICE_KEY'].
29 */
30 userServiceKey?: string | null | undefined;
31
32 /**
33 * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
34 *
35 * Defaults to process.env['CLOUDFLARE_BASE_URL'].
36 */
37 baseURL?: string | null | undefined;
38
39 /**
40 * The maximum amount of time (in milliseconds) that the client should wait for a response
41 * from the server before timing out a single request.
42 *
43 * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
44 * much longer than this timeout before the promise succeeds or fails.
45 */
46 timeout?: number;
47
48 /**
49 * An HTTP agent used to manage HTTP(S) connections.
50 *
51 * If not provided, an agent will be constructed by default in the Node.js environment,
52 * otherwise no agent is used.
53 */
54 httpAgent?: Agent;
55
56 /**
57 * Specify a custom `fetch` function implementation.
58 *
59 * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is
60 * defined globally.
61 */
62 fetch?: Core.Fetch | undefined;
63
64 /**
65 * The maximum number of times that the client will retry a request in case of a
66 * temporary failure, like a network error or a 5XX error from the server.
67 *
68 * @default 2
69 */
70 maxRetries?: number;
71
72 /**
73 * Default headers to include with every request to the API.
74 *
75 * These can be removed in individual requests by explicitly setting the
76 * header to `undefined` or `null` in request options.
77 */
78 defaultHeaders?: Core.Headers;
79
80 /**
81 * Default query parameters to include with every request to the API.
82 *
83 * These can be removed in individual requests by explicitly setting the
84 * param to `undefined` in request options.
85 */
86 defaultQuery?: Core.DefaultQuery;
87}
88
89/**
90 * API Client for interfacing with the Cloudflare API.
91 */
92export class Cloudflare extends Core.APIClient {
93 apiToken: string | null;
94 apiKey: string | null;
95 apiEmail: string | null;
96 userServiceKey: string | null;
97
98 private _options: ClientOptions;
99
100 /**
101 * API Client for interfacing with the Cloudflare API.
102 *
103 * @param {string | null | undefined} [opts.apiToken=process.env['CLOUDFLARE_API_TOKEN'] ?? null]
104 * @param {string | null | undefined} [opts.apiKey=process.env['CLOUDFLARE_API_KEY'] ?? null]
105 * @param {string | null | undefined} [opts.apiEmail=process.env['CLOUDFLARE_EMAIL'] ?? null]
106 * @param {string | null | undefined} [opts.userServiceKey=process.env['CLOUDFLARE_API_USER_SERVICE_KEY'] ?? null]
107 * @param {string} [opts.baseURL=process.env['CLOUDFLARE_BASE_URL'] ?? https://api.cloudflare.com/client/v4] - Override the default base URL for the API.
108 * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
109 * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
110 * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
111 * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
112 * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
113 * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
114 */
115 constructor({
116 baseURL = Core.readEnv('CLOUDFLARE_BASE_URL'),
117 apiToken = Core.readEnv('CLOUDFLARE_API_TOKEN') ?? null,
118 apiKey = Core.readEnv('CLOUDFLARE_API_KEY') ?? null,
119 apiEmail = Core.readEnv('CLOUDFLARE_EMAIL') ?? null,
120 userServiceKey = Core.readEnv('CLOUDFLARE_API_USER_SERVICE_KEY') ?? null,
121 ...opts
122 }: ClientOptions = {}) {
123 const options: ClientOptions = {
124 apiToken,
125 apiKey,
126 apiEmail,
127 userServiceKey,
128 ...opts,
129 baseURL: baseURL || `https://api.cloudflare.com/client/v4`,
130 };
131
132 super({
133 baseURL: options.baseURL!,
134 timeout: options.timeout ?? 60000 /* 1 minute */,
135 httpAgent: options.httpAgent,
136 maxRetries: options.maxRetries,
137 fetch: options.fetch,
138 });
139
140 this._options = options;
141
142 this.apiToken = apiToken;
143 this.apiKey = apiKey;
144 this.apiEmail = apiEmail;
145 this.userServiceKey = userServiceKey;
146 }
147
148 accounts: API.Accounts = new API.Accounts(this);
149 originCACertificates: API.OriginCACertificates = new API.OriginCACertificates(this);
150 ips: API.IPs = new API.IPs(this);
151 memberships: API.Memberships = new API.Memberships(this);
152 user: API.User = new API.User(this);
153 zones: API.Zones = new API.Zones(this);
154 loadBalancers: API.LoadBalancers = new API.LoadBalancers(this);
155 cache: API.Cache = new API.Cache(this);
156 ssl: API.SSL = new API.SSL(this);
157 subscriptions: API.Subscriptions = new API.Subscriptions(this);
158 acm: API.ACM = new API.ACM(this);
159 argo: API.Argo = new API.Argo(this);
160 plans: API.Plans = new API.Plans(this);
161 ratePlans: API.RatePlans = new API.RatePlans(this);
162 certificateAuthorities: API.CertificateAuthorities = new API.CertificateAuthorities(this);
163 clientCertificates: API.ClientCertificates = new API.ClientCertificates(this);
164 customCertificates: API.CustomCertificates = new API.CustomCertificates(this);
165 customHostnames: API.CustomHostnames = new API.CustomHostnames(this);
166 customNameservers: API.CustomNameservers = new API.CustomNameservers(this);
167 dns: API.DNS = new API.DNS(this);
168 dnssec: API.DNSSECResource = new API.DNSSECResource(this);
169 emailSecurity: API.EmailSecurity = new API.EmailSecurity(this);
170 emailRouting: API.EmailRouting = new API.EmailRouting(this);
171 filters: API.Filters = new API.Filters(this);
172 firewall: API.Firewall = new API.Firewall(this);
173 healthchecks: API.Healthchecks = new API.Healthchecks(this);
174 keylessCertificates: API.KeylessCertificates = new API.KeylessCertificates(this);
175 logpush: API.Logpush = new API.Logpush(this);
176 logs: API.Logs = new API.Logs(this);
177 originTLSClientAuth: API.OriginTLSClientAuth = new API.OriginTLSClientAuth(this);
178 pagerules: API.Pagerules = new API.Pagerules(this);
179 rateLimits: API.RateLimits = new API.RateLimits(this);
180 secondaryDNS: API.SecondaryDNS = new API.SecondaryDNS(this);
181 waitingRooms: API.WaitingRooms = new API.WaitingRooms(this);
182 web3: API.Web3 = new API.Web3(this);
183 workers: API.Workers = new API.Workers(this);
184 kv: API.KV = new API.KV(this);
185 durableObjects: API.DurableObjects = new API.DurableObjects(this);
186 queues: API.Queues = new API.Queues(this);
187 apiGateway: API.APIGateway = new API.APIGateway(this);
188 managedHeaders: API.ManagedHeaders = new API.ManagedHeaders(this);
189 pageShield: API.PageShield = new API.PageShield(this);
190 rulesets: API.Rulesets = new API.Rulesets(this);
191 urlNormalization: API.URLNormalization = new API.URLNormalization(this);
192 spectrum: API.Spectrum = new API.Spectrum(this);
193 addressing: API.Addressing = new API.Addressing(this);
194 auditLogs: API.AuditLogs = new API.AuditLogs(this);
195 billing: API.Billing = new API.Billing(this);
196 brandProtection: API.BrandProtection = new API.BrandProtection(this);
197 diagnostics: API.Diagnostics = new API.Diagnostics(this);
198 images: API.Images = new API.Images(this);
199 intel: API.Intel = new API.Intel(this);
200 magicTransit: API.MagicTransit = new API.MagicTransit(this);
201 magicNetworkMonitoring: API.MagicNetworkMonitoring = new API.MagicNetworkMonitoring(this);
202 mtlsCertificates: API.MTLSCertificates = new API.MTLSCertificates(this);
203 pages: API.Pages = new API.Pages(this);
204 pcaps: API.PCAPs = new API.PCAPs(this);
205 registrar: API.Registrar = new API.Registrar(this);
206 requestTracers: API.RequestTracers = new API.RequestTracers(this);
207 rules: API.Rules = new API.Rules(this);
208 storage: API.Storage = new API.Storage(this);
209 stream: API.Stream = new API.Stream(this);
210 alerting: API.Alerting = new API.Alerting(this);
211 d1: API.D1Resource = new API.D1Resource(this);
212 r2: API.R2 = new API.R2(this);
213 warpConnector: API.WARPConnector = new API.WARPConnector(this);
214 workersForPlatforms: API.WorkersForPlatforms = new API.WorkersForPlatforms(this);
215 zeroTrust: API.ZeroTrust = new API.ZeroTrust(this);
216 challenges: API.Challenges = new API.Challenges(this);
217 hyperdrive: API.HyperdriveResource = new API.HyperdriveResource(this);
218 rum: API.RUM = new API.RUM(this);
219 vectorize: API.Vectorize = new API.Vectorize(this);
220 urlScanner: API.URLScanner = new API.URLScanner(this);
221 radar: API.Radar = new API.Radar(this);
222 botManagement: API.BotManagement = new API.BotManagement(this);
223 originPostQuantumEncryption: API.OriginPostQuantumEncryption = new API.OriginPostQuantumEncryption(this);
224 speed: API.Speed = new API.Speed(this);
225 dcvDelegation: API.DCVDelegation = new API.DCVDelegation(this);
226 hostnames: API.Hostnames = new API.Hostnames(this);
227 snippets: API.Snippets = new API.Snippets(this);
228 calls: API.Calls = new API.Calls(this);
229 cloudforceOne: API.CloudforceOne = new API.CloudforceOne(this);
230 eventNotifications: API.EventNotifications = new API.EventNotifications(this);
231 aiGateway: API.AIGateway = new API.AIGateway(this);
232 iam: API.IAM = new API.IAM(this);
233 cloudConnector: API.CloudConnector = new API.CloudConnector(this);
234
235 protected override defaultQuery(): Core.DefaultQuery | undefined {
236 return this._options.defaultQuery;
237 }
238
239 protected override defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers {
240 return {
241 ...super.defaultHeaders(opts),
242 'X-Auth-Key': this.apiKey,
243 'X-Auth-Email': this.apiEmail,
244 ...this._options.defaultHeaders,
245 };
246 }
247
248 protected override validateHeaders(headers: Core.Headers, customHeaders: Core.Headers) {
249 if (this.apiEmail && headers['x-auth-email']) {
250 return;
251 }
252 if (customHeaders['x-auth-email'] === null) {
253 return;
254 }
255
256 if (this.apiKey && headers['x-auth-key']) {
257 return;
258 }
259 if (customHeaders['x-auth-key'] === null) {
260 return;
261 }
262
263 if (this.apiToken && headers['authorization']) {
264 return;
265 }
266 if (customHeaders['authorization'] === null) {
267 return;
268 }
269
270 if (this.userServiceKey && headers['x-auth-user-service-key']) {
271 return;
272 }
273 if (customHeaders['x-auth-user-service-key'] === null) {
274 return;
275 }
276
277 throw new Error(
278 'Could not resolve authentication method. Expected one of apiEmail, apiKey, apiToken or userServiceKey to be set. Or for one of the "X-Auth-Email", "X-Auth-Key", "Authorization" or "X-Auth-User-Service-Key" headers to be explicitly omitted',
279 );
280 }
281
282 protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers {
283 const apiEmailAuth = this.apiEmailAuth(opts);
284 const apiKeyAuth = this.apiKeyAuth(opts);
285 const apiTokenAuth = this.apiTokenAuth(opts);
286 const userServiceKeyAuth = this.userServiceKeyAuth(opts);
287
288 if (
289 apiEmailAuth != null &&
290 !Core.isEmptyObj(apiEmailAuth) &&
291 apiKeyAuth != null &&
292 !Core.isEmptyObj(apiKeyAuth)
293 ) {
294 return { ...apiEmailAuth, ...apiKeyAuth };
295 }
296
297 if (apiTokenAuth != null && !Core.isEmptyObj(apiTokenAuth)) {
298 return apiTokenAuth;
299 }
300
301 if (userServiceKeyAuth != null && !Core.isEmptyObj(userServiceKeyAuth)) {
302 return userServiceKeyAuth;
303 }
304 return {};
305 }
306
307 protected apiEmailAuth(opts: Core.FinalRequestOptions): Core.Headers {
308 if (this.apiEmail == null) {
309 return {};
310 }
311 return { 'X-Auth-Email': this.apiEmail };
312 }
313
314 protected apiKeyAuth(opts: Core.FinalRequestOptions): Core.Headers {
315 if (this.apiKey == null) {
316 return {};
317 }
318 return { 'X-Auth-Key': this.apiKey };
319 }
320
321 protected apiTokenAuth(opts: Core.FinalRequestOptions): Core.Headers {
322 if (this.apiToken == null) {
323 return {};
324 }
325 return { Authorization: `Bearer ${this.apiToken}` };
326 }
327
328 protected userServiceKeyAuth(opts: Core.FinalRequestOptions): Core.Headers {
329 if (this.userServiceKey == null) {
330 return {};
331 }
332 return { 'X-Auth-User-Service-Key': this.userServiceKey };
333 }
334
335 protected override stringifyQuery(query: Record<string, unknown>): string {
336 return qs.stringify(query, { allowDots: true, arrayFormat: 'repeat' });
337 }
338
339 static Cloudflare = this;
340 static DEFAULT_TIMEOUT = 60000; // 1 minute
341
342 static CloudflareError = Errors.CloudflareError;
343 static APIError = Errors.APIError;
344 static APIConnectionError = Errors.APIConnectionError;
345 static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
346 static APIUserAbortError = Errors.APIUserAbortError;
347 static NotFoundError = Errors.NotFoundError;
348 static ConflictError = Errors.ConflictError;
349 static RateLimitError = Errors.RateLimitError;
350 static BadRequestError = Errors.BadRequestError;
351 static AuthenticationError = Errors.AuthenticationError;
352 static InternalServerError = Errors.InternalServerError;
353 static PermissionDeniedError = Errors.PermissionDeniedError;
354 static UnprocessableEntityError = Errors.UnprocessableEntityError;
355
356 static toFile = Uploads.toFile;
357 static fileFromPath = Uploads.fileFromPath;
358}
359
360export const {
361 CloudflareError,
362 APIError,
363 APIConnectionError,
364 APIConnectionTimeoutError,
365 APIUserAbortError,
366 NotFoundError,
367 ConflictError,
368 RateLimitError,
369 BadRequestError,
370 AuthenticationError,
371 InternalServerError,
372 PermissionDeniedError,
373 UnprocessableEntityError,
374} = Errors;
375
376export import toFile = Uploads.toFile;
377export import fileFromPath = Uploads.fileFromPath;
378
379export namespace Cloudflare {
380 export import RequestOptions = Core.RequestOptions;
381
382 export import V4PagePagination = Pagination.V4PagePagination;
383 export import V4PagePaginationParams = Pagination.V4PagePaginationParams;
384 export import V4PagePaginationResponse = Pagination.V4PagePaginationResponse;
385
386 export import V4PagePaginationArray = Pagination.V4PagePaginationArray;
387 export import V4PagePaginationArrayParams = Pagination.V4PagePaginationArrayParams;
388 export import V4PagePaginationArrayResponse = Pagination.V4PagePaginationArrayResponse;
389
390 export import CursorPagination = Pagination.CursorPagination;
391 export import CursorPaginationParams = Pagination.CursorPaginationParams;
392 export import CursorPaginationResponse = Pagination.CursorPaginationResponse;
393
394 export import CursorLimitPagination = Pagination.CursorLimitPagination;
395 export import CursorLimitPaginationParams = Pagination.CursorLimitPaginationParams;
396 export import CursorLimitPaginationResponse = Pagination.CursorLimitPaginationResponse;
397
398 export import SinglePage = Pagination.SinglePage;
399 export import SinglePageResponse = Pagination.SinglePageResponse;
400
401 export import Accounts = API.Accounts;
402
403 export import OriginCACertificates = API.OriginCACertificates;
404
405 export import IPs = API.IPs;
406
407 export import Memberships = API.Memberships;
408
409 export import User = API.User;
410
411 export import Zones = API.Zones;
412
413 export import LoadBalancers = API.LoadBalancers;
414
415 export import Cache = API.Cache;
416
417 export import SSL = API.SSL;
418
419 export import Subscriptions = API.Subscriptions;
420
421 export import ACM = API.ACM;
422
423 export import Argo = API.Argo;
424
425 export import Plans = API.Plans;
426
427 export import RatePlans = API.RatePlans;
428
429 export import CertificateAuthorities = API.CertificateAuthorities;
430
431 export import ClientCertificates = API.ClientCertificates;
432
433 export import CustomCertificates = API.CustomCertificates;
434
435 export import CustomHostnames = API.CustomHostnames;
436
437 export import CustomNameservers = API.CustomNameservers;
438
439 export import DNS = API.DNS;
440
441 export import DNSSECResource = API.DNSSECResource;
442
443 export import EmailSecurity = API.EmailSecurity;
444
445 export import EmailRouting = API.EmailRouting;
446
447 export import Filters = API.Filters;
448
449 export import Firewall = API.Firewall;
450
451 export import Healthchecks = API.Healthchecks;
452
453 export import KeylessCertificates = API.KeylessCertificates;
454
455 export import Logpush = API.Logpush;
456
457 export import Logs = API.Logs;
458
459 export import OriginTLSClientAuth = API.OriginTLSClientAuth;
460
461 export import Pagerules = API.Pagerules;
462
463 export import RateLimits = API.RateLimits;
464
465 export import SecondaryDNS = API.SecondaryDNS;
466
467 export import WaitingRooms = API.WaitingRooms;
468
469 export import Web3 = API.Web3;
470
471 export import Workers = API.Workers;
472
473 export import KV = API.KV;
474
475 export import DurableObjects = API.DurableObjects;
476
477 export import Queues = API.Queues;
478
479 export import APIGateway = API.APIGateway;
480
481 export import ManagedHeaders = API.ManagedHeaders;
482
483 export import PageShield = API.PageShield;
484
485 export import Rulesets = API.Rulesets;
486
487 export import URLNormalization = API.URLNormalization;
488
489 export import Spectrum = API.Spectrum;
490
491 export import Addressing = API.Addressing;
492
493 export import AuditLogs = API.AuditLogs;
494
495 export import Billing = API.Billing;
496
497 export import BrandProtection = API.BrandProtection;
498
499 export import Diagnostics = API.Diagnostics;
500
501 export import Images = API.Images;
502
503 export import Intel = API.Intel;
504
505 export import MagicTransit = API.MagicTransit;
506
507 export import MagicNetworkMonitoring = API.MagicNetworkMonitoring;
508
509 export import MTLSCertificates = API.MTLSCertificates;
510
511 export import Pages = API.Pages;
512
513 export import PCAPs = API.PCAPs;
514
515 export import Registrar = API.Registrar;
516
517 export import RequestTracers = API.RequestTracers;
518
519 export import Rules = API.Rules;
520
521 export import Storage = API.Storage;
522
523 export import Stream = API.Stream;
524
525 export import Alerting = API.Alerting;
526
527 export import D1Resource = API.D1Resource;
528
529 export import R2 = API.R2;
530
531 export import WARPConnector = API.WARPConnector;
532
533 export import WorkersForPlatforms = API.WorkersForPlatforms;
534
535 export import ZeroTrust = API.ZeroTrust;
536
537 export import Challenges = API.Challenges;
538
539 export import HyperdriveResource = API.HyperdriveResource;
540
541 export import RUM = API.RUM;
542
543 export import Vectorize = API.Vectorize;
544
545 export import URLScanner = API.URLScanner;
546
547 export import Radar = API.Radar;
548
549 export import BotManagement = API.BotManagement;
550
551 export import OriginPostQuantumEncryption = API.OriginPostQuantumEncryption;
552
553 export import Speed = API.Speed;
554
555 export import DCVDelegation = API.DCVDelegation;
556
557 export import Hostnames = API.Hostnames;
558
559 export import Snippets = API.Snippets;
560
561 export import Calls = API.Calls;
562
563 export import CloudforceOne = API.CloudforceOne;
564
565 export import EventNotifications = API.EventNotifications;
566
567 export import AIGateway = API.AIGateway;
568
569 export import IAM = API.IAM;
570
571 export import CloudConnector = API.CloudConnector;
572
573 export import ASN = API.ASN;
574 export import AuditLog = API.AuditLog;
575 export import CertificateCA = API.CertificateCA;
576 export import CertificateRequestType = API.CertificateRequestType;
577 export import CloudflareTunnel = API.CloudflareTunnel;
578 export import ErrorData = API.ErrorData;
579 export import Identifier = API.Identifier;
580 export import LoadBalancerPreview = API.LoadBalancerPreview;
581 export import Member = API.Member;
582 export import PaginationInfo = API.PaginationInfo;
583 export import Permission = API.Permission;
584 export import PermissionGrant = API.PermissionGrant;
585 export import ResponseInfo = API.ResponseInfo;
586 export import Result = API.Result;
587 export import Role = API.Role;
588 export import SortDirection = API.SortDirection;
589}
590
591export default Cloudflare;
592