OSSClient | simpler-forge-apis

Client providing access to Autodesk Forge OSS (object storage service) APIs.

link: https://forge.autodesk.com/en/docs/data/v2

Hierarchy

OSSClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OSSClient(auth: AuthOptions, options?: IClientOptions): OSSClient

- Defined in oss.ts:57
Parameters
- auth: AuthOptions
- Optional options: IClientOptions
Returns OSSClient

Properties

Protected apiClient

apiClient: ApiClient

Protected auth

auth: AuthOptions

Protected authProvider

authProvider: IAuthProvider

Protected bucketsApi

bucketsApi: BucketsApi

Protected host

host: string

Protected objectsApi

objectsApi: ObjectsApi

Protected region

region: Region

Methods

copyObject

copyObject(bucketKey: string, oldObjectKey: string, newObjectKey: string): Promise<IObject>

- Defined in oss.ts:267
Makes a copy of object under another name within the same bucket.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/buckets-:bucketKey-objects-:objectName-copyto-:newObjectName-PUT

async

throws

Error when the request fails, for example, due to insufficient rights, or incorrect scopes.

Parameters
- bucketKey: string
  
  Bucket key.
- oldObjectKey: string
  
  Original object key.
- newObjectKey: string
  
  New object key.
Returns Promise<IObject>

Details of the new object copy.

createBucket

createBucket(bucketKey: string, policyKey: DataRetentionPolicy, allow?: { access: "full" | "read"; authId: string }[]): Promise<IBucketDetails>

- Defined in oss.ts:144
Creates a new bucket.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/buckets-POST

async

throws

Error when the request fails, for example, due to insufficient rights, incorrect scopes, or when a bucket with this name already exists.

Parameters
- bucketKey: string
  
  Bucket key.
- policyKey: DataRetentionPolicy
  
  Data retention policy for objects uploaded to this bucket.
- Optional allow: { access: "full" | "read"; authId: string }[]
Returns Promise<IBucketDetails>

Bucket details.

createSignedUrl

createSignedUrl(bucketKey: string, objectKey: string, access?: "read" | "write" | "readwrite", minutesExpiration?: number): Promise<ISignedUrl>

- Defined in oss.ts:297
Creates signed URL for specific object.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/buckets-:bucketKey-objects-:objectName-signed-POST

async

throws

Error when the request fails, for example, due to insufficient rights.

Parameters
- bucketKey: string
  
  Bucket key.
- objectKey: string
  
  Object key.
- access: "read" | "write" | "readwrite" = 'read'
- minutesExpiration: number = 60
Returns Promise<ISignedUrl>

New signed URL resource.

deleteBucket

deleteBucket(bucketKey: string): Promise<void>

- Defined in oss.ts:158
Deletes a bucket.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/buckets-:bucketKey-DELETE/

async

throws

Error when the request fails, for example, due to insufficient rights, or incorrect scopes.

Parameters
- bucketKey: string
  
  Bucket key.
Returns Promise<void>

deleteObject

deleteObject(bucketKey: string, objectKey: string): Promise<void>

- Defined in oss.ts:281
Deletes object.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/buckets-:bucketKey-objects-:objectName-DELETE

async

throws

Error when the request fails, for example, due to insufficient rights, or incorrect scopes.

Parameters
- bucketKey: string
  
  Bucket key.
- objectKey: string
  
  Name of object to delete.
Returns Promise<void>

downloadObject

downloadObject(bucketKey: string, objectKey: string): Promise<Buffer>

- Defined in oss.ts:251
Downloads content of a specific object.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/buckets-:bucketKey-objects-:objectName-GET

async

throws

Error when the request fails, for example, due to insufficient rights, or incorrect scopes.

Parameters
- bucketKey: string
  
  Bucket key.
- objectKey: string
  
  Object key.
Returns Promise<Buffer>

Object content.

enumerateBuckets

enumerateBuckets(pageSize?: number): AsyncIterable<IBucket[]>

- Defined in oss.ts:86
Enumerates all buckets in pages/batches of predefined size.
link

https://forge.autodesk.com/en/docs/data/v2/reference/http/buckets-GET

async

generator

yields

{AsyncIterable<IBucket[]>} Bucket batches.

throws

Error when the request fails, for example, due to insufficient rights, or incorrect scopes.

example
```
const client = new OSSClient({ client_id: process.env.FORGE_CLIENT_ID, client_secret: process.env.FORGE_CLIENT_SECRET });
for await (const page of client.enumerateBuckets()) {
    console.log(page.map(bucket => bucket.bucketKey).join(','));
}
```
Parameters
- pageSize: number = ...
Returns AsyncIterable<IBucket[]>

enumerateObjects

enumerateObjects(bucketKey: string, beginsWith?: string, pageSize?: number): AsyncIterable<IObject[]>

- Defined in oss.ts:178
Enumerates all objects in a bucket in pages/batches of predefined size.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/buckets-:bucketKey-objects-GET

async

generator

yields

{AsyncIterable<IObject[]>} Object batches.

throws

Error when the request fails, for example, due to insufficient rights, or incorrect scopes.

Parameters
- bucketKey: string
  
  Bucket key.
- Optional beginsWith: string
- pageSize: number = ...
Returns AsyncIterable<IObject[]>

getBucketDetails

getBucketDetails(bucketKey: string): Promise<IBucketDetails>

- Defined in oss.ts:127
Retrieves details of a specific bucket.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/buckets-:bucketKey-details-GET

async

throws

Error when the request fails, for example, due to insufficient rights, or when a bucket with this name does not exist.

Parameters
- bucketKey: string
  
  Bucket key.
Returns Promise<IBucketDetails>

Bucket details.

getObjectDetails

getObjectDetails(bucketKey: string, objectKey: string): Promise<IObject>

- Defined in oss.ts:218
Gets details of a specific object.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/buckets-:bucketKey-objects-:objectName-details-GET

async

throws

Error when the request fails, for example, due to insufficient rights, or when an object with this name does not exist.

Parameters
- bucketKey: string
  
  Bucket key.
- objectKey: string
  
  Object name.
Returns Promise<IObject>

Object details.

listBuckets

listBuckets(): Promise<IBucket[]>

- Defined in oss.ts:110
Lists all buckets.
link

https://forge.autodesk.com/en/docs/data/v2/reference/http/buckets-GET

async

throws

Error when the request fails, for example, due to insufficient rights, or incorrect scopes.

example
```
const client = new OSSClient({ client_id: process.env.FORGE_CLIENT_ID, client_secret: process.env.FORGE_CLIENT_SECRET });
const buckets = client.listBuckets();
console.log(buckets.map(bucket => bucket.bucketKey).join(','));
```
Returns Promise<IBucket[]>

List of buckets.

listObjects

listObjects(bucketKey: string, beginsWith?: string): Promise<IObject[]>

- Defined in oss.ts:200
Lists all objects in a bucket.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/buckets-:bucketKey-objects-GET

async

throws

Error when the request fails, for example, due to insufficient rights, or incorrect scopes.

Parameters
- bucketKey: string
  
  Bucket key.
- Optional beginsWith: string
Returns Promise<IObject[]>

List of objects.

uploadObject

uploadObject(bucketKey: string, objectKey: string, data: Buffer): Promise<IObject>

- Defined in oss.ts:234
Uploads content to a specific object.

link

https://forge.autodesk.com/en/docs/data/v2/reference/http/buckets-:bucketKey-objects-:objectName-PUT

async

throws

Error when the request fails, for example, due to insufficient rights, or incorrect scopes.

Parameters
- bucketKey: string
  
  Bucket key.
- objectKey: string
  
  Object key.
- data: Buffer
  
  Object data.
Returns Promise<IObject>

Object description.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

auth: AuthOptions

Optional options: IClientOptions

Returns OSSClient

Properties

Protected apiClient

Protected auth

Protected authProvider

Protected bucketsApi

Protected host

Protected objectsApi

Protected region

Methods

copyObject

Parameters

bucketKey: string

oldObjectKey: string

newObjectKey: string

Returns Promise<IObject>

createBucket

Parameters

bucketKey: string

policyKey: DataRetentionPolicy

Optional allow: { access: "full" | "read"; authId: string }[]

Returns Promise<IBucketDetails>

createSignedUrl

Parameters

bucketKey: string

objectKey: string

access: "read" | "write" | "readwrite" = 'read'

minutesExpiration: number = 60

Returns Promise<ISignedUrl>

deleteBucket

Parameters

bucketKey: string

Returns Promise<void>

deleteObject

Parameters

bucketKey: string

objectKey: string

Returns Promise<void>

downloadObject

Parameters

bucketKey: string

objectKey: string

Returns Promise<Buffer>

enumerateBuckets

Parameters

pageSize: number = ...

Returns AsyncIterable<IBucket[]>

enumerateObjects

Parameters

bucketKey: string

Optional beginsWith: string

pageSize: number = ...

Returns AsyncIterable<IObject[]>

getBucketDetails

Parameters

bucketKey: string

Returns Promise<IBucketDetails>

getObjectDetails

Parameters

bucketKey: string

objectKey: string

Returns Promise<IObject>

listBuckets

Returns Promise<IBucket[]>

listObjects

Parameters

bucketKey: string

Optional beginsWith: string

Returns Promise<IObject[]>

uploadObject