Skip to content

Commit dc2354a

Browse files
gregra81gregra81
committed
Top Folders
1 parent 2bca2a1 commit dc2354a

File tree

167 files changed

+792
-322
lines changed

Some content is hidden

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

167 files changed

+792
-322
lines changed

‎README.md

Lines changed: 3 additions & 2 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.6) enables you to easily integrate the Forge REST APIs
4+
This [Node.js](https://nodejs.org/) SDK (version 0.2.7) 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/),
@@ -32,7 +32,8 @@ and 3-legged tokens for calling different Data Management endpoints.
3232
#### 2-Legged Token
3333

3434
This type of token is given directly to the application.
35-
To get a 2-legged token run the following code. Note that you need to replace `your-client-id` and `your-client-secret` with your [app](https://developer.autodesk.com/myapps)'s client ID and client secret.
35+
36+
To get a 2-legged token run the following code. Note that you need to replace `your-client-id` and `your-client-secret` with your [app](https://developer.autodesk.com/myapps)'s client ID and client secret.
3637

3738
``` JavaScript
3839
var ForgeSDK = require('forge-apis');

‎docs/BaseAttributesExtensionObjectWithoutSchemaLink.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ForgeSdk.BaseAttributesExtensionObjectWithoutSchemaLink
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**type** | **String** | |
7+
**version** | **String** | |
8+
**data** | **Object** | | [optional]
9+
10+

‎docs/FoldersApi.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Method | HTTP request | Description
99
[**getFolderParent**](FoldersApi.md#getFolderParent) | **GET** /data/v1/projects/{project_id}/folders/{folder_id}/parent |
1010
[**getFolderRefs**](FoldersApi.md#getFolderRefs) | **GET** /data/v1/projects/{project_id}/folders/{folder_id}/refs |
1111
[**getFolderRelationshipsRefs**](FoldersApi.md#getFolderRelationshipsRefs) | **GET** /data/v1/projects/{project_id}/folders/{folder_id}/relationships/refs |
12+
[**postFolder**](FoldersApi.md#postFolder) | **POST** /data/v1/projects/{project_id}/folders |
1213
[**postFolderRelationshipsRef**](FoldersApi.md#postFolderRelationshipsRef) | **POST** /data/v1/projects/{project_id}/folders/{folder_id}/relationships/refs |
1314

1415

@@ -160,6 +161,33 @@ Name | Type | Description | Notes
160161

161162
[oauth2_access_code](../README.md#authentication)
162163

164+
### HTTP request headers
165+
166+
- **Content-Type**: application/vnd.api+json
167+
- **Accept**: application/vnd.api+json, application/json
168+
169+
<a name="postFolder"></a>
170+
# **postFolder**
171+
> postFolder(body, oauth2client, credentials)
172+
173+
174+
175+
Creates a new folder in the &#x60;data&#x60; domain service
176+
177+
### Parameters
178+
179+
Name | Type | Description | Notes
180+
------------- | ------------- | ------------- | -------------
181+
**body** | [**CreateFolder**](CreateFolder.md)| describe the folder to be created |
182+
183+
### Return type
184+
185+
null (empty response body)
186+
187+
### Authorization
188+
189+
[oauth2_access_code](../README.md#authentication)
190+
163191
### HTTP request headers
164192

165193
- **Content-Type**: application/vnd.api+json

‎docs/HubsApi.md

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ All URIs are relative to *https://developer.api.autodesk.com/*
55
Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**getHub**](HubsApi.md#getHub) | **GET** /project/v1/hubs/{hub_id} |
8-
[**getHubProjects**](HubsApi.md#getHubProjects) | **GET** /project/v1/hubs/{hub_id}/projects |
98
[**getHubs**](HubsApi.md#getHubs) | **GET** /project/v1/hubs |
109

1110

@@ -31,35 +30,6 @@ Name | Type | Description | Notes
3130

3231
[oauth2_access_code](../README.md#authentication)
3332

34-
### HTTP request headers
35-
36-
- **Content-Type**: application/vnd.api+json
37-
- **Accept**: application/vnd.api+json, application/json
38-
39-
<a name="getHubProjects"></a>
40-
# **getHubProjects**
41-
> Projects getHubProjects(hubId, opts, oauth2client, credentials)
42-
43-
44-
45-
Returns a collection of projects for a given &#x60;hub_id&#x60;. A project represents an A360 project or a BIM 360 project which is set up under an A360 hub or BIM 360 account, respectively. Within a hub or an account, multiple projects can be created to be used.
46-
47-
### Parameters
48-
49-
Name | Type | Description | Notes
50-
------------- | ------------- | ------------- | -------------
51-
**hubId** | **String**| the &#x60;hub id&#x60; for the current operation |
52-
**filterId** | [**[String]**](String.md)| filter by the &#x60;id&#x60; of the &#x60;ref&#x60; target | [optional]
53-
**filterExtensionType** | [**[String]**](String.md)| filter by the extension type | [optional]
54-
55-
### Return type
56-
57-
[**Projects**](Projects.md)
58-
59-
### Authorization
60-
61-
[oauth2_access_code](../README.md#authentication)
62-
6333
### HTTP request headers
6434

6535
- **Content-Type**: application/vnd.api+json

‎docs/ItemsApi.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Method | HTTP request | Description
1010
[**getItemRelationshipsRefs**](ItemsApi.md#getItemRelationshipsRefs) | **GET** /data/v1/projects/{project_id}/items/{item_id}/relationships/refs |
1111
[**getItemTip**](ItemsApi.md#getItemTip) | **GET** /data/v1/projects/{project_id}/items/{item_id}/tip |
1212
[**getItemVersions**](ItemsApi.md#getItemVersions) | **GET** /data/v1/projects/{project_id}/items/{item_id}/versions |
13+
[**postItem**](ItemsApi.md#postItem) | **POST** /data/v1/projects/{project_id}/items |
1314
[**postItemRelationshipsRef**](ItemsApi.md#postItemRelationshipsRef) | **POST** /data/v1/projects/{project_id}/items/{item_id}/relationships/refs |
1415

1516

@@ -190,6 +191,34 @@ Name | Type | Description | Notes
190191

191192
[oauth2_access_code](../README.md#authentication)
192193

194+
### HTTP request headers
195+
196+
- **Content-Type**: application/vnd.api+json
197+
- **Accept**: application/vnd.api+json, application/json
198+
199+
<a name="postItem"></a>
200+
# **postItem**
201+
> ItemCreated postItem(projectId, body, oauth2client, credentials)
202+
203+
204+
205+
Creates a new item in the &#39;data&#39; domain service.
206+
207+
### Parameters
208+
209+
Name | Type | Description | Notes
210+
------------- | ------------- | ------------- | -------------
211+
**projectId** | **String**| the &#x60;project id&#x60; |
212+
**body** | [**CreateItem**](CreateItem.md)| describe the item to be created |
213+
214+
### Return type
215+
216+
[**ItemCreated**](ItemCreated.md)
217+
218+
### Authorization
219+
220+
[oauth2_access_code](../README.md#authentication)
221+
193222
### HTTP request headers
194223

195224
- **Content-Type**: application/vnd.api+json

‎docs/ProjectsApi.md

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,32 @@ All URIs are relative to *https://developer.api.autodesk.com/*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7+
[**getHubProjects**](ProjectsApi.md#getHubProjects) | **GET** /project/v1/hubs/{hub_id}/projects |
78
[**getProject**](ProjectsApi.md#getProject) | **GET** /project/v1/hubs/{hub_id}/projects/{project_id} |
89
[**getProjectHub**](ProjectsApi.md#getProjectHub) | **GET** /project/v1/hubs/{hub_id}/projects/{project_id}/hub |
9-
[**postItem**](ProjectsApi.md#postItem) | **POST** /data/v1/projects/{project_id}/items |
10+
[**getProjectTopFolders**](ProjectsApi.md#getProjectTopFolders) | **GET** /project/v1/hubs/{hub_id}/projects/{project_id}/topFolders |
1011
[**postStorage**](ProjectsApi.md#postStorage) | **POST** /data/v1/projects/{project_id}/storage |
11-
[**postVersion**](ProjectsApi.md#postVersion) | **POST** /data/v1/projects/{project_id}/versions |
1212

1313

14-
<a name="getProject"></a>
15-
# **getProject**
16-
> Project getProject(hubId, projectId, oauth2client, credentials)
14+
<a name="getHubProjects"></a>
15+
# **getHubProjects**
16+
> Projects getHubProjects(hubId, opts, oauth2client, credentials)
1717
1818

1919

20-
Returns a project for a given &#x60;project_id&#x60;.
20+
Returns a collection of projects for a given &#x60;hub_id&#x60;. A project represents an A360 project or a BIM 360 project which is set up under an A360 hub or BIM 360 account, respectively. Within a hub or an account, multiple projects can be created to be used.
2121

2222
### Parameters
2323

2424
Name | Type | Description | Notes
2525
------------- | ------------- | ------------- | -------------
2626
**hubId** | **String**| the &#x60;hub id&#x60; for the current operation |
27-
**projectId** | **String**| the &#x60;project id&#x60; |
27+
**filterId** | [**[String]**](String.md)| filter by the &#x60;id&#x60; of the &#x60;ref&#x60; target | [optional]
28+
**filterExtensionType** | [**[String]**](String.md)| filter by the extension type | [optional]
2829

2930
### Return type
3031

31-
[**Project**](Project.md)
32+
[**Projects**](Projects.md)
3233

3334
### Authorization
3435

@@ -39,13 +40,13 @@ Name | Type | Description | Notes
3940
- **Content-Type**: application/vnd.api+json
4041
- **Accept**: application/vnd.api+json, application/json
4142

42-
<a name="getProjectHub"></a>
43-
# **getProjectHub**
44-
> Hub getProjectHub(hubId, projectId, oauth2client, credentials)
43+
<a name="getProject"></a>
44+
# **getProject**
45+
> Project getProject(hubId, projectId, oauth2client, credentials)
4546
4647

4748

48-
Returns the hub for a given &#x60;project_id&#x60;.
49+
Returns a project for a given &#x60;project_id&#x60;.
4950

5051
### Parameters
5152

@@ -56,7 +57,7 @@ Name | Type | Description | Notes
5657

5758
### Return type
5859

59-
[**Hub**](Hub.md)
60+
[**Project**](Project.md)
6061

6162
### Authorization
6263

@@ -67,24 +68,24 @@ Name | Type | Description | Notes
6768
- **Content-Type**: application/vnd.api+json
6869
- **Accept**: application/vnd.api+json, application/json
6970

70-
<a name="postItem"></a>
71-
# **postItem**
72-
> ItemCreated postItem(projectId, body, oauth2client, credentials)
71+
<a name="getProjectHub"></a>
72+
# **getProjectHub**
73+
> Hub getProjectHub(hubId, projectId, oauth2client, credentials)
7374
7475

7576

76-
Creates a new item in the &#39;data&#39; domain service.
77+
Returns the hub for a given &#x60;project_id&#x60;.
7778

7879
### Parameters
7980

8081
Name | Type | Description | Notes
8182
------------- | ------------- | ------------- | -------------
83+
**hubId** | **String**| the &#x60;hub id&#x60; for the current operation |
8284
**projectId** | **String**| the &#x60;project id&#x60; |
83-
**body** | [**CreateItem**](CreateItem.md)| describe the item to be created |
8485

8586
### Return type
8687

87-
[**ItemCreated**](ItemCreated.md)
88+
[**Hub**](Hub.md)
8889

8990
### Authorization
9091

@@ -95,24 +96,24 @@ Name | Type | Description | Notes
9596
- **Content-Type**: application/vnd.api+json
9697
- **Accept**: application/vnd.api+json, application/json
9798

98-
<a name="postStorage"></a>
99-
# **postStorage**
100-
> StorageCreated postStorage(projectId, body, oauth2client, credentials)
99+
<a name="getProjectTopFolders"></a>
100+
# **getProjectTopFolders**
101+
> TopFolders getProjectTopFolders(hubId, projectId, oauth2client, credentials)
101102
102103

103104

104-
Creates a storage location in the OSS where data can be uploaded to.
105+
Returns the details of the highest level folders the user has access to for a given project
105106

106107
### Parameters
107108

108109
Name | Type | Description | Notes
109110
------------- | ------------- | ------------- | -------------
111+
**hubId** | **String**| the &#x60;hub id&#x60; for the current operation |
110112
**projectId** | **String**| the &#x60;project id&#x60; |
111-
**body** | [**CreateStorage**](CreateStorage.md)| describe the file the storage is created for |
112113

113114
### Return type
114115

115-
[**StorageCreated**](StorageCreated.md)
116+
[**TopFolders**](TopFolders.md)
116117

117118
### Authorization
118119

@@ -123,24 +124,24 @@ Name | Type | Description | Notes
123124
- **Content-Type**: application/vnd.api+json
124125
- **Accept**: application/vnd.api+json, application/json
125126

126-
<a name="postVersion"></a>
127-
# **postVersion**
128-
> VersionCreated postVersion(projectId, body, oauth2client, credentials)
127+
<a name="postStorage"></a>
128+
# **postStorage**
129+
> StorageCreated postStorage(projectId, body, oauth2client, credentials)
129130
130131

131132

132-
Creates a new version of an item in the &#39;data&#39; domain service.
133+
Creates a storage location in the OSS where data can be uploaded to.
133134

134135
### Parameters
135136

136137
Name | Type | Description | Notes
137138
------------- | ------------- | ------------- | -------------
138139
**projectId** | **String**| the &#x60;project id&#x60; |
139-
**body** | [**CreateVersion**](CreateVersion.md)| describe the version to be created |
140+
**body** | [**CreateStorage**](CreateStorage.md)| describe the file the storage is created for |
140141

141142
### Return type
142143

143-
[**VersionCreated**](VersionCreated.md)
144+
[**StorageCreated**](StorageCreated.md)
144145

145146
### Authorization
146147

‎docs/ResourceId.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# ForgeSdk.ResourceId
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
7+

‎docs/TopFolders.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ForgeSdk.TopFolders
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**jsonapi** | [**JsonApiVersion**](JsonApiVersion.md) | |
7+
**links** | [**JsonApiLinksSelf**](JsonApiLinksSelf.md) | |
8+
**data** | [**[Folder]**](Folder.md) | |
9+
10+

‎docs/VersionsApi.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Method | HTTP request | Description
88
[**getVersionItem**](VersionsApi.md#getVersionItem) | **GET** /data/v1/projects/{project_id}/versions/{version_id}/item |
99
[**getVersionRefs**](VersionsApi.md#getVersionRefs) | **GET** /data/v1/projects/{project_id}/versions/{version_id}/refs |
1010
[**getVersionRelationshipsRefs**](VersionsApi.md#getVersionRelationshipsRefs) | **GET** /data/v1/projects/{project_id}/versions/{version_id}/relationships/refs |
11+
[**postVersion**](VersionsApi.md#postVersion) | **POST** /data/v1/projects/{project_id}/versions |
1112
[**postVersionRelationshipsRef**](VersionsApi.md#postVersionRelationshipsRef) | **POST** /data/v1/projects/{project_id}/versions/{version_id}/relationships/refs |
1213

1314

@@ -126,6 +127,34 @@ Name | Type | Description | Notes
126127

127128
[oauth2_access_code](../README.md#authentication)
128129

130+
### HTTP request headers
131+
132+
- **Content-Type**: application/vnd.api+json
133+
- **Accept**: application/vnd.api+json, application/json
134+
135+
<a name="postVersion"></a>
136+
# **postVersion**
137+
> VersionCreated postVersion(projectId, body, oauth2client, credentials)
138+
139+
140+
141+
Creates a new version of an item in the &#39;data&#39; domain service.
142+
143+
### Parameters
144+
145+
Name | Type | Description | Notes
146+
------------- | ------------- | ------------- | -------------
147+
**projectId** | **String**| the &#x60;project id&#x60; |
148+
**body** | [**CreateVersion**](CreateVersion.md)| describe the version to be created |
149+
150+
### Return type
151+
152+
[**VersionCreated**](VersionCreated.md)
153+
154+
### Authorization
155+
156+
[oauth2_access_code](../README.md#authentication)
157+
129158
### HTTP request headers
130159

131160
- **Content-Type**: application/vnd.api+json

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "forge-apis",
3-
"version": "0.2.6",
3+
"version": "0.2.7",
44
"description": "The Forge Platform contains an expanding collection of web service components that can be used with Autodesk cloud-based products or your own technologies. Take advantage of Autodesk’s expertise in design and engineering.",
55
"license": "Apache-2.0",
66
"main": "src/index.js",

0 commit comments

Comments
 (0)