@cosmotech/api-ts 5.1.0 → 5.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/.github/workflows/publish.yaml +2 -2
  2. package/.openapi-generator/FILES +19 -0
  3. package/.openapi-generator/VERSION +1 -1
  4. package/README.md +27 -2
  5. package/api.ts +839 -16
  6. package/base.ts +1 -1
  7. package/common.ts +3 -3
  8. package/configuration.ts +2 -1
  9. package/dist/api.d.ts +620 -102
  10. package/dist/api.js +715 -5
  11. package/dist/base.d.ts +1 -1
  12. package/dist/base.js +1 -1
  13. package/dist/common.d.ts +1 -1
  14. package/dist/common.js +1 -1
  15. package/dist/configuration.d.ts +1 -1
  16. package/dist/configuration.js +2 -2
  17. package/dist/index.d.ts +1 -1
  18. package/dist/index.js +1 -1
  19. package/docs/DatasetApi.md +59 -0
  20. package/docs/DatasetMemberGroup.md +25 -0
  21. package/docs/DatasetMemberUser.md +23 -0
  22. package/docs/DatasetMembers.md +23 -0
  23. package/docs/IAMInfoApi.md +95 -0
  24. package/docs/MemberGroup.md +25 -0
  25. package/docs/MemberUser.md +23 -0
  26. package/docs/Members.md +23 -0
  27. package/docs/OrganizationApi.md +52 -0
  28. package/docs/OrganizationMemberGroup.md +25 -0
  29. package/docs/OrganizationMemberUser.md +23 -0
  30. package/docs/OrganizationMembers.md +23 -0
  31. package/docs/RunnerApi.md +59 -0
  32. package/docs/RunnerMemberGroup.md +25 -0
  33. package/docs/RunnerMemberUser.md +23 -0
  34. package/docs/RunnerMembers.md +23 -0
  35. package/docs/SolutionApi.md +56 -0
  36. package/docs/SolutionMemberGroup.md +25 -0
  37. package/docs/SolutionMemberUser.md +23 -0
  38. package/docs/SolutionMembers.md +23 -0
  39. package/docs/WorkspaceApi.md +56 -0
  40. package/docs/WorkspaceMemberGroup.md +25 -0
  41. package/docs/WorkspaceMemberUser.md +23 -0
  42. package/docs/WorkspaceMembers.md +23 -0
  43. package/git_push.sh +14 -17
  44. package/index.ts +1 -1
  45. package/package.json +3 -3
@@ -0,0 +1,23 @@
1
+ # RunnerMembers
2
+
3
+ The Runner members, including users and groups
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **users** | [**Array<RunnerMemberUser>**](RunnerMemberUser.md) | The list of users in the runner | [default to undefined]
10
+ **groups** | [**Array<RunnerMemberGroup>**](RunnerMemberGroup.md) | The list of groups in the runner | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { RunnerMembers } from '@cosmotech/api-ts';
16
+
17
+ const instance: RunnerMembers = {
18
+ users,
19
+ groups,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -17,6 +17,7 @@ All URIs are relative to *http://localhost:8080*
17
17
  |[**getRunTemplate**](#getruntemplate) | **GET** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Retrieve a solution run templates|
18
18
  |[**getSolution**](#getsolution) | **GET** /organizations/{organization_id}/solutions/{solution_id} | Get the details of a solution|
19
19
  |[**getSolutionAccessControl**](#getsolutionaccesscontrol) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Get solution access control|
20
+ |[**getSolutionMembers**](#getsolutionmembers) | **GET** /organizations/{organization_id}/solutions/{solution_id}/members | Get the members of a Solution|
20
21
  |[**getSolutionParameter**](#getsolutionparameter) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Get the details of a solution parameter|
21
22
  |[**getSolutionParameterGroup**](#getsolutionparametergroup) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Get details of a solution parameter group|
22
23
  |[**getSolutionSecurity**](#getsolutionsecurity) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security | Get solution security information|
@@ -775,6 +776,61 @@ const { status, data } = await apiInstance.getSolutionAccessControl(
775
776
 
776
777
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
777
778
 
779
+ # **getSolutionMembers**
780
+ > SolutionMembers getSolutionMembers()
781
+
782
+ Retrieve detailed information about members of a solution.
783
+
784
+ ### Example
785
+
786
+ ```typescript
787
+ import {
788
+ SolutionApi,
789
+ Configuration
790
+ } from '@cosmotech/api-ts';
791
+
792
+ const configuration = new Configuration();
793
+ const apiInstance = new SolutionApi(configuration);
794
+
795
+ let organizationId: string; //the Organization identifier (default to undefined)
796
+ let solutionId: string; //the Solution identifier (default to undefined)
797
+
798
+ const { status, data } = await apiInstance.getSolutionMembers(
799
+ organizationId,
800
+ solutionId
801
+ );
802
+ ```
803
+
804
+ ### Parameters
805
+
806
+ |Name | Type | Description | Notes|
807
+ |------------- | ------------- | ------------- | -------------|
808
+ | **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
809
+ | **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
810
+
811
+
812
+ ### Return type
813
+
814
+ **SolutionMembers**
815
+
816
+ ### Authorization
817
+
818
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
819
+
820
+ ### HTTP request headers
821
+
822
+ - **Content-Type**: Not defined
823
+ - **Accept**: application/json, application/yaml
824
+
825
+
826
+ ### HTTP response details
827
+ | Status code | Description | Response headers |
828
+ |-------------|-------------|------------------|
829
+ |**200** | The Solution members | - |
830
+ |**404** | the Solution specified is unknown or you don\'t have access to it | - |
831
+
832
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
833
+
778
834
  # **getSolutionParameter**
779
835
  > RunTemplateParameter getSolutionParameter()
780
836
 
@@ -0,0 +1,25 @@
1
+ # SolutionMemberGroup
2
+
3
+ A group member of the solution
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | The group id | [default to undefined]
10
+ **role** | **string** | The group role in the solution | [default to undefined]
11
+ **users** | **Array<string>** | The list of users in the group | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { SolutionMemberGroup } from '@cosmotech/api-ts';
17
+
18
+ const instance: SolutionMemberGroup = {
19
+ id,
20
+ role,
21
+ users,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # SolutionMemberUser
2
+
3
+ A user member of the solution
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | The user id | [default to undefined]
10
+ **role** | **string** | The user role in the solution | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { SolutionMemberUser } from '@cosmotech/api-ts';
16
+
17
+ const instance: SolutionMemberUser = {
18
+ id,
19
+ role,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # SolutionMembers
2
+
3
+ The Solution members, including users and groups
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **users** | [**Array<SolutionMemberUser>**](SolutionMemberUser.md) | The list of users in the solution | [default to undefined]
10
+ **groups** | [**Array<SolutionMemberGroup>**](SolutionMemberGroup.md) | The list of groups in the solution | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { SolutionMembers } from '@cosmotech/api-ts';
16
+
17
+ const instance: SolutionMembers = {
18
+ users,
19
+ groups,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -14,6 +14,7 @@ All URIs are relative to *http://localhost:8080*
14
14
  |[**getWorkspace**](#getworkspace) | **GET** /organizations/{organization_id}/workspaces/{workspace_id} | Get the details of a workspace|
15
15
  |[**getWorkspaceAccessControl**](#getworkspaceaccesscontrol) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Get a control access for the Workspace|
16
16
  |[**getWorkspaceFile**](#getworkspacefile) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/files/download | Download the Workspace File specified|
17
+ |[**getWorkspaceMembers**](#getworkspacemembers) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/members | Get the members of a Workspace|
17
18
  |[**getWorkspaceSecurity**](#getworkspacesecurity) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/security | Get the Workspace security information|
18
19
  |[**listWorkspaceFiles**](#listworkspacefiles) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/files | List all Workspace files|
19
20
  |[**listWorkspaceRolePermissions**](#listworkspacerolepermissions) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/permissions/{role} | Get the Workspace permission by given role|
@@ -597,6 +598,61 @@ const { status, data } = await apiInstance.getWorkspaceFile(
597
598
 
598
599
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
599
600
 
601
+ # **getWorkspaceMembers**
602
+ > WorkspaceMembers getWorkspaceMembers()
603
+
604
+ Retrieve detailed information about members of a workspace.
605
+
606
+ ### Example
607
+
608
+ ```typescript
609
+ import {
610
+ WorkspaceApi,
611
+ Configuration
612
+ } from '@cosmotech/api-ts';
613
+
614
+ const configuration = new Configuration();
615
+ const apiInstance = new WorkspaceApi(configuration);
616
+
617
+ let organizationId: string; //The Organization identifier (default to undefined)
618
+ let workspaceId: string; //The Workspace identifier (default to undefined)
619
+
620
+ const { status, data } = await apiInstance.getWorkspaceMembers(
621
+ organizationId,
622
+ workspaceId
623
+ );
624
+ ```
625
+
626
+ ### Parameters
627
+
628
+ |Name | Type | Description | Notes|
629
+ |------------- | ------------- | ------------- | -------------|
630
+ | **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
631
+ | **workspaceId** | [**string**] | The Workspace identifier | defaults to undefined|
632
+
633
+
634
+ ### Return type
635
+
636
+ **WorkspaceMembers**
637
+
638
+ ### Authorization
639
+
640
+ [oAuth2AuthCode](../README.md#oAuth2AuthCode)
641
+
642
+ ### HTTP request headers
643
+
644
+ - **Content-Type**: Not defined
645
+ - **Accept**: application/json, application/yaml
646
+
647
+
648
+ ### HTTP response details
649
+ | Status code | Description | Response headers |
650
+ |-------------|-------------|------------------|
651
+ |**200** | The Workspace members | - |
652
+ |**404** | The Workspace specified is unknown or you don\'t have access to it | - |
653
+
654
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
655
+
600
656
  # **getWorkspaceSecurity**
601
657
  > WorkspaceSecurity getWorkspaceSecurity()
602
658
 
@@ -0,0 +1,25 @@
1
+ # WorkspaceMemberGroup
2
+
3
+ A group member of the workspace
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | The group id | [default to undefined]
10
+ **role** | **string** | The group role in the workspace | [default to undefined]
11
+ **users** | **Array<string>** | The list of users in the group | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { WorkspaceMemberGroup } from '@cosmotech/api-ts';
17
+
18
+ const instance: WorkspaceMemberGroup = {
19
+ id,
20
+ role,
21
+ users,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # WorkspaceMemberUser
2
+
3
+ A user member of the workspace
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | The user id | [default to undefined]
10
+ **role** | **string** | The user role in the workspace | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { WorkspaceMemberUser } from '@cosmotech/api-ts';
16
+
17
+ const instance: WorkspaceMemberUser = {
18
+ id,
19
+ role,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # WorkspaceMembers
2
+
3
+ The Workspace members, including users and groups
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **users** | [**Array<WorkspaceMemberUser>**](WorkspaceMemberUser.md) | The list of users in the workspace | [default to undefined]
10
+ **groups** | [**Array<WorkspaceMemberGroup>**](WorkspaceMemberGroup.md) | The list of groups in the workspace | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { WorkspaceMembers } from '@cosmotech/api-ts';
16
+
17
+ const instance: WorkspaceMembers = {
18
+ users,
19
+ groups,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/git_push.sh CHANGED
@@ -8,24 +8,24 @@ git_repo_id=$2
8
8
  release_note=$3
9
9
  git_host=$4
10
10
 
11
- if [ "$git_host" = "" ]; then
11
+ if [ -z "${git_host}" ]; then
12
12
  git_host="github.com"
13
- echo "[INFO] No command line input provided. Set \$git_host to $git_host"
13
+ echo "[INFO] No command line input provided. Set \${git_host} to ${git_host}"
14
14
  fi
15
15
 
16
- if [ "$git_user_id" = "" ]; then
16
+ if [ -z "${git_user_id}" ]; then
17
17
  git_user_id="Cosmo-Tech"
18
- echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
18
+ echo "[INFO] No command line input provided. Set \${git_user_id} to ${git_user_id}"
19
19
  fi
20
20
 
21
- if [ "$git_repo_id" = "" ]; then
21
+ if [ -z "${git_repo_id}" ]; then
22
22
  git_repo_id="cosmotech-api-typescript-client"
23
- echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
23
+ echo "[INFO] No command line input provided. Set \${git_repo_id} to ${git_repo_id}"
24
24
  fi
25
25
 
26
- if [ "$release_note" = "" ]; then
26
+ if [ -z "${release_note}" ]; then
27
27
  release_note="Minor update"
28
- echo "[INFO] No command line input provided. Set \$release_note to $release_note"
28
+ echo "[INFO] No command line input provided. Set \${release_note} to ${release_note}"
29
29
  fi
30
30
 
31
31
  # Initialize the local directory as a Git repository
@@ -35,19 +35,16 @@ git init
35
35
  git add .
36
36
 
37
37
  # Commits the tracked changes and prepares them to be pushed to a remote repository.
38
- git commit -m "$release_note"
38
+ git commit -m "${release_note}"
39
39
 
40
40
  # Sets the new remote
41
- git_remote=$(git remote)
42
- if [ "$git_remote" = "" ]; then # git remote not defined
43
-
44
- if [ "$GIT_TOKEN" = "" ]; then
45
- echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
46
- git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
41
+ if [ -z "$(git remote)" ]; then # git remote not defined
42
+ if [ -z "${GIT_TOKEN:-}" ]; then
43
+ echo "[INFO] \${GIT_TOKEN} (environment variable) is not set. Using the git credential in your environment."
44
+ git remote add origin "https://${git_host}/${git_user_id}/${git_repo_id}.git"
47
45
  else
48
- git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
46
+ git remote add origin "https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git"
49
47
  fi
50
-
51
48
  fi
52
49
 
53
50
  git pull origin master
package/index.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Cosmo Tech Platform API
5
5
  * Cosmo Tech Platform API
6
6
  *
7
- * The version of the OpenAPI document: 5.1.0
7
+ * The version of the OpenAPI document: 5.3.0
8
8
  * Contact: platform@cosmotech.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cosmotech/api-ts",
3
- "version": "5.1.0",
3
+ "version": "5.3.0",
4
4
  "description": "OpenAPI client for @cosmotech/api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
@@ -14,7 +14,7 @@
14
14
  "openapi-generator",
15
15
  "@cosmotech/api-ts"
16
16
  ],
17
- "license": "Unlicense",
17
+ "license": "CosmoTech",
18
18
  "main": "./dist/index.js",
19
19
  "typings": "./dist/index.d.ts",
20
20
  "scripts": {
@@ -22,7 +22,7 @@
22
22
  "prepare": "npm run build"
23
23
  },
24
24
  "dependencies": {
25
- "axios": "^1.16.0"
25
+ "axios": "^1.18.0"
26
26
  },
27
27
  "devDependencies": {
28
28
  "@types/node": "12.11.5 - 12.20.42",