Skip to content

Commit ed80e9d

Browse files
committed
no message
1 parent ed8356b commit ed80e9d

File tree

166 files changed

+498
-406
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

166 files changed

+498
-406
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Forge Node.js SDK
22

33
## Overview
4-
This [Node.js](https://nodejs.org/) SDK (version 0.2.1) enables you to easily integrate the Forge REST APIs
4+
This [Node.js](https://nodejs.org/) SDK (version 0.2.2) enables you to easily integrate the Forge REST APIs
55
into your application, including [OAuth](https://developer.autodesk.com/en/docs/oauth/v2/overview/),
66
[Data Management](https://developer.autodesk.com/en/docs/data/v2/overview/),
77
[Model Derivative](https://developer.autodesk.com/en/docs/model-derivative/v2/overview/),
@@ -102,7 +102,7 @@ the validity of an access token in seconds. To refresh your access token, call t
102102

103103
#### Example API Calls
104104

105-
Use the `oauth2client` (2-legged or 3-legged) object to call the Forge APIs.
105+
Use the `oauth2client` (2-legged or 3-legged) object and the `credentials` object to call the Forge APIs.
106106

107107
``` JavaScript
108108

@@ -114,14 +114,16 @@ var HubsApi = new ForgeSDK.HubsApi(); //Hubs Client
114114
var BucketsApi = new ForgeSDK.BucketsApi(); //Buckets Client
115115

116116
// Get the buckets owned by an application.
117-
// Use the oAuth2TwoLegged client object from the previous step.
118-
BucketsApi.getBuckets({}, oAuth2TwoLegged).then(function(buckets){
117+
// Use the oAuth2TwoLegged client object and the credentials object that were
118+
// obtained from the previous step
119+
BucketsApi.getBuckets({}, oAuth2TwoLegged, credentials).then(function(buckets){
119120
console.log(buckets);
120121
});
121122

122123
// Get the hubs that are accessible for a member.
123-
// Use the oAuth2ThreeLegged client object from the previous step.
124-
HubsApi.getHubs({}, oAuth2ThreeLegged).then(function(hubs) {
124+
// Use the oAuth2TwoLegged client object and the credentials object that were
125+
// obtained from the previous step
126+
HubsApi.getHubs({}, oAuth2ThreeLegged, credentials).then(function(hubs) {
125127
console.log(hubs);
126128
});
127129

docs/ActivitiesApi.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Method | HTTP request | Description
1717

1818
<a name="createActivity"></a>
1919
# **createActivity**
20-
> Activity createActivity(activity, oauth2client)
20+
> Activity createActivity(activity, oauth2client, credentials)
2121
2222
Creates a new Activity.
2323

@@ -42,7 +42,7 @@ Name | Type | Description | Notes
4242

4343
<a name="deleteActivity"></a>
4444
# **deleteActivity**
45-
> deleteActivity(id, oauth2client)
45+
> deleteActivity(id, oauth2client, credentials)
4646
4747
Removes a specific Activity.
4848

@@ -67,7 +67,7 @@ null (empty response body)
6767

6868
<a name="deleteActivityHistory"></a>
6969
# **deleteActivityHistory**
70-
> deleteActivityHistory(id, oauth2client)
70+
> deleteActivityHistory(id, oauth2client, credentials)
7171
7272
Removes the version history of the specified Activity.
7373

@@ -92,7 +92,7 @@ null (empty response body)
9292

9393
<a name="getActivity"></a>
9494
# **getActivity**
95-
> Activity getActivity(id, oauth2client)
95+
> Activity getActivity(id, oauth2client, credentials)
9696
9797
Returns the details of a specific Activity.
9898

@@ -117,7 +117,7 @@ Name | Type | Description | Notes
117117

118118
<a name="getActivityVersions"></a>
119119
# **getActivityVersions**
120-
> [Activity] getActivityVersions(id, oauth2client)
120+
> [Activity] getActivityVersions(id, oauth2client, credentials)
121121
122122
Returns all old versions of a specified Activity.
123123

@@ -142,7 +142,7 @@ Name | Type | Description | Notes
142142

143143
<a name="getAllActivities"></a>
144144
# **getAllActivities**
145-
> [Activity] getAllActivities(oauth2client)
145+
> [Activity] getAllActivities(oauth2client, credentials)
146146
147147
Returns the details of all Activities.
148148

@@ -164,7 +164,7 @@ This endpoint does not need any parameter.
164164

165165
<a name="patchActivity"></a>
166166
# **patchActivity**
167-
> patchActivity(id, activity, oauth2client)
167+
> patchActivity(id, activity, oauth2client, credentials)
168168
169169
Updates an Activity by specifying only the changed attributes.
170170

@@ -190,7 +190,7 @@ null (empty response body)
190190

191191
<a name="setActivityVersion"></a>
192192
# **setActivityVersion**
193-
> setActivityVersion(id, activityVersion, oauth2client)
193+
> setActivityVersion(id, activityVersion, oauth2client, credentials)
194194
195195
Sets the Activity to the specified version.
196196

@@ -216,7 +216,7 @@ null (empty response body)
216216

217217
<a name="updateActivity"></a>
218218
# **updateActivity**
219-
> updateActivity(id, activity, oauth2client)
219+
> updateActivity(id, activity, oauth2client, credentials)
220220
221221
Updates an Activity by redefining the entire Activity object.
222222

docs/AppPackagesApi.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Method | HTTP request | Description
1919

2020
<a name="createAppPackage"></a>
2121
# **createAppPackage**
22-
> AppPackage createAppPackage(appPackage, oauth2client)
22+
> AppPackage createAppPackage(appPackage, oauth2client, credentials)
2323
2424
Creates an AppPackage module.
2525

@@ -44,7 +44,7 @@ Name | Type | Description | Notes
4444

4545
<a name="deleteAppPackage"></a>
4646
# **deleteAppPackage**
47-
> deleteAppPackage(id, oauth2client)
47+
> deleteAppPackage(id, oauth2client, credentials)
4848
4949
Removes a specific AppPackage.
5050

@@ -69,7 +69,7 @@ null (empty response body)
6969

7070
<a name="deleteAppPackageHistory"></a>
7171
# **deleteAppPackageHistory**
72-
> deleteAppPackageHistory(id, oauth2client)
72+
> deleteAppPackageHistory(id, oauth2client, credentials)
7373
7474
Removes the version history of the specified AppPackage.
7575

@@ -94,7 +94,7 @@ null (empty response body)
9494

9595
<a name="getAllAppPackages"></a>
9696
# **getAllAppPackages**
97-
> [AppPackage] getAllAppPackages(oauth2client)
97+
> [AppPackage] getAllAppPackages(oauth2client, credentials)
9898
9999
Returns the details of all AppPackages.
100100

@@ -116,7 +116,7 @@ This endpoint does not need any parameter.
116116

117117
<a name="getAppPackage"></a>
118118
# **getAppPackage**
119-
> AppPackage getAppPackage(id, oauth2client)
119+
> AppPackage getAppPackage(id, oauth2client, credentials)
120120
121121
Returns the details of a specific AppPackage.
122122

@@ -141,7 +141,7 @@ Name | Type | Description | Notes
141141

142142
<a name="getAppPackageVersions"></a>
143143
# **getAppPackageVersions**
144-
> [AppPackage] getAppPackageVersions(id, oauth2client)
144+
> [AppPackage] getAppPackageVersions(id, oauth2client, credentials)
145145
146146
Returns all old versions of a specified AppPackage.
147147

@@ -166,7 +166,7 @@ Name | Type | Description | Notes
166166

167167
<a name="getUploadUrl"></a>
168168
# **getUploadUrl**
169-
> getUploadUrl(oauth2client)
169+
> getUploadUrl(oauth2client, credentials)
170170
171171
Requests a pre-signed URL for uploading a zip file that contains the binaries for this AppPackage.
172172

@@ -188,7 +188,7 @@ null (empty response body)
188188

189189
<a name="getUploadUrlWithRequireContentType"></a>
190190
# **getUploadUrlWithRequireContentType**
191-
> getUploadUrlWithRequireContentType(require, oauth2client)
191+
> getUploadUrlWithRequireContentType(require, oauth2client, credentials)
192192
193193
Requests a pre-signed URL for uploading a zip file that contains the binaries for this AppPackage. Unlike the GetUploadUrl method that takes no parameters, this method allows the client to request that the pre-signed URL to be issued so that the subsequent HTTP PUT operation will require Content-Type&#x3D;binary/octet-stream.
194194

@@ -213,7 +213,7 @@ null (empty response body)
213213

214214
<a name="patchAppPackage"></a>
215215
# **patchAppPackage**
216-
> patchAppPackage(id, appPackage, oauth2client)
216+
> patchAppPackage(id, appPackage, oauth2client, credentials)
217217
218218
Updates an AppPackage by specifying only the changed attributes.
219219

@@ -239,7 +239,7 @@ null (empty response body)
239239

240240
<a name="setAppPackageVersion"></a>
241241
# **setAppPackageVersion**
242-
> setAppPackageVersion(id, appPackageVersion, oauth2client)
242+
> setAppPackageVersion(id, appPackageVersion, oauth2client, credentials)
243243
244244
Sets the AppPackage to the specified version.
245245

@@ -265,7 +265,7 @@ null (empty response body)
265265

266266
<a name="updateAppPackage"></a>
267267
# **updateAppPackage**
268-
> updateAppPackage(id, appPackage, oauth2client)
268+
> updateAppPackage(id, appPackage, oauth2client, credentials)
269269
270270
Updates an AppPackage by redefining the entire Activity object.
271271

docs/BucketsApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Method | HTTP request | Description
1212

1313
<a name="createBucket"></a>
1414
# **createBucket**
15-
> Bucket createBucket(postBuckets, opts, oauth2client)
15+
> Bucket createBucket(postBuckets, opts, oauth2client, credentials)
1616
1717

1818

@@ -40,7 +40,7 @@ Name | Type | Description | Notes
4040

4141
<a name="deleteBucket"></a>
4242
# **deleteBucket**
43-
> deleteBucket(bucketKey, oauth2client)
43+
> deleteBucket(bucketKey, oauth2client, credentials)
4444
4545

4646

@@ -67,7 +67,7 @@ null (empty response body)
6767

6868
<a name="getBucketDetails"></a>
6969
# **getBucketDetails**
70-
> Bucket getBucketDetails(bucketKey, oauth2client)
70+
> Bucket getBucketDetails(bucketKey, oauth2client, credentials)
7171
7272

7373

@@ -94,7 +94,7 @@ Name | Type | Description | Notes
9494

9595
<a name="getBuckets"></a>
9696
# **getBuckets**
97-
> Buckets getBuckets(opts, oauth2client)
97+
> Buckets getBuckets(opts, oauth2client, credentials)
9898
9999

100100

docs/DerivativesApi.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Method | HTTP request | Description
1717

1818
<a name="deleteManifest"></a>
1919
# **deleteManifest**
20-
> Result deleteManifest(urn, oauth2client)
20+
> Result deleteManifest(urn, oauth2client, credentials)
2121
2222

2323

@@ -44,7 +44,7 @@ Name | Type | Description | Notes
4444

4545
<a name="getDerivativeManifest"></a>
4646
# **getDerivativeManifest**
47-
> getDerivativeManifest(urn, derivativeUrn, opts, oauth2client)
47+
> getDerivativeManifest(urn, derivativeUrn, opts, oauth2client, credentials)
4848
4949

5050

@@ -73,7 +73,7 @@ null (empty response body)
7373

7474
<a name="getFormats"></a>
7575
# **getFormats**
76-
> Formats getFormats(opts, oauth2client)
76+
> Formats getFormats(opts, oauth2client, credentials)
7777
7878

7979

@@ -101,7 +101,7 @@ Name | Type | Description | Notes
101101

102102
<a name="getManifest"></a>
103103
# **getManifest**
104-
> Manifest getManifest(urn, opts, oauth2client)
104+
> Manifest getManifest(urn, opts, oauth2client, credentials)
105105
106106

107107

@@ -129,7 +129,7 @@ Name | Type | Description | Notes
129129

130130
<a name="getMetadata"></a>
131131
# **getMetadata**
132-
> Metadata getMetadata(urn, opts, oauth2client)
132+
> Metadata getMetadata(urn, opts, oauth2client, credentials)
133133
134134

135135

@@ -157,7 +157,7 @@ Name | Type | Description | Notes
157157

158158
<a name="getModelviewMetadata"></a>
159159
# **getModelviewMetadata**
160-
> Metadata getModelviewMetadata(urn, guid, opts, oauth2client)
160+
> Metadata getModelviewMetadata(urn, guid, opts, oauth2client, credentials)
161161
162162

163163

@@ -186,7 +186,7 @@ Name | Type | Description | Notes
186186

187187
<a name="getModelviewProperties"></a>
188188
# **getModelviewProperties**
189-
> Metadata getModelviewProperties(urn, guid, opts, oauth2client)
189+
> Metadata getModelviewProperties(urn, guid, opts, oauth2client, credentials)
190190
191191

192192

@@ -215,7 +215,7 @@ Name | Type | Description | Notes
215215

216216
<a name="getThumbnail"></a>
217217
# **getThumbnail**
218-
> InputStream getThumbnail(urn, opts, oauth2client)
218+
> InputStream getThumbnail(urn, opts, oauth2client, credentials)
219219
220220

221221

@@ -244,7 +244,7 @@ Name | Type | Description | Notes
244244

245245
<a name="translate"></a>
246246
# **translate**
247-
> Job translate(job, opts, oauth2client)
247+
> Job translate(job, opts, oauth2client, credentials)
248248
249249

250250

docs/EnginesApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Method | HTTP request | Description
1010

1111
<a name="getAllEngines"></a>
1212
# **getAllEngines**
13-
> [Engine] getAllEngines(oauth2client)
13+
> [Engine] getAllEngines(oauth2client, credentials)
1414
1515
Returns the details of all available AutoCAD core engines.
1616

@@ -32,7 +32,7 @@ This endpoint does not need any parameter.
3232

3333
<a name="getEngine"></a>
3434
# **getEngine**
35-
> Engine getEngine(id, oauth2client)
35+
> Engine getEngine(id, oauth2client, credentials)
3636
3737
Returns the details of a specific AutoCAD core engine.
3838

0 commit comments

Comments
 (0)