# R2
## Buckets
Types:
- Bucket
- BucketListResponse
- BucketDeleteResponse
Methods:
- client.r2.buckets.create({ ...params }) -> Bucket
- client.r2.buckets.list({ ...params }) -> BucketListResponse
- client.r2.buckets.delete(bucketName, { ...params }) -> BucketDeleteResponse
- client.r2.buckets.edit(bucketName, { ...params }) -> Bucket
- client.r2.buckets.get(bucketName, { ...params }) -> Bucket
### Lifecycle
Types:
- LifecycleUpdateResponse
- LifecycleGetResponse
Methods:
- client.r2.buckets.lifecycle.update(bucketName, { ...params }) -> LifecycleUpdateResponse
- client.r2.buckets.lifecycle.get(bucketName, { ...params }) -> LifecycleGetResponse
### CORS
Types:
- CORSUpdateResponse
- CORSDeleteResponse
- CORSGetResponse
Methods:
- client.r2.buckets.cors.update(bucketName, { ...params }) -> CORSUpdateResponse
- client.r2.buckets.cors.delete(bucketName, { ...params }) -> CORSDeleteResponse
- client.r2.buckets.cors.get(bucketName, { ...params }) -> CORSGetResponse
### Domains
#### Custom
Types:
- CustomCreateResponse
- CustomUpdateResponse
- CustomListResponse
- CustomDeleteResponse
- CustomGetResponse
Methods:
- client.r2.buckets.domains.custom.create(bucketName, { ...params }) -> CustomCreateResponse
- client.r2.buckets.domains.custom.update(bucketName, domain, { ...params }) -> CustomUpdateResponse
- client.r2.buckets.domains.custom.list(bucketName, { ...params }) -> CustomListResponse
- client.r2.buckets.domains.custom.delete(bucketName, domain, { ...params }) -> CustomDeleteResponse
- client.r2.buckets.domains.custom.get(bucketName, domain, { ...params }) -> CustomGetResponse
#### Managed
Types:
- ManagedUpdateResponse
- ManagedListResponse
Methods:
- client.r2.buckets.domains.managed.update(bucketName, { ...params }) -> ManagedUpdateResponse
- client.r2.buckets.domains.managed.list(bucketName, { ...params }) -> ManagedListResponse
### EventNotifications
Types:
- EventNotificationUpdateResponse
- EventNotificationListResponse
- EventNotificationDeleteResponse
- EventNotificationGetResponse
Methods:
- client.r2.buckets.eventNotifications.update(bucketName, queueId, { ...params }) -> EventNotificationUpdateResponse
- client.r2.buckets.eventNotifications.list(bucketName, { ...params }) -> EventNotificationListResponse
- client.r2.buckets.eventNotifications.delete(bucketName, queueId, { ...params }) -> EventNotificationDeleteResponse
- client.r2.buckets.eventNotifications.get(bucketName, queueId, { ...params }) -> EventNotificationGetResponse
### Locks
Types:
- LockUpdateResponse
- LockGetResponse
Methods:
- client.r2.buckets.locks.update(bucketName, { ...params }) -> LockUpdateResponse
- client.r2.buckets.locks.get(bucketName, { ...params }) -> LockGetResponse
### Metrics
Types:
- MetricListResponse
Methods:
- client.r2.buckets.metrics.list({ ...params }) -> MetricListResponse
### Sippy
Types:
- Provider
- Sippy
- SippyDeleteResponse
Methods:
- client.r2.buckets.sippy.update(bucketName, { ...params }) -> Sippy
- client.r2.buckets.sippy.delete(bucketName, { ...params }) -> SippyDeleteResponse
- client.r2.buckets.sippy.get(bucketName, { ...params }) -> Sippy
### Objects
Types:
- ObjectListResponse
- ObjectDeleteResponse
- ObjectUploadResponse
Methods:
- client.r2.buckets.objects.list(bucketName, { ...params }) -> ObjectListResponsesCursorPagination
- client.r2.buckets.objects.delete(bucketName, objectKey, { ...params }) -> ObjectDeleteResponse
- client.r2.buckets.objects.get(bucketName, objectKey, { ...params }) -> Response
- client.r2.buckets.objects.upload(bucketName, objectKey, body, { ...params }) -> ObjectUploadResponse
## TemporaryCredentials
Types:
- TemporaryCredential
- TemporaryCredentialCreateResponse
Methods:
- client.r2.temporaryCredentials.create({ ...params }) -> TemporaryCredentialCreateResponse
## SuperSlurper
### Jobs
Types:
- JobCreateResponse
- JobListResponse
- JobAbortResponse
- JobAbortAllResponse
- JobGetResponse
- JobPauseResponse
- JobProgressResponse
- JobResumeResponse
Methods:
- client.r2.superSlurper.jobs.create({ ...params }) -> JobCreateResponse
- client.r2.superSlurper.jobs.list({ ...params }) -> JobListResponsesSinglePage
- client.r2.superSlurper.jobs.abort(jobId, { ...params }) -> JobAbortResponse
- client.r2.superSlurper.jobs.abortAll({ ...params }) -> JobAbortAllResponse
- client.r2.superSlurper.jobs.get(jobId, { ...params }) -> JobGetResponse
- client.r2.superSlurper.jobs.pause(jobId, { ...params }) -> JobPauseResponse
- client.r2.superSlurper.jobs.progress(jobId, { ...params }) -> JobProgressResponse
- client.r2.superSlurper.jobs.resume(jobId, { ...params }) -> JobResumeResponse
#### Logs
Types:
- LogListResponse
Methods:
- client.r2.superSlurper.jobs.logs.list(jobId, { ...params }) -> LogListResponsesSinglePage
### ConnectivityPrecheck
Types:
- ConnectivityPrecheckSourceResponse
- ConnectivityPrecheckTargetResponse
Methods:
- client.r2.superSlurper.connectivityPrecheck.source({ ...params }) -> ConnectivityPrecheckSourceResponse
- client.r2.superSlurper.connectivityPrecheck.target({ ...params }) -> ConnectivityPrecheckTargetResponse