@cherryin/passport-api-client 0.1.31 → 0.1.33

package/docs/PassportOrgServiceApi.md

@@ -0,0 +1,552 @@
+# PassportOrgServiceApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**passportOrgServicePassportOrgCreate**](#passportorgservicepassportorgcreate) | **POST** /passport/enterprise/authed/v1/organizations | 创建组织（需要企业认证通过）|
+|[**passportOrgServicePassportOrgDelete**](#passportorgservicepassportorgdelete) | **DELETE** /passport/enterprise/authed/v1/organizations/{oid} | 删除组织（仅 Owner）|
+|[**passportOrgServicePassportOrgGet**](#passportorgservicepassportorgget) | **GET** /passport/enterprise/authed/v1/organizations/{oid} | 获取组织详情（需要是组织成员）|
+|[**passportOrgServicePassportOrgList**](#passportorgservicepassportorglist) | **GET** /passport/enterprise/authed/v1/organizations | 获取当前用户的组织列表|
+|[**passportOrgServicePassportOrgMemberAdd**](#passportorgservicepassportorgmemberadd) | **POST** /passport/enterprise/authed/v1/organizations/{oid}/members | 添加组织成员（需要 Owner 或 Admin，支持 EID/邮箱/手机号）|
+|[**passportOrgServicePassportOrgMemberChangeRole**](#passportorgservicepassportorgmemberchangerole) | **PATCH** /passport/enterprise/authed/v1/organizations/{oid}/members/{eid} | 变更成员角色（需要比目标角色更高权限）|
+|[**passportOrgServicePassportOrgMemberList**](#passportorgservicepassportorgmemberlist) | **GET** /passport/enterprise/authed/v1/organizations/{oid}/members | 获取组织成员列表|
+|[**passportOrgServicePassportOrgMemberRemove**](#passportorgservicepassportorgmemberremove) | **DELETE** /passport/enterprise/authed/v1/organizations/{oid}/members/{eid} | 移除组织成员（需要 Owner 或 Admin）|
+|[**passportOrgServicePassportOrgMembershipGet**](#passportorgservicepassportorgmembershipget) | **GET** /passport/enterprise/authed/v1/organizations/{oid}/membership | 获取当前用户在指定组织的成员关系|
+|[**passportOrgServicePassportOrgUpdate**](#passportorgservicepassportorgupdate) | **PATCH** /passport/enterprise/authed/v1/organizations/{oid} | 更新组织信息（需要 Owner 或 Admin）|
+
+# **passportOrgServicePassportOrgCreate**
+> PassportOrgCreateResponse passportOrgServicePassportOrgCreate(body)
+
+
+### Example
+
+```typescript
+import {
+    PassportOrgServiceApi,
+    Configuration,
+    PassportOrgCreateRequest
+} from '@cherryin/passport-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportOrgServiceApi(configuration);
+
+let body: PassportOrgCreateRequest; //
+
+const { status, data } = await apiInstance.passportOrgServicePassportOrgCreate(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **PassportOrgCreateRequest**|  | |
+
+
+### Return type
+
+**PassportOrgCreateResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A successful response. |  -  |
+|**0** | An unexpected error response. |  -  |
+
+[[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)
+
+# **passportOrgServicePassportOrgDelete**
+> PassportOrgDeleteResponse passportOrgServicePassportOrgDelete()
+
+
+### Example
+
+```typescript
+import {
+    PassportOrgServiceApi,
+    Configuration
+} from '@cherryin/passport-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportOrgServiceApi(configuration);
+
+let oid: string; //required: 组织 OID (default to undefined)
+
+const { status, data } = await apiInstance.passportOrgServicePassportOrgDelete(
+    oid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **oid** | [**string**] | required: 组织 OID | defaults to undefined|
+
+
+### Return type
+
+**PassportOrgDeleteResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A successful response. |  -  |
+|**0** | An unexpected error response. |  -  |
+
+[[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)
+
+# **passportOrgServicePassportOrgGet**
+> PassportOrgGetResponse passportOrgServicePassportOrgGet()
+
+
+### Example
+
+```typescript
+import {
+    PassportOrgServiceApi,
+    Configuration
+} from '@cherryin/passport-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportOrgServiceApi(configuration);
+
+let oid: string; //required: 组织 OID (default to undefined)
+
+const { status, data } = await apiInstance.passportOrgServicePassportOrgGet(
+    oid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **oid** | [**string**] | required: 组织 OID | defaults to undefined|
+
+
+### Return type
+
+**PassportOrgGetResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A successful response. |  -  |
+|**0** | An unexpected error response. |  -  |
+
+[[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)
+
+# **passportOrgServicePassportOrgList**
+> PassportOrgListResponse passportOrgServicePassportOrgList()
+
+
+### Example
+
+```typescript
+import {
+    PassportOrgServiceApi,
+    Configuration
+} from '@cherryin/passport-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportOrgServiceApi(configuration);
+
+let appName: string; //@gotags: form:\"app_name\"  optional: 按应用名称过滤 (optional) (default to undefined)
+
+const { status, data } = await apiInstance.passportOrgServicePassportOrgList(
+    appName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appName** | [**string**] | @gotags: form:\"app_name\"  optional: 按应用名称过滤 | (optional) defaults to undefined|
+
+
+### Return type
+
+**PassportOrgListResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A successful response. |  -  |
+|**0** | An unexpected error response. |  -  |
+
+[[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)
+
+# **passportOrgServicePassportOrgMemberAdd**
+> PassportOrgMemberAddResponse passportOrgServicePassportOrgMemberAdd(body)
+
+
+### Example
+
+```typescript
+import {
+    PassportOrgServiceApi,
+    Configuration,
+    PassportOrgMemberAddBody
+} from '@cherryin/passport-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportOrgServiceApi(configuration);
+
+let oid: string; //required: 组织 OID（路径参数） (default to undefined)
+let body: PassportOrgMemberAddBody; //
+
+const { status, data } = await apiInstance.passportOrgServicePassportOrgMemberAdd(
+    oid,
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **PassportOrgMemberAddBody**|  | |
+| **oid** | [**string**] | required: 组织 OID（路径参数） | defaults to undefined|
+
+
+### Return type
+
+**PassportOrgMemberAddResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A successful response. |  -  |
+|**0** | An unexpected error response. |  -  |
+
+[[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)
+
+# **passportOrgServicePassportOrgMemberChangeRole**
+> PassportOrgMemberChangeRoleResponse passportOrgServicePassportOrgMemberChangeRole(body)
+
+
+### Example
+
+```typescript
+import {
+    PassportOrgServiceApi,
+    Configuration,
+    PassportOrgMemberChangeRoleBody
+} from '@cherryin/passport-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportOrgServiceApi(configuration);
+
+let oid: string; //required: 组织 OID（路径参数） (default to undefined)
+let eid: string; //required: 目标成员 EID（路径参数） (default to undefined)
+let body: PassportOrgMemberChangeRoleBody; //
+
+const { status, data } = await apiInstance.passportOrgServicePassportOrgMemberChangeRole(
+    oid,
+    eid,
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **PassportOrgMemberChangeRoleBody**|  | |
+| **oid** | [**string**] | required: 组织 OID（路径参数） | defaults to undefined|
+| **eid** | [**string**] | required: 目标成员 EID（路径参数） | defaults to undefined|
+
+
+### Return type
+
+**PassportOrgMemberChangeRoleResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A successful response. |  -  |
+|**0** | An unexpected error response. |  -  |
+
+[[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)
+
+# **passportOrgServicePassportOrgMemberList**
+> PassportOrgMemberListResponse passportOrgServicePassportOrgMemberList()
+
+
+### Example
+
+```typescript
+import {
+    PassportOrgServiceApi,
+    Configuration
+} from '@cherryin/passport-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportOrgServiceApi(configuration);
+
+let oid: string; //required: 组织 OID (default to undefined)
+let page: string; //@gotags: form:\"page\"  optional: 页码 (optional) (default to undefined)
+let pageSize: string; //@gotags: form:\"page_size\"  optional: 每页数量 (optional) (default to undefined)
+
+const { status, data } = await apiInstance.passportOrgServicePassportOrgMemberList(
+    oid,
+    page,
+    pageSize
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **oid** | [**string**] | required: 组织 OID | defaults to undefined|
+| **page** | [**string**] | @gotags: form:\"page\"  optional: 页码 | (optional) defaults to undefined|
+| **pageSize** | [**string**] | @gotags: form:\"page_size\"  optional: 每页数量 | (optional) defaults to undefined|
+
+
+### Return type
+
+**PassportOrgMemberListResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A successful response. |  -  |
+|**0** | An unexpected error response. |  -  |
+
+[[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)
+
+# **passportOrgServicePassportOrgMemberRemove**
+> PassportOrgMemberRemoveResponse passportOrgServicePassportOrgMemberRemove()
+
+
+### Example
+
+```typescript
+import {
+    PassportOrgServiceApi,
+    Configuration
+} from '@cherryin/passport-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportOrgServiceApi(configuration);
+
+let oid: string; //required: 组织 OID（路径参数） (default to undefined)
+let eid: string; //required: 目标成员 EID（路径参数） (default to undefined)
+
+const { status, data } = await apiInstance.passportOrgServicePassportOrgMemberRemove(
+    oid,
+    eid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **oid** | [**string**] | required: 组织 OID（路径参数） | defaults to undefined|
+| **eid** | [**string**] | required: 目标成员 EID（路径参数） | defaults to undefined|
+
+
+### Return type
+
+**PassportOrgMemberRemoveResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A successful response. |  -  |
+|**0** | An unexpected error response. |  -  |
+
+[[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)
+
+# **passportOrgServicePassportOrgMembershipGet**
+> PassportOrgMembershipGetResponse passportOrgServicePassportOrgMembershipGet()
+
+
+### Example
+
+```typescript
+import {
+    PassportOrgServiceApi,
+    Configuration
+} from '@cherryin/passport-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportOrgServiceApi(configuration);
+
+let oid: string; //required: 组织 OID (default to undefined)
+
+const { status, data } = await apiInstance.passportOrgServicePassportOrgMembershipGet(
+    oid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **oid** | [**string**] | required: 组织 OID | defaults to undefined|
+
+
+### Return type
+
+**PassportOrgMembershipGetResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A successful response. |  -  |
+|**0** | An unexpected error response. |  -  |
+
+[[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)
+
+# **passportOrgServicePassportOrgUpdate**
+> PassportOrgUpdateResponse passportOrgServicePassportOrgUpdate(body)
+
+
+### Example
+
+```typescript
+import {
+    PassportOrgServiceApi,
+    Configuration,
+    PassportOrgUpdateBody
+} from '@cherryin/passport-api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportOrgServiceApi(configuration);
+
+let oid: string; //required: 组织 OID（路径参数） (default to undefined)
+let body: PassportOrgUpdateBody; //
+
+const { status, data } = await apiInstance.passportOrgServicePassportOrgUpdate(
+    oid,
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **PassportOrgUpdateBody**|  | |
+| **oid** | [**string**] | required: 组织 OID（路径参数） | defaults to undefined|
+
+
+### Return type
+
+**PassportOrgUpdateResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A successful response. |  -  |
+|**0** | An unexpected error response. |  -  |
+
+[[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)
+

package/docs/PassportOrgUpdateBody.md

@@ -0,0 +1,24 @@
+# PassportOrgUpdateBody
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**avatar_url** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportOrgUpdateBody } from '@cherryin/passport-api-client';
+
+const instance: PassportOrgUpdateBody = {
+    display_name,
+    description,
+    avatar_url,
+};
+```
+
+[[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/docs/PassportOrgUpdateResponse.md

@@ -0,0 +1,22 @@
+# PassportOrgUpdateResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PassportOrgUpdateResponse } from '@cherryin/passport-api-client';
+
+const instance: PassportOrgUpdateResponse = {
+    code,
+    message,
+};
+```
+
+[[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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cherryin/passport-api-client",
-  "version": "0.1.31",
+  "version": "0.1.33",
   "description": "OpenAPI client for @cherryin/passport-api-client",
   "author": "OpenAPI-Generator Contributors",
   "repository": {