diff --git a/README.md b/README.md index e666976..6fe70fa 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # asana [![GitHub release][release-image]][release-url] [![NPM Version][npm-image]][npm-url] - API version: 1.0 -- Package version: 3.0.4 +- Package version: 3.0.5 ## Installation @@ -18,7 +18,7 @@ npm install asana --save Include the latest release directly from GitHub: ```html - + ``` Example usage (**NOTE**: be careful not to expose your access token): @@ -1111,6 +1111,6 @@ client.callApi( ``` [release-image]: https://img.shields.io/github/release/asana/node-asana.svg -[release-url]: https://github.com/Asana/node-asana/releases/tag/v3.0.4 +[release-url]: https://github.com/Asana/node-asana/releases/tag/v3.0.5 [npm-image]: http://img.shields.io/npm/v/asana.svg?style=flat-square [npm-url]: https://www.npmjs.org/package/asana diff --git a/docs/AllocationsApi.md b/docs/AllocationsApi.md index b96233b..7dea686 100644 --- a/docs/AllocationsApi.md +++ b/docs/AllocationsApi.md @@ -187,7 +187,7 @@ Name | Type | Description | Notes **assignee** | **String**| Globally unique identifier for the user the allocation is assigned to. | [optional] **workspace** | **String**| Globally unique identifier for the workspace. | [optional] **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/AttachmentsApi.md b/docs/AttachmentsApi.md index 0332196..38bd229 100644 --- a/docs/AttachmentsApi.md +++ b/docs/AttachmentsApi.md @@ -193,7 +193,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **parent** | **String**| Globally unique identifier for object to fetch statuses from. Must be a GID for a `project`, `project_brief`, or `task`. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/AuditLogAPIApi.md b/docs/AuditLogAPIApi.md index 8149281..a2e98c9 100644 --- a/docs/AuditLogAPIApi.md +++ b/docs/AuditLogAPIApi.md @@ -55,7 +55,7 @@ Name | Type | Description | Notes **actor_gid** | **String**| Filter to events triggered by the actor with this ID. | [optional] **resource_gid** | **String**| Filter to events with this resource ID. | [optional] **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] ### Return type diff --git a/docs/CustomFieldSettingsApi.md b/docs/CustomFieldSettingsApi.md index 41ef55c..ab7a4be 100644 --- a/docs/CustomFieldSettingsApi.md +++ b/docs/CustomFieldSettingsApi.md @@ -45,7 +45,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **portfolio_gid** | **String**| Globally unique identifier for the portfolio. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -95,7 +95,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **project_gid** | **String**| Globally unique identifier for the project. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/CustomFieldsApi.md b/docs/CustomFieldsApi.md index 728b092..63f470e 100644 --- a/docs/CustomFieldsApi.md +++ b/docs/CustomFieldsApi.md @@ -234,7 +234,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_gid** | **String**| Globally unique identifier for the workspace or organization. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/GoalRelationshipsApi.md b/docs/GoalRelationshipsApi.md index 9310da5..ae9747a 100644 --- a/docs/GoalRelationshipsApi.md +++ b/docs/GoalRelationshipsApi.md @@ -143,7 +143,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **supported_goal** | **String**| Globally unique identifier for the supported goal in the goal relationship. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **resource_subtype** | **String**| If provided, filter to goal relationships with a given resource_subtype. | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] diff --git a/docs/GoalsApi.md b/docs/GoalsApi.md index 65fa6ba..f8e38b0 100644 --- a/docs/GoalsApi.md +++ b/docs/GoalsApi.md @@ -296,7 +296,7 @@ Name | Type | Description | Notes **workspace** | **String**| Globally unique identifier for the workspace. | [optional] **time_periods** | **Object**| Globally unique identifiers for the time periods. | [optional] **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/MembershipsApi.md b/docs/MembershipsApi.md index aaa4335..86ac33e 100644 --- a/docs/MembershipsApi.md +++ b/docs/MembershipsApi.md @@ -183,7 +183,7 @@ Name | Type | Description | Notes **parent** | **String**| Globally unique identifier for `goal` or `project`. | [optional] **member** | **String**| Globally unique identifier for `team` or `user`. | [optional] **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/PortfolioMembershipsApi.md b/docs/PortfolioMembershipsApi.md index d06480d..8f752c0 100644 --- a/docs/PortfolioMembershipsApi.md +++ b/docs/PortfolioMembershipsApi.md @@ -96,7 +96,7 @@ Name | Type | Description | Notes **workspace** | **String**| The workspace to filter results on. | [optional] **user** | **String**| A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. | [optional] **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -148,7 +148,7 @@ Name | Type | Description | Notes **portfolio_gid** | **String**| Globally unique identifier for the portfolio. | **user** | **String**| A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. | [optional] **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/PortfoliosApi.md b/docs/PortfoliosApi.md index 0cdd600..b788584 100644 --- a/docs/PortfoliosApi.md +++ b/docs/PortfoliosApi.md @@ -282,7 +282,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **portfolio_gid** | **String**| Globally unique identifier for the portfolio. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -379,7 +379,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace** | **String**| The workspace or organization to filter portfolios on. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **owner** | **String**| The user who owns the portfolio. Currently, API users can only get a list of portfolios that they themselves own, unless the request is made from a Service Account. In the case of a Service Account, if this parameter is specified, then all portfolios owned by this parameter are returned. Otherwise, all portfolios across the workspace are returned. | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] diff --git a/docs/ProjectMembershipsApi.md b/docs/ProjectMembershipsApi.md index 9f175eb..9883534 100644 --- a/docs/ProjectMembershipsApi.md +++ b/docs/ProjectMembershipsApi.md @@ -93,7 +93,7 @@ Name | Type | Description | Notes **project_gid** | **String**| Globally unique identifier for the project. | **user** | **String**| A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. | [optional] **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/ProjectStatusesApi.md b/docs/ProjectStatusesApi.md index 42485a6..0c313c4 100644 --- a/docs/ProjectStatusesApi.md +++ b/docs/ProjectStatusesApi.md @@ -184,7 +184,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **project_gid** | **String**| Globally unique identifier for the project. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/ProjectTemplatesApi.md b/docs/ProjectTemplatesApi.md index 0a1e46e..fe397ea 100644 --- a/docs/ProjectTemplatesApi.md +++ b/docs/ProjectTemplatesApi.md @@ -139,7 +139,7 @@ Name | Type | Description | Notes **workspace** | **String**| The workspace to filter results on. | [optional] **team** | **String**| The team to filter projects on. | [optional] **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -189,7 +189,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **team_gid** | **String**| Globally unique identifier for the team. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/ProjectsApi.md b/docs/ProjectsApi.md index ed25c1b..ff568c1 100644 --- a/docs/ProjectsApi.md +++ b/docs/ProjectsApi.md @@ -486,7 +486,7 @@ projectsApiInstance.getProjects(opts).then((result) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **workspace** | **String**| The workspace or organization to filter projects on. | [optional] **team** | **String**| The team to filter projects on. | [optional] **archived** | **Boolean**| Only return projects whose `archived` field takes on the value of this parameter. | [optional] @@ -539,7 +539,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **task_gid** | **String**| The task to operate on. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -590,7 +590,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **team_gid** | **String**| Globally unique identifier for the team. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **archived** | **Boolean**| Only return projects whose `archived` field takes on the value of this parameter. | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] @@ -642,7 +642,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_gid** | **String**| Globally unique identifier for the workspace or organization. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **archived** | **Boolean**| Only return projects whose `archived` field takes on the value of this parameter. | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] diff --git a/docs/SectionsApi.md b/docs/SectionsApi.md index fa02811..19cc3f1 100644 --- a/docs/SectionsApi.md +++ b/docs/SectionsApi.md @@ -233,7 +233,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **project_gid** | **String**| Globally unique identifier for the project. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/StatusUpdatesApi.md b/docs/StatusUpdatesApi.md index 40ed0e8..744d93a 100644 --- a/docs/StatusUpdatesApi.md +++ b/docs/StatusUpdatesApi.md @@ -47,7 +47,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Object**| The status update to create. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -187,7 +187,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **parent** | **String**| Globally unique identifier for object to fetch statuses from. Must be a GID for a project, portfolio, or goal. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **created_since** | **Date**| Only return statuses that have been created since the given time. | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] diff --git a/docs/StoriesApi.md b/docs/StoriesApi.md index b2bb759..d7b38ca 100644 --- a/docs/StoriesApi.md +++ b/docs/StoriesApi.md @@ -139,7 +139,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **task_gid** | **String**| The task to operate on. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/TagsApi.md b/docs/TagsApi.md index 3c6c158..57379ac 100644 --- a/docs/TagsApi.md +++ b/docs/TagsApi.md @@ -233,7 +233,7 @@ tagsApiInstance.getTags(opts).then((result) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **workspace** | **String**| The workspace to filter tags on. | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] @@ -284,7 +284,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **task_gid** | **String**| The task to operate on. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -334,7 +334,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_gid** | **String**| Globally unique identifier for the workspace or organization. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/TaskTemplatesApi.md b/docs/TaskTemplatesApi.md index eb287a1..225104a 100644 --- a/docs/TaskTemplatesApi.md +++ b/docs/TaskTemplatesApi.md @@ -135,7 +135,7 @@ taskTemplatesApiInstance.getTaskTemplates(opts).then((result) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **project** | **String**| The project to filter task templates on. | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] diff --git a/docs/TasksApi.md b/docs/TasksApi.md index 250bf0f..3e5bd6c 100644 --- a/docs/TasksApi.md +++ b/docs/TasksApi.md @@ -175,7 +175,7 @@ object Add a project to a task -Adds the task to the specified project, in the optional location specified. If no location arguments are given, the task will be added to the end of the project. `addProject` can also be used to reorder a task within a project or section that already contains it. At most one of `insert_before`, `insert_after`, or `section` should be specified. Inserting into a section in an non-order-dependent way can be done by specifying section, otherwise, to insert within a section in a particular place, specify `insert_before` or `insert_after` and a task within the section to anchor the position of this task. Returns an empty data block. +Adds the task to the specified project, in the optional location specified. If no location arguments are given, the task will be added to the end of the project. `addProject` can also be used to reorder a task within a project or section that already contains it. At most one of `insert_before`, `insert_after`, or `section` should be specified. Inserting into a section in an non-order-dependent way can be done by specifying section, otherwise, to insert within a section in a particular place, specify `insert_before` or `insert_after` and a task within the section to anchor the position of this task. A task can have at most 20 projects multi-homed to it. Returns an empty data block. ([more information](https://developers.asana.com/reference/addprojectfortask)) @@ -483,7 +483,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **task_gid** | **String**| The task to operate on. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -533,7 +533,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **task_gid** | **String**| The task to operate on. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -583,7 +583,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **task_gid** | **String**| The task to operate on. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -728,7 +728,7 @@ tasksApiInstance.getTasks(opts).then((result) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **assignee** | **String**| The assignee to filter tasks on. If searching for unassigned tasks, assignee.any = null can be specified. *Note: If you specify `assignee`, you must also specify the `workspace` to filter on.* | [optional] **project** | **String**| The project to filter tasks on. | [optional] **section** | **String**| The section to filter tasks on. | [optional] @@ -786,7 +786,7 @@ Name | Type | Description | Notes **project_gid** | **String**| Globally unique identifier for the project. | **completed_since** | **String**| Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*. | [optional] **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -837,7 +837,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **section_gid** | **String**| The globally unique identifier for the section. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **completed_since** | **String**| Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*. | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] @@ -888,7 +888,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tag_gid** | **String**| Globally unique identifier for the tag. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -940,7 +940,7 @@ Name | Type | Description | Notes **user_task_list_gid** | **String**| Globally unique identifier for the user task list. | **completed_since** | **String**| Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*. | [optional] **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/TeamMembershipsApi.md b/docs/TeamMembershipsApi.md index ce9d2d7..0ef4e32 100644 --- a/docs/TeamMembershipsApi.md +++ b/docs/TeamMembershipsApi.md @@ -94,7 +94,7 @@ teamMembershipsApiInstance.getTeamMemberships(opts).then((result) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **team** | **String**| Globally unique identifier for the team. | [optional] **user** | **String**| A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. This parameter must be used with the workspace parameter. | [optional] **workspace** | **String**| Globally unique identifier for the workspace. This parameter must be used with the user parameter. | [optional] @@ -147,7 +147,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **team_gid** | **String**| Globally unique identifier for the team. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -199,7 +199,7 @@ Name | Type | Description | Notes **user_gid** | **String**| A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. | **workspace** | **String**| Globally unique identifier for the workspace. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/TeamsApi.md b/docs/TeamsApi.md index d389dba..7264597 100644 --- a/docs/TeamsApi.md +++ b/docs/TeamsApi.md @@ -192,7 +192,7 @@ Name | Type | Description | Notes **user_gid** | **String**| A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. | **organization** | **String**| The workspace or organization to filter teams on. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -242,7 +242,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_gid** | **String**| Globally unique identifier for the workspace or organization. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/TimePeriodsApi.md b/docs/TimePeriodsApi.md index 5c1a383..779eaa3 100644 --- a/docs/TimePeriodsApi.md +++ b/docs/TimePeriodsApi.md @@ -93,7 +93,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace** | **String**| Globally unique identifier for the workspace. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **start_on** | **Date**| ISO 8601 date string | [optional] **end_on** | **Date**| ISO 8601 date string | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] diff --git a/docs/TimeTrackingEntriesApi.md b/docs/TimeTrackingEntriesApi.md index 3ecb254..be1be90 100644 --- a/docs/TimeTrackingEntriesApi.md +++ b/docs/TimeTrackingEntriesApi.md @@ -139,7 +139,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **task_gid** | **String**| The task to operate on. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/UsersApi.md b/docs/UsersApi.md index 7131143..60f6922 100644 --- a/docs/UsersApi.md +++ b/docs/UsersApi.md @@ -52,7 +52,7 @@ Name | Type | Description | Notes **resource_type** | **String**| The resource type of favorites to be returned. | [default to project] **workspace** | **String**| The workspace in which to get favorites. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -150,7 +150,7 @@ Name | Type | Description | Notes **workspace** | **String**| The workspace or organization ID to filter users on. | [optional] **team** | **String**| The team ID to filter users on. | [optional] **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -198,7 +198,7 @@ usersApiInstance.getUsersForTeam(team_gid, opts).then((result) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **team_gid** | **String**| Globally unique identifier for the team. | - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -246,7 +246,7 @@ usersApiInstance.getUsersForWorkspace(workspace_gid, opts).then((result) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_gid** | **String**| Globally unique identifier for the workspace or organization. | - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/WebhooksApi.md b/docs/WebhooksApi.md index ae79358..8d12075 100644 --- a/docs/WebhooksApi.md +++ b/docs/WebhooksApi.md @@ -184,7 +184,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace** | **String**| The workspace to query for webhooks in. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **resource** | **String**| Only return webhooks for the given resource. | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] diff --git a/docs/WorkspaceMembershipsApi.md b/docs/WorkspaceMembershipsApi.md index 9298c84..e1c4a66 100644 --- a/docs/WorkspaceMembershipsApi.md +++ b/docs/WorkspaceMembershipsApi.md @@ -92,7 +92,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_gid** | **String**| A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. | **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type @@ -144,7 +144,7 @@ Name | Type | Description | Notes **workspace_gid** | **String**| Globally unique identifier for the workspace or organization. | **user** | **String**| A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. | [optional] **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/docs/WorkspacesApi.md b/docs/WorkspacesApi.md index 54e00f1..ec5cd8c 100644 --- a/docs/WorkspacesApi.md +++ b/docs/WorkspacesApi.md @@ -140,7 +140,7 @@ workspacesApiInstance.getWorkspaces(opts).then((result) => { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] - **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' | [optional] + **offset** | **String**| Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* | [optional] **opt_fields** | **Object**| This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. | [optional] ### Return type diff --git a/package.json b/package.json index 793a2c5..c0314a3 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "asana", - "version": "3.0.4", + "version": "3.0.5", "description": "This_is_the_interface_for_interacting_with_the__Asana_Platform_httpsdevelopers_asana_com__Our_API_reference_is_generated_from_our__OpenAPI_spec__httpsraw_githubusercontent_comAsanaopenapimasterdefsasana_oas_yaml_", "license": "Apache 2.0", "main": "src/index.js", diff --git a/src/ApiClient.js b/src/ApiClient.js index 406df9b..58c56e9 100644 --- a/src/ApiClient.js +++ b/src/ApiClient.js @@ -16,7 +16,7 @@ import superagent from "superagent"; /** * @module ApiClient -* @version 3.0.4 +* @version 3.0.5 */ /** @@ -412,7 +412,7 @@ export class ApiClient { if (typeof(navigator) === 'undefined' || typeof(window) === 'undefined') { headerParams['X-Asana-Client-Lib'] = new URLSearchParams( { - 'version': "3.0.4", + 'version': "3.0.5", 'language': 'NodeJS', 'language_version': process.version, 'os': process.platform @@ -421,7 +421,7 @@ export class ApiClient { } else { headerParams['X-Asana-Client-Lib'] = new URLSearchParams( { - 'version': "3.0.4", + 'version': "3.0.5", 'language': 'BrowserJS' } ).toString(); diff --git a/src/api/AllocationsApi.js b/src/api/AllocationsApi.js index 77d4dda..7528338 100644 --- a/src/api/AllocationsApi.js +++ b/src/api/AllocationsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Allocations service. * @module api/AllocationsApi -* @version 3.0.4 +* @version 3.0.5 */ export class AllocationsApi { @@ -215,7 +215,7 @@ export class AllocationsApi { * @param {String} opts.assignee Globally unique identifier for the user the allocation is assigned to. * @param {String} opts.workspace Globally unique identifier for the workspace. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -281,7 +281,7 @@ export class AllocationsApi { * @param {String} opts.assignee Globally unique identifier for the user the allocation is assigned to. * @param {String} opts.workspace Globally unique identifier for the workspace. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AllocationResponseArray} */ diff --git a/src/api/AttachmentsApi.js b/src/api/AttachmentsApi.js index 47792b2..d13430a 100644 --- a/src/api/AttachmentsApi.js +++ b/src/api/AttachmentsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Attachments service. * @module api/AttachmentsApi -* @version 3.0.4 +* @version 3.0.5 */ export class AttachmentsApi { @@ -219,7 +219,7 @@ export class AttachmentsApi { * @param {String} parent Globally unique identifier for object to fetch statuses from. Must be a GID for a `project`, `project_brief`, or `task`. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -288,7 +288,7 @@ export class AttachmentsApi { * @param {<&vendorExtensions.x-jsdoc-type>} parent Globally unique identifier for object to fetch statuses from. Must be a GID for a `project`, `project_brief`, or `task`. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AttachmentResponseArray} */ diff --git a/src/api/AuditLogAPIApi.js b/src/api/AuditLogAPIApi.js index 8c604d5..2649285 100644 --- a/src/api/AuditLogAPIApi.js +++ b/src/api/AuditLogAPIApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * AuditLogAPI service. * @module api/AuditLogAPIApi -* @version 3.0.4 +* @version 3.0.5 */ export class AuditLogAPIApi { @@ -48,7 +48,7 @@ export class AuditLogAPIApi { * @param {String} opts.actor_gid Filter to events triggered by the actor with this ID. * @param {String} opts.resource_gid Filter to events with this resource ID. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ getAuditLogEventsWithHttpInfo(workspace_gid, opts) { @@ -121,7 +121,7 @@ export class AuditLogAPIApi { * @param {String} opts.actor_gid Filter to events triggered by the actor with this ID. * @param {String} opts.resource_gid Filter to events with this resource ID. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AuditLogEventArray} */ getAuditLogEvents(workspace_gid, opts) { diff --git a/src/api/BatchAPIApi.js b/src/api/BatchAPIApi.js index cde8e18..2de9370 100644 --- a/src/api/BatchAPIApi.js +++ b/src/api/BatchAPIApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * BatchAPI service. * @module api/BatchAPIApi -* @version 3.0.4 +* @version 3.0.5 */ export class BatchAPIApi { diff --git a/src/api/CustomFieldSettingsApi.js b/src/api/CustomFieldSettingsApi.js index 0943475..5111447 100644 --- a/src/api/CustomFieldSettingsApi.js +++ b/src/api/CustomFieldSettingsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * CustomFieldSettings service. * @module api/CustomFieldSettingsApi -* @version 3.0.4 +* @version 3.0.5 */ export class CustomFieldSettingsApi { @@ -42,7 +42,7 @@ export class CustomFieldSettingsApi { * @param {String} portfolio_gid Globally unique identifier for the portfolio. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -110,7 +110,7 @@ export class CustomFieldSettingsApi { * @param {<&vendorExtensions.x-jsdoc-type>} portfolio_gid Globally unique identifier for the portfolio. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CustomFieldSettingResponseArray} */ @@ -133,7 +133,7 @@ export class CustomFieldSettingsApi { * @param {String} project_gid Globally unique identifier for the project. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -201,7 +201,7 @@ export class CustomFieldSettingsApi { * @param {<&vendorExtensions.x-jsdoc-type>} project_gid Globally unique identifier for the project. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CustomFieldSettingResponseArray} */ diff --git a/src/api/CustomFieldsApi.js b/src/api/CustomFieldsApi.js index 451dc79..70b4441 100644 --- a/src/api/CustomFieldsApi.js +++ b/src/api/CustomFieldsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * CustomFields service. * @module api/CustomFieldsApi -* @version 3.0.4 +* @version 3.0.5 */ export class CustomFieldsApi { @@ -274,7 +274,7 @@ export class CustomFieldsApi { * @param {String} workspace_gid Globally unique identifier for the workspace or organization. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -342,7 +342,7 @@ export class CustomFieldsApi { * @param {<&vendorExtensions.x-jsdoc-type>} workspace_gid Globally unique identifier for the workspace or organization. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CustomFieldResponseArray} */ diff --git a/src/api/EventsApi.js b/src/api/EventsApi.js index 9b589e8..31d865b 100644 --- a/src/api/EventsApi.js +++ b/src/api/EventsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Events service. * @module api/EventsApi -* @version 3.0.4 +* @version 3.0.5 */ export class EventsApi { diff --git a/src/api/GoalRelationshipsApi.js b/src/api/GoalRelationshipsApi.js index 77daaf3..494880b 100644 --- a/src/api/GoalRelationshipsApi.js +++ b/src/api/GoalRelationshipsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * GoalRelationships service. * @module api/GoalRelationshipsApi -* @version 3.0.4 +* @version 3.0.5 */ export class GoalRelationshipsApi { @@ -166,7 +166,7 @@ export class GoalRelationshipsApi { * @param {String} supported_goal Globally unique identifier for the supported goal in the goal relationship. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.resource_subtype If provided, filter to goal relationships with a given resource_subtype. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response @@ -236,7 +236,7 @@ export class GoalRelationshipsApi { * @param {<&vendorExtensions.x-jsdoc-type>} supported_goal Globally unique identifier for the supported goal in the goal relationship. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.resource_subtype If provided, filter to goal relationships with a given resource_subtype. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GoalRelationshipResponseArray} diff --git a/src/api/GoalsApi.js b/src/api/GoalsApi.js index a4c1c90..1835886 100644 --- a/src/api/GoalsApi.js +++ b/src/api/GoalsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Goals service. * @module api/GoalsApi -* @version 3.0.4 +* @version 3.0.5 */ export class GoalsApi { @@ -349,7 +349,7 @@ export class GoalsApi { * @param {String} opts.workspace Globally unique identifier for the workspace. * @param {Array.} opts.time_periods Globally unique identifiers for the time periods. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -419,7 +419,7 @@ export class GoalsApi { * @param {String} opts.workspace Globally unique identifier for the workspace. * @param {Array.} opts.time_periods Globally unique identifiers for the time periods. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GoalResponseArray} */ diff --git a/src/api/JobsApi.js b/src/api/JobsApi.js index ba17fa9..9fb2bfe 100644 --- a/src/api/JobsApi.js +++ b/src/api/JobsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Jobs service. * @module api/JobsApi -* @version 3.0.4 +* @version 3.0.5 */ export class JobsApi { diff --git a/src/api/MembershipsApi.js b/src/api/MembershipsApi.js index 1425411..93a0eed 100644 --- a/src/api/MembershipsApi.js +++ b/src/api/MembershipsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Memberships service. * @module api/MembershipsApi -* @version 3.0.4 +* @version 3.0.5 */ export class MembershipsApi { @@ -208,7 +208,7 @@ export class MembershipsApi { * @param {String} opts.parent Globally unique identifier for `goal` or `project`. * @param {String} opts.member Globally unique identifier for `team` or `user`. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -273,7 +273,7 @@ export class MembershipsApi { * @param {String} opts.parent Globally unique identifier for `goal` or `project`. * @param {String} opts.member Globally unique identifier for `team` or `user`. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MembershipResponseArray} */ diff --git a/src/api/OrganizationExportsApi.js b/src/api/OrganizationExportsApi.js index 7599a99..7f9716b 100644 --- a/src/api/OrganizationExportsApi.js +++ b/src/api/OrganizationExportsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * OrganizationExports service. * @module api/OrganizationExportsApi -* @version 3.0.4 +* @version 3.0.5 */ export class OrganizationExportsApi { diff --git a/src/api/PortfolioMembershipsApi.js b/src/api/PortfolioMembershipsApi.js index 433744d..41f6073 100644 --- a/src/api/PortfolioMembershipsApi.js +++ b/src/api/PortfolioMembershipsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * PortfolioMemberships service. * @module api/PortfolioMembershipsApi -* @version 3.0.4 +* @version 3.0.5 */ export class PortfolioMembershipsApi { @@ -103,7 +103,7 @@ export class PortfolioMembershipsApi { * @param {String} opts.workspace The workspace to filter results on. * @param {String} opts.user A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -169,7 +169,7 @@ export class PortfolioMembershipsApi { * @param {String} opts.workspace The workspace to filter results on. * @param {String} opts.user A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PortfolioMembershipResponseArray} */ @@ -193,7 +193,7 @@ export class PortfolioMembershipsApi { * @param {Object} opts Optional parameters * @param {String} opts.user A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -262,7 +262,7 @@ export class PortfolioMembershipsApi { * @param {Object} opts Optional parameters * @param {String} opts.user A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PortfolioMembershipResponseArray} */ diff --git a/src/api/PortfoliosApi.js b/src/api/PortfoliosApi.js index fd2c227..8277819 100644 --- a/src/api/PortfoliosApi.js +++ b/src/api/PortfoliosApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Portfolios service. * @module api/PortfoliosApi -* @version 3.0.4 +* @version 3.0.5 */ export class PortfoliosApi { @@ -337,7 +337,7 @@ export class PortfoliosApi { * @param {String} portfolio_gid Globally unique identifier for the portfolio. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -405,7 +405,7 @@ export class PortfoliosApi { * @param {<&vendorExtensions.x-jsdoc-type>} portfolio_gid Globally unique identifier for the portfolio. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProjectResponseArray} */ @@ -487,7 +487,7 @@ export class PortfoliosApi { * @param {String} workspace The workspace or organization to filter portfolios on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.owner The user who owns the portfolio. Currently, API users can only get a list of portfolios that they themselves own, unless the request is made from a Service Account. In the case of a Service Account, if this parameter is specified, then all portfolios owned by this parameter are returned. Otherwise, all portfolios across the workspace are returned. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response @@ -557,7 +557,7 @@ export class PortfoliosApi { * @param {<&vendorExtensions.x-jsdoc-type>} workspace The workspace or organization to filter portfolios on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.owner The user who owns the portfolio. Currently, API users can only get a list of portfolios that they themselves own, unless the request is made from a Service Account. In the case of a Service Account, if this parameter is specified, then all portfolios owned by this parameter are returned. Otherwise, all portfolios across the workspace are returned. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PortfolioResponseArray} diff --git a/src/api/ProjectBriefsApi.js b/src/api/ProjectBriefsApi.js index 2c8233b..d01fa2c 100644 --- a/src/api/ProjectBriefsApi.js +++ b/src/api/ProjectBriefsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * ProjectBriefs service. * @module api/ProjectBriefsApi -* @version 3.0.4 +* @version 3.0.5 */ export class ProjectBriefsApi { diff --git a/src/api/ProjectMembershipsApi.js b/src/api/ProjectMembershipsApi.js index e1365c0..f2211af 100644 --- a/src/api/ProjectMembershipsApi.js +++ b/src/api/ProjectMembershipsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * ProjectMemberships service. * @module api/ProjectMembershipsApi -* @version 3.0.4 +* @version 3.0.5 */ export class ProjectMembershipsApi { @@ -102,7 +102,7 @@ export class ProjectMembershipsApi { * @param {Object} opts Optional parameters * @param {String} opts.user A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -171,7 +171,7 @@ export class ProjectMembershipsApi { * @param {Object} opts Optional parameters * @param {String} opts.user A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProjectMembershipCompactArray} */ diff --git a/src/api/ProjectStatusesApi.js b/src/api/ProjectStatusesApi.js index eeedbac..f178b0c 100644 --- a/src/api/ProjectStatusesApi.js +++ b/src/api/ProjectStatusesApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * ProjectStatuses service. * @module api/ProjectStatusesApi -* @version 3.0.4 +* @version 3.0.5 */ export class ProjectStatusesApi { @@ -219,7 +219,7 @@ export class ProjectStatusesApi { * @param {String} project_gid Globally unique identifier for the project. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -287,7 +287,7 @@ export class ProjectStatusesApi { * @param {<&vendorExtensions.x-jsdoc-type>} project_gid Globally unique identifier for the project. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProjectStatusResponseArray} */ diff --git a/src/api/ProjectTemplatesApi.js b/src/api/ProjectTemplatesApi.js index df985b5..6002153 100644 --- a/src/api/ProjectTemplatesApi.js +++ b/src/api/ProjectTemplatesApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * ProjectTemplates service. * @module api/ProjectTemplatesApi -* @version 3.0.4 +* @version 3.0.5 */ export class ProjectTemplatesApi { @@ -155,7 +155,7 @@ export class ProjectTemplatesApi { * @param {String} opts.workspace The workspace to filter results on. * @param {String} opts.team The team to filter projects on. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -220,7 +220,7 @@ export class ProjectTemplatesApi { * @param {String} opts.workspace The workspace to filter results on. * @param {String} opts.team The team to filter projects on. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProjectTemplateResponseArray} */ @@ -243,7 +243,7 @@ export class ProjectTemplatesApi { * @param {String} team_gid Globally unique identifier for the team. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -311,7 +311,7 @@ export class ProjectTemplatesApi { * @param {<&vendorExtensions.x-jsdoc-type>} team_gid Globally unique identifier for the team. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProjectTemplateResponseArray} */ diff --git a/src/api/ProjectsApi.js b/src/api/ProjectsApi.js index 611d85e..5ce366f 100644 --- a/src/api/ProjectsApi.js +++ b/src/api/ProjectsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Projects service. * @module api/ProjectsApi -* @version 3.0.4 +* @version 3.0.5 */ export class ProjectsApi { @@ -598,7 +598,7 @@ export class ProjectsApi { * Returns the compact project records for some filtered set of projects. Use one or more of the parameters provided to filter the projects returned. *Note: This endpoint may timeout for large domains. Try filtering by team!* * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.workspace The workspace or organization to filter projects on. * @param {String} opts.team The team to filter projects on. * @param {Boolean} opts.archived Only return projects whose `archived` field takes on the value of this parameter. @@ -664,7 +664,7 @@ export class ProjectsApi { * Returns the compact project records for some filtered set of projects. Use one or more of the parameters provided to filter the projects returned. *Note: This endpoint may timeout for large domains. Try filtering by team!* * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.workspace The workspace or organization to filter projects on. * @param {String} opts.team The team to filter projects on. * @param {Boolean} opts.archived Only return projects whose `archived` field takes on the value of this parameter. @@ -690,7 +690,7 @@ export class ProjectsApi { * @param {String} task_gid The task to operate on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -758,7 +758,7 @@ export class ProjectsApi { * @param {<&vendorExtensions.x-jsdoc-type>} task_gid The task to operate on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProjectResponseArray} */ @@ -781,7 +781,7 @@ export class ProjectsApi { * @param {String} team_gid Globally unique identifier for the team. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Boolean} opts.archived Only return projects whose `archived` field takes on the value of this parameter. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response @@ -850,7 +850,7 @@ export class ProjectsApi { * @param {<&vendorExtensions.x-jsdoc-type>} team_gid Globally unique identifier for the team. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Boolean} opts.archived Only return projects whose `archived` field takes on the value of this parameter. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProjectResponseArray} @@ -874,7 +874,7 @@ export class ProjectsApi { * @param {String} workspace_gid Globally unique identifier for the workspace or organization. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Boolean} opts.archived Only return projects whose `archived` field takes on the value of this parameter. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response @@ -943,7 +943,7 @@ export class ProjectsApi { * @param {<&vendorExtensions.x-jsdoc-type>} workspace_gid Globally unique identifier for the workspace or organization. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Boolean} opts.archived Only return projects whose `archived` field takes on the value of this parameter. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProjectResponseArray} diff --git a/src/api/RulesApi.js b/src/api/RulesApi.js index 2235f78..cd0ab34 100644 --- a/src/api/RulesApi.js +++ b/src/api/RulesApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Rules service. * @module api/RulesApi -* @version 3.0.4 +* @version 3.0.5 */ export class RulesApi { diff --git a/src/api/SectionsApi.js b/src/api/SectionsApi.js index 1280443..5a02eb8 100644 --- a/src/api/SectionsApi.js +++ b/src/api/SectionsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Sections service. * @module api/SectionsApi -* @version 3.0.4 +* @version 3.0.5 */ export class SectionsApi { @@ -274,7 +274,7 @@ export class SectionsApi { * @param {String} project_gid Globally unique identifier for the project. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -342,7 +342,7 @@ export class SectionsApi { * @param {<&vendorExtensions.x-jsdoc-type>} project_gid Globally unique identifier for the project. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SectionResponseArray} */ diff --git a/src/api/StatusUpdatesApi.js b/src/api/StatusUpdatesApi.js index 4793d84..3280f4f 100644 --- a/src/api/StatusUpdatesApi.js +++ b/src/api/StatusUpdatesApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * StatusUpdates service. * @module api/StatusUpdatesApi -* @version 3.0.4 +* @version 3.0.5 */ export class StatusUpdatesApi { @@ -42,7 +42,7 @@ export class StatusUpdatesApi { * @param {module:model/Object} body The status update to create. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -86,7 +86,7 @@ export class StatusUpdatesApi { * @param {<&vendorExtensions.x-jsdoc-type>} body The status update to create. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/StatusUpdateResponseData} */ @@ -217,7 +217,7 @@ export class StatusUpdatesApi { * @param {String} parent Globally unique identifier for object to fetch statuses from. Must be a GID for a project, portfolio, or goal. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Date} opts.created_since Only return statuses that have been created since the given time. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response @@ -287,7 +287,7 @@ export class StatusUpdatesApi { * @param {<&vendorExtensions.x-jsdoc-type>} parent Globally unique identifier for object to fetch statuses from. Must be a GID for a project, portfolio, or goal. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Date} opts.created_since Only return statuses that have been created since the given time. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/StatusUpdateResponseArray} diff --git a/src/api/StoriesApi.js b/src/api/StoriesApi.js index c30f81d..5e4d63c 100644 --- a/src/api/StoriesApi.js +++ b/src/api/StoriesApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Stories service. * @module api/StoriesApi -* @version 3.0.4 +* @version 3.0.5 */ export class StoriesApi { @@ -160,7 +160,7 @@ export class StoriesApi { * @param {String} task_gid The task to operate on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -228,7 +228,7 @@ export class StoriesApi { * @param {<&vendorExtensions.x-jsdoc-type>} task_gid The task to operate on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/StoryResponseArray} */ diff --git a/src/api/TagsApi.js b/src/api/TagsApi.js index 446801e..d0b263c 100644 --- a/src/api/TagsApi.js +++ b/src/api/TagsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Tags service. * @module api/TagsApi -* @version 3.0.4 +* @version 3.0.5 */ export class TagsApi { @@ -277,7 +277,7 @@ export class TagsApi { * Returns the compact tag records for some filtered set of tags. Use one or more of the parameters provided to filter the tags returned. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.workspace The workspace to filter tags on. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response @@ -341,7 +341,7 @@ export class TagsApi { * Returns the compact tag records for some filtered set of tags. Use one or more of the parameters provided to filter the tags returned. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.workspace The workspace to filter tags on. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TagResponseArray} @@ -365,7 +365,7 @@ export class TagsApi { * @param {String} task_gid The task to operate on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -433,7 +433,7 @@ export class TagsApi { * @param {<&vendorExtensions.x-jsdoc-type>} task_gid The task to operate on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TagResponseArray} */ @@ -456,7 +456,7 @@ export class TagsApi { * @param {String} workspace_gid Globally unique identifier for the workspace or organization. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -524,7 +524,7 @@ export class TagsApi { * @param {<&vendorExtensions.x-jsdoc-type>} workspace_gid Globally unique identifier for the workspace or organization. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TagResponseArray} */ diff --git a/src/api/TaskTemplatesApi.js b/src/api/TaskTemplatesApi.js index e3ebae6..7a83043 100644 --- a/src/api/TaskTemplatesApi.js +++ b/src/api/TaskTemplatesApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * TaskTemplates service. * @module api/TaskTemplatesApi -* @version 3.0.4 +* @version 3.0.5 */ export class TaskTemplatesApi { @@ -153,7 +153,7 @@ export class TaskTemplatesApi { * Returns the compact task template records for some filtered set of task templates. You must specify a `project` * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.project The project to filter task templates on. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response @@ -217,7 +217,7 @@ export class TaskTemplatesApi { * Returns the compact task template records for some filtered set of task templates. You must specify a `project` * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.project The project to filter task templates on. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TaskTemplateResponseArray} diff --git a/src/api/TasksApi.js b/src/api/TasksApi.js index 75091f0..73c86f8 100644 --- a/src/api/TasksApi.js +++ b/src/api/TasksApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Tasks service. * @module api/TasksApi -* @version 3.0.4 +* @version 3.0.5 */ export class TasksApi { @@ -221,7 +221,7 @@ export class TasksApi { /** * Add a project to a task - * Adds the task to the specified project, in the optional location specified. If no location arguments are given, the task will be added to the end of the project. `addProject` can also be used to reorder a task within a project or section that already contains it. At most one of `insert_before`, `insert_after`, or `section` should be specified. Inserting into a section in an non-order-dependent way can be done by specifying section, otherwise, to insert within a section in a particular place, specify `insert_before` or `insert_after` and a task within the section to anchor the position of this task. Returns an empty data block. + * Adds the task to the specified project, in the optional location specified. If no location arguments are given, the task will be added to the end of the project. `addProject` can also be used to reorder a task within a project or section that already contains it. At most one of `insert_before`, `insert_after`, or `section` should be specified. Inserting into a section in an non-order-dependent way can be done by specifying section, otherwise, to insert within a section in a particular place, specify `insert_before` or `insert_after` and a task within the section to anchor the position of this task. A task can have at most 20 projects multi-homed to it. Returns an empty data block. * @param {module:model/Object} body The project to add the task to. * @param {String} task_gid The task to operate on. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response @@ -264,7 +264,7 @@ export class TasksApi { /** * Add a project to a task - * Adds the task to the specified project, in the optional location specified. If no location arguments are given, the task will be added to the end of the project. `addProject` can also be used to reorder a task within a project or section that already contains it. At most one of `insert_before`, `insert_after`, or `section` should be specified. Inserting into a section in an non-order-dependent way can be done by specifying section, otherwise, to insert within a section in a particular place, specify `insert_before` or `insert_after` and a task within the section to anchor the position of this task. Returns an empty data block. + * Adds the task to the specified project, in the optional location specified. If no location arguments are given, the task will be added to the end of the project. `addProject` can also be used to reorder a task within a project or section that already contains it. At most one of `insert_before`, `insert_after`, or `section` should be specified. Inserting into a section in an non-order-dependent way can be done by specifying section, otherwise, to insert within a section in a particular place, specify `insert_before` or `insert_after` and a task within the section to anchor the position of this task. A task can have at most 20 projects multi-homed to it. Returns an empty data block. * @param {<&vendorExtensions.x-jsdoc-type>} body The project to add the task to. * @param {<&vendorExtensions.x-jsdoc-type>} task_gid The task to operate on. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EmptyResponseData} @@ -585,7 +585,7 @@ export class TasksApi { * @param {String} task_gid The task to operate on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -653,7 +653,7 @@ export class TasksApi { * @param {<&vendorExtensions.x-jsdoc-type>} task_gid The task to operate on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TaskResponseArray} */ @@ -676,7 +676,7 @@ export class TasksApi { * @param {String} task_gid The task to operate on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -744,7 +744,7 @@ export class TasksApi { * @param {<&vendorExtensions.x-jsdoc-type>} task_gid The task to operate on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TaskResponseArray} */ @@ -767,7 +767,7 @@ export class TasksApi { * @param {String} task_gid The task to operate on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -835,7 +835,7 @@ export class TasksApi { * @param {<&vendorExtensions.x-jsdoc-type>} task_gid The task to operate on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TaskResponseArray} */ @@ -975,7 +975,7 @@ export class TasksApi { * Returns the compact task records for some filtered set of tasks. Use one or more of the parameters provided to filter the tasks returned. You must specify a `project` or `tag` if you do not specify `assignee` and `workspace`. For more complex task retrieval, use [workspaces/{workspace_gid}/tasks/search](/reference/searchtasksforworkspace). * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.assignee The assignee to filter tasks on. If searching for unassigned tasks, assignee.any = null can be specified. *Note: If you specify `assignee`, you must also specify the `workspace` to filter on.* * @param {String} opts.project The project to filter tasks on. * @param {String} opts.section The section to filter tasks on. @@ -1044,7 +1044,7 @@ export class TasksApi { * Returns the compact task records for some filtered set of tasks. Use one or more of the parameters provided to filter the tasks returned. You must specify a `project` or `tag` if you do not specify `assignee` and `workspace`. For more complex task retrieval, use [workspaces/{workspace_gid}/tasks/search](/reference/searchtasksforworkspace). * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.assignee The assignee to filter tasks on. If searching for unassigned tasks, assignee.any = null can be specified. *Note: If you specify `assignee`, you must also specify the `workspace` to filter on.* * @param {String} opts.project The project to filter tasks on. * @param {String} opts.section The section to filter tasks on. @@ -1074,7 +1074,7 @@ export class TasksApi { * @param {Object} opts Optional parameters * @param {String} opts.completed_since Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -1143,7 +1143,7 @@ export class TasksApi { * @param {Object} opts Optional parameters * @param {String} opts.completed_since Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TaskResponseArray} */ @@ -1166,7 +1166,7 @@ export class TasksApi { * @param {String} section_gid The globally unique identifier for the section. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.completed_since Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response @@ -1235,7 +1235,7 @@ export class TasksApi { * @param {<&vendorExtensions.x-jsdoc-type>} section_gid The globally unique identifier for the section. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.completed_since Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TaskResponseArray} @@ -1259,7 +1259,7 @@ export class TasksApi { * @param {String} tag_gid Globally unique identifier for the tag. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -1327,7 +1327,7 @@ export class TasksApi { * @param {<&vendorExtensions.x-jsdoc-type>} tag_gid Globally unique identifier for the tag. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TaskResponseArray} */ @@ -1351,7 +1351,7 @@ export class TasksApi { * @param {Object} opts Optional parameters * @param {String} opts.completed_since Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -1420,7 +1420,7 @@ export class TasksApi { * @param {Object} opts Optional parameters * @param {String} opts.completed_since Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TaskResponseArray} */ diff --git a/src/api/TeamMembershipsApi.js b/src/api/TeamMembershipsApi.js index 2b98003..a4540d3 100644 --- a/src/api/TeamMembershipsApi.js +++ b/src/api/TeamMembershipsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * TeamMemberships service. * @module api/TeamMembershipsApi -* @version 3.0.4 +* @version 3.0.5 */ export class TeamMembershipsApi { @@ -100,7 +100,7 @@ export class TeamMembershipsApi { * Returns compact team membership records. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.team Globally unique identifier for the team. * @param {String} opts.user A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. This parameter must be used with the workspace parameter. * @param {String} opts.workspace Globally unique identifier for the workspace. This parameter must be used with the user parameter. @@ -166,7 +166,7 @@ export class TeamMembershipsApi { * Returns compact team membership records. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.team Globally unique identifier for the team. * @param {String} opts.user A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. This parameter must be used with the workspace parameter. * @param {String} opts.workspace Globally unique identifier for the workspace. This parameter must be used with the user parameter. @@ -192,7 +192,7 @@ export class TeamMembershipsApi { * @param {String} team_gid Globally unique identifier for the team. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -260,7 +260,7 @@ export class TeamMembershipsApi { * @param {<&vendorExtensions.x-jsdoc-type>} team_gid Globally unique identifier for the team. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TeamMembershipResponseArray} */ @@ -284,7 +284,7 @@ export class TeamMembershipsApi { * @param {String} workspace Globally unique identifier for the workspace. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -358,7 +358,7 @@ export class TeamMembershipsApi { * @param {<&vendorExtensions.x-jsdoc-type>} workspace Globally unique identifier for the workspace. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TeamMembershipResponseArray} */ diff --git a/src/api/TeamsApi.js b/src/api/TeamsApi.js index fc42b1d..2c6813e 100644 --- a/src/api/TeamsApi.js +++ b/src/api/TeamsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Teams service. * @module api/TeamsApi -* @version 3.0.4 +* @version 3.0.5 */ export class TeamsApi { @@ -226,7 +226,7 @@ export class TeamsApi { * @param {String} organization The workspace or organization to filter teams on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -300,7 +300,7 @@ export class TeamsApi { * @param {<&vendorExtensions.x-jsdoc-type>} organization The workspace or organization to filter teams on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TeamResponseArray} */ @@ -323,7 +323,7 @@ export class TeamsApi { * @param {String} workspace_gid Globally unique identifier for the workspace or organization. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -391,7 +391,7 @@ export class TeamsApi { * @param {<&vendorExtensions.x-jsdoc-type>} workspace_gid Globally unique identifier for the workspace or organization. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TeamResponseArray} */ diff --git a/src/api/TimePeriodsApi.js b/src/api/TimePeriodsApi.js index 1180643..52e4bc3 100644 --- a/src/api/TimePeriodsApi.js +++ b/src/api/TimePeriodsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * TimePeriods service. * @module api/TimePeriodsApi -* @version 3.0.4 +* @version 3.0.5 */ export class TimePeriodsApi { @@ -101,7 +101,7 @@ export class TimePeriodsApi { * @param {String} workspace Globally unique identifier for the workspace. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Date} opts.start_on ISO 8601 date string * @param {Date} opts.end_on ISO 8601 date string * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. @@ -172,7 +172,7 @@ export class TimePeriodsApi { * @param {<&vendorExtensions.x-jsdoc-type>} workspace Globally unique identifier for the workspace. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Date} opts.start_on ISO 8601 date string * @param {Date} opts.end_on ISO 8601 date string * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. diff --git a/src/api/TimeTrackingEntriesApi.js b/src/api/TimeTrackingEntriesApi.js index 0cacfc0..998b073 100644 --- a/src/api/TimeTrackingEntriesApi.js +++ b/src/api/TimeTrackingEntriesApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * TimeTrackingEntries service. * @module api/TimeTrackingEntriesApi -* @version 3.0.4 +* @version 3.0.5 */ export class TimeTrackingEntriesApi { @@ -160,7 +160,7 @@ export class TimeTrackingEntriesApi { * @param {String} task_gid The task to operate on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -228,7 +228,7 @@ export class TimeTrackingEntriesApi { * @param {<&vendorExtensions.x-jsdoc-type>} task_gid The task to operate on. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TimeTrackingEntryCompactArray} */ diff --git a/src/api/TypeaheadApi.js b/src/api/TypeaheadApi.js index cad034d..1e6e1cc 100644 --- a/src/api/TypeaheadApi.js +++ b/src/api/TypeaheadApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Typeahead service. * @module api/TypeaheadApi -* @version 3.0.4 +* @version 3.0.5 */ export class TypeaheadApi { diff --git a/src/api/UserTaskListsApi.js b/src/api/UserTaskListsApi.js index 4d50468..bd0ec0d 100644 --- a/src/api/UserTaskListsApi.js +++ b/src/api/UserTaskListsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * UserTaskLists service. * @module api/UserTaskListsApi -* @version 3.0.4 +* @version 3.0.5 */ export class UserTaskListsApi { diff --git a/src/api/UsersApi.js b/src/api/UsersApi.js index c55fb95..405d959 100644 --- a/src/api/UsersApi.js +++ b/src/api/UsersApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Users service. * @module api/UsersApi -* @version 3.0.4 +* @version 3.0.5 */ export class UsersApi { @@ -44,7 +44,7 @@ export class UsersApi { * @param {String} workspace The workspace in which to get favorites. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -124,7 +124,7 @@ export class UsersApi { * @param {<&vendorExtensions.x-jsdoc-type>} workspace The workspace in which to get favorites. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AsanaNamedResourceArray} */ @@ -207,7 +207,7 @@ export class UsersApi { * @param {String} opts.workspace The workspace or organization ID to filter users on. * @param {String} opts.team The team ID to filter users on. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -272,7 +272,7 @@ export class UsersApi { * @param {String} opts.workspace The workspace or organization ID to filter users on. * @param {String} opts.team The team ID to filter users on. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UserResponseArray} */ @@ -294,7 +294,7 @@ export class UsersApi { * Returns the compact records for all users that are members of the team. Results are sorted alphabetically and limited to 2000. For more results use the `/users` endpoint. * @param {String} team_gid Globally unique identifier for the team. * @param {Object} opts Optional parameters - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -361,7 +361,7 @@ export class UsersApi { * Returns the compact records for all users that are members of the team. Results are sorted alphabetically and limited to 2000. For more results use the `/users` endpoint. * @param {<&vendorExtensions.x-jsdoc-type>} team_gid Globally unique identifier for the team. * @param {Object} opts Optional parameters - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UserResponseArray} */ @@ -383,7 +383,7 @@ export class UsersApi { * Returns the compact records for all users in the specified workspace or organization. Results are sorted alphabetically and limited to 2000. For more results use the `/users` endpoint. * @param {String} workspace_gid Globally unique identifier for the workspace or organization. * @param {Object} opts Optional parameters - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -450,7 +450,7 @@ export class UsersApi { * Returns the compact records for all users in the specified workspace or organization. Results are sorted alphabetically and limited to 2000. For more results use the `/users` endpoint. * @param {<&vendorExtensions.x-jsdoc-type>} workspace_gid Globally unique identifier for the workspace or organization. * @param {Object} opts Optional parameters - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UserResponseArray} */ diff --git a/src/api/WebhooksApi.js b/src/api/WebhooksApi.js index be5f836..b309756 100644 --- a/src/api/WebhooksApi.js +++ b/src/api/WebhooksApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Webhooks service. * @module api/WebhooksApi -* @version 3.0.4 +* @version 3.0.5 */ export class WebhooksApi { @@ -213,7 +213,7 @@ export class WebhooksApi { * @param {String} workspace The workspace to query for webhooks in. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.resource Only return webhooks for the given resource. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response @@ -283,7 +283,7 @@ export class WebhooksApi { * @param {<&vendorExtensions.x-jsdoc-type>} workspace The workspace to query for webhooks in. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {String} opts.resource Only return webhooks for the given resource. * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/WebhookResponseArray} diff --git a/src/api/WorkspaceMembershipsApi.js b/src/api/WorkspaceMembershipsApi.js index 0a95cea..f3e46fc 100644 --- a/src/api/WorkspaceMembershipsApi.js +++ b/src/api/WorkspaceMembershipsApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * WorkspaceMemberships service. * @module api/WorkspaceMembershipsApi -* @version 3.0.4 +* @version 3.0.5 */ export class WorkspaceMembershipsApi { @@ -101,7 +101,7 @@ export class WorkspaceMembershipsApi { * @param {String} user_gid A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -169,7 +169,7 @@ export class WorkspaceMembershipsApi { * @param {<&vendorExtensions.x-jsdoc-type>} user_gid A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/WorkspaceMembershipResponseArray} */ @@ -193,7 +193,7 @@ export class WorkspaceMembershipsApi { * @param {Object} opts Optional parameters * @param {String} opts.user A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -262,7 +262,7 @@ export class WorkspaceMembershipsApi { * @param {Object} opts Optional parameters * @param {String} opts.user A string identifying a user. This can either be the string \"me\", an email, or the gid of a user. * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/WorkspaceMembershipResponseArray} */ diff --git a/src/api/WorkspacesApi.js b/src/api/WorkspacesApi.js index 95fd678..13a4b78 100644 --- a/src/api/WorkspacesApi.js +++ b/src/api/WorkspacesApi.js @@ -18,7 +18,7 @@ var Collection = require('../utils/collection'); /** * Workspaces service. * @module api/WorkspacesApi -* @version 3.0.4 +* @version 3.0.5 */ export class WorkspacesApi { @@ -165,7 +165,7 @@ export class WorkspacesApi { * Returns the compact records for all workspaces visible to the authorized user. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response */ @@ -228,7 +228,7 @@ export class WorkspacesApi { * Returns the compact records for all workspaces visible to the authorized user. * @param {Object} opts Optional parameters * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100. - * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' + * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.* * @param {Array.} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/WorkspaceResponseArray} */ diff --git a/src/index.js b/src/index.js index 84f6729..01290c1 100644 --- a/src/index.js +++ b/src/index.js @@ -79,7 +79,7 @@ import {WorkspacesApi} from './api/WorkspacesApi'; * *

* @module index -* @version 3.0.4 +* @version 3.0.5 */ export { /**