@cherryin/passport-api-client 0.1.7 → 0.1.9

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.
@@ -0,0 +1,22 @@
1
+ # EnterpriseOCRBusinessLicenseWarning
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **is_copy** | **number** | | [optional] [default to undefined]
9
+ **value_probs** | **{ [key: string]: number; }** | 字段置信度 | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { EnterpriseOCRBusinessLicenseWarning } from '@cherryin/passport-api-client';
15
+
16
+ const instance: EnterpriseOCRBusinessLicenseWarning = {
17
+ is_copy,
18
+ value_probs,
19
+ };
20
+ ```
21
+
22
+ [[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,24 @@
1
+ # EnterpriseOCRPersonIDCard
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **face** | [**EnterpriseOCRPersonIDCardFace**](EnterpriseOCRPersonIDCardFace.md) | | [optional] [default to undefined]
9
+ **back** | [**EnterpriseOCRPersonIDCardBack**](EnterpriseOCRPersonIDCardBack.md) | | [optional] [default to undefined]
10
+ **warning** | [**EnterpriseOCRPersonIDCardWarning**](EnterpriseOCRPersonIDCardWarning.md) | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { EnterpriseOCRPersonIDCard } from '@cherryin/passport-api-client';
16
+
17
+ const instance: EnterpriseOCRPersonIDCard = {
18
+ face,
19
+ back,
20
+ warning,
21
+ };
22
+ ```
23
+
24
+ [[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,22 @@
1
+ # EnterpriseOCRPersonIDCardBack
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **issue_authority** | **string** | | [optional] [default to undefined]
9
+ **valid_period** | **string** | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { EnterpriseOCRPersonIDCardBack } from '@cherryin/passport-api-client';
15
+
16
+ const instance: EnterpriseOCRPersonIDCardBack = {
17
+ issue_authority,
18
+ valid_period,
19
+ };
20
+ ```
21
+
22
+ [[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,30 @@
1
+ # EnterpriseOCRPersonIDCardFace
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **name** | **string** | | [optional] [default to undefined]
9
+ **sex** | **string** | | [optional] [default to undefined]
10
+ **ethnicity** | **string** | | [optional] [default to undefined]
11
+ **birth_date** | **string** | | [optional] [default to undefined]
12
+ **address** | **string** | | [optional] [default to undefined]
13
+ **id_number** | **string** | | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { EnterpriseOCRPersonIDCardFace } from '@cherryin/passport-api-client';
19
+
20
+ const instance: EnterpriseOCRPersonIDCardFace = {
21
+ name,
22
+ sex,
23
+ ethnicity,
24
+ birth_date,
25
+ address,
26
+ id_number,
27
+ };
28
+ ```
29
+
30
+ [[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,28 @@
1
+ # EnterpriseOCRPersonIDCardWarning
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **is_copy** | **number** | | [optional] [default to undefined]
9
+ **is_reshoot** | **number** | | [optional] [default to undefined]
10
+ **completeness_score** | **number** | | [optional] [default to undefined]
11
+ **quality_score** | **number** | | [optional] [default to undefined]
12
+ **tamper_score** | **number** | | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { EnterpriseOCRPersonIDCardWarning } from '@cherryin/passport-api-client';
18
+
19
+ const instance: EnterpriseOCRPersonIDCardWarning = {
20
+ is_copy,
21
+ is_reshoot,
22
+ completeness_score,
23
+ quality_score,
24
+ tamper_score,
25
+ };
26
+ ```
27
+
28
+ [[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,22 @@
1
+ # PassportAuthEnterpriseMaterialBizLicenseRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **image_base64** | **string** | | [optional] [default to undefined]
9
+ **submission_id** | **string** | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { PassportAuthEnterpriseMaterialBizLicenseRequest } from '@cherryin/passport-api-client';
15
+
16
+ const instance: PassportAuthEnterpriseMaterialBizLicenseRequest = {
17
+ image_base64,
18
+ submission_id,
19
+ };
20
+ ```
21
+
22
+ [[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,26 @@
1
+ # PassportAuthEnterpriseMaterialBizLicenseResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **code** | **string** | | [optional] [default to undefined]
9
+ **message** | **string** | | [optional] [default to undefined]
10
+ **submission_id** | **string** | | [optional] [default to undefined]
11
+ **business_license** | [**EnterpriseOCRBusinessLicense**](EnterpriseOCRBusinessLicense.md) | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { PassportAuthEnterpriseMaterialBizLicenseResponse } from '@cherryin/passport-api-client';
17
+
18
+ const instance: PassportAuthEnterpriseMaterialBizLicenseResponse = {
19
+ code,
20
+ message,
21
+ submission_id,
22
+ business_license,
23
+ };
24
+ ```
25
+
26
+ [[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,24 @@
1
+ # PassportAuthEnterpriseMaterialIDCardRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **image_base64_face** | **string** | | [optional] [default to undefined]
9
+ **image_base64_back** | **string** | | [optional] [default to undefined]
10
+ **submission_id** | **string** | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { PassportAuthEnterpriseMaterialIDCardRequest } from '@cherryin/passport-api-client';
16
+
17
+ const instance: PassportAuthEnterpriseMaterialIDCardRequest = {
18
+ image_base64_face,
19
+ image_base64_back,
20
+ submission_id,
21
+ };
22
+ ```
23
+
24
+ [[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,26 @@
1
+ # PassportAuthEnterpriseMaterialIDCardResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **code** | **string** | | [optional] [default to undefined]
9
+ **message** | **string** | | [optional] [default to undefined]
10
+ **submission_id** | **string** | | [optional] [default to undefined]
11
+ **id_card** | [**EnterpriseOCRPersonIDCard**](EnterpriseOCRPersonIDCard.md) | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { PassportAuthEnterpriseMaterialIDCardResponse } from '@cherryin/passport-api-client';
17
+
18
+ const instance: PassportAuthEnterpriseMaterialIDCardResponse = {
19
+ code,
20
+ message,
21
+ submission_id,
22
+ id_card,
23
+ };
24
+ ```
25
+
26
+ [[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,20 @@
1
+ # PassportAuthEnterpriseMaterialVerifyRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **submission_id** | **string** | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PassportAuthEnterpriseMaterialVerifyRequest } from '@cherryin/passport-api-client';
14
+
15
+ const instance: PassportAuthEnterpriseMaterialVerifyRequest = {
16
+ submission_id,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,4 +1,4 @@
1
- # PassportAuthEnterpriseMaterialUploadResponse
1
+ # PassportAuthEnterpriseMaterialVerifyResponse
2
2
 
3
3
 
4
4
  ## Properties
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
11
11
  ## Example
12
12
 
13
13
  ```typescript
14
- import { PassportAuthEnterpriseMaterialUploadResponse } from '@cherryin/passport-api-client';
14
+ import { PassportAuthEnterpriseMaterialVerifyResponse } from '@cherryin/passport-api-client';
15
15
 
16
- const instance: PassportAuthEnterpriseMaterialUploadResponse = {
16
+ const instance: PassportAuthEnterpriseMaterialVerifyResponse = {
17
17
  code,
18
18
  message,
19
19
  };
@@ -0,0 +1,20 @@
1
+ # PassportAuthEnterpriseMaterialVerifyStateRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **submission_id** | **string** | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PassportAuthEnterpriseMaterialVerifyStateRequest } from '@cherryin/passport-api-client';
14
+
15
+ const instance: PassportAuthEnterpriseMaterialVerifyStateRequest = {
16
+ submission_id,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -10,7 +10,9 @@ All URIs are relative to *http://localhost*
10
10
  |[**passportAuthEnterpriseServicePassportAuthEnterpriseGetSession**](#passportauthenterpriseservicepassportauthenterprisegetsession) | **GET** /passport/enterprise/authed/v1/session/get | 获取当前会话信息|
11
11
  |[**passportAuthEnterpriseServicePassportAuthEnterpriseInfoGet**](#passportauthenterpriseservicepassportauthenterpriseinfoget) | **GET** /passport/enterprise/authed/v1/user/info | 获取用户信息|
12
12
  |[**passportAuthEnterpriseServicePassportAuthEnterpriseListSessions**](#passportauthenterpriseservicepassportauthenterpriselistsessions) | **GET** /passport/enterprise/authed/v1/sessions/list | 获取当前用户的所有会话列表|
13
- |[**passportAuthEnterpriseServicePassportAuthEnterpriseMaterialUpload**](#passportauthenterpriseservicepassportauthenterprisematerialupload) | **POST** /passport/enterprise/authed/v1/materials/upload | 上传企业认证材料|
13
+ |[**passportAuthEnterpriseServicePassportAuthEnterpriseMaterialBizLicense**](#passportauthenterpriseservicepassportauthenterprisematerialbizlicense) | **POST** /passport/enterprise/authed/v1/materials/upload/biz-license | 上传企业营业执照|
14
+ |[**passportAuthEnterpriseServicePassportAuthEnterpriseMaterialIDCard**](#passportauthenterpriseservicepassportauthenterprisematerialidcard) | **POST** /passport/enterprise/authed/v1/materials/upload/id-card | 上传法定代表人身份证|
15
+ |[**passportAuthEnterpriseServicePassportAuthEnterpriseMaterialVerify**](#passportauthenterpriseservicepassportauthenterprisematerialverify) | **POST** /passport/enterprise/authed/v1/materials/verify | 提交企业认证材料审核|
14
16
  |[**passportAuthEnterpriseServicePassportAuthEnterpriseMaterialVerifyState**](#passportauthenterpriseservicepassportauthenterprisematerialverifystate) | **POST** /passport/enterprise/authed/v1/materials/verified-state | 获取企业认证材料审核状态|
15
17
  |[**passportAuthEnterpriseServicePassportAuthEnterpriseRefreshToken**](#passportauthenterpriseservicepassportauthenterpriserefreshtoken) | **POST** /passport/enterprise/authed/v1/session/refresh-token | 会话 token 刷新|
16
18
  |[**passportAuthEnterpriseServicePassportAuthEnterpriseResetPassword**](#passportauthenterpriseservicepassportauthenterpriseresetpassword) | **POST** /passport/enterprise/authed/v1/password/request-reset | 已登录用户重置密码|
@@ -315,8 +317,8 @@ No authorization required
315
317
 
316
318
  [[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)
317
319
 
318
- # **passportAuthEnterpriseServicePassportAuthEnterpriseMaterialUpload**
319
- > PassportAuthEnterpriseMaterialUploadResponse passportAuthEnterpriseServicePassportAuthEnterpriseMaterialUpload(body)
320
+ # **passportAuthEnterpriseServicePassportAuthEnterpriseMaterialBizLicense**
321
+ > PassportAuthEnterpriseMaterialBizLicenseResponse passportAuthEnterpriseServicePassportAuthEnterpriseMaterialBizLicense(body)
320
322
 
321
323
 
322
324
  ### Example
@@ -325,15 +327,15 @@ No authorization required
325
327
  import {
326
328
  PassportAuthEnterpriseServiceApi,
327
329
  Configuration,
328
- PassportAuthEnterpriseMaterialUploadRequest
330
+ PassportAuthEnterpriseMaterialBizLicenseRequest
329
331
  } from '@cherryin/passport-api-client';
330
332
 
331
333
  const configuration = new Configuration();
332
334
  const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
333
335
 
334
- let body: PassportAuthEnterpriseMaterialUploadRequest; //
336
+ let body: PassportAuthEnterpriseMaterialBizLicenseRequest; //
335
337
 
336
- const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseMaterialUpload(
338
+ const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseMaterialBizLicense(
337
339
  body
338
340
  );
339
341
  ```
@@ -342,12 +344,116 @@ const { status, data } = await apiInstance.passportAuthEnterpriseServicePassport
342
344
 
343
345
  |Name | Type | Description | Notes|
344
346
  |------------- | ------------- | ------------- | -------------|
345
- | **body** | **PassportAuthEnterpriseMaterialUploadRequest**| | |
347
+ | **body** | **PassportAuthEnterpriseMaterialBizLicenseRequest**| | |
346
348
 
347
349
 
348
350
  ### Return type
349
351
 
350
- **PassportAuthEnterpriseMaterialUploadResponse**
352
+ **PassportAuthEnterpriseMaterialBizLicenseResponse**
353
+
354
+ ### Authorization
355
+
356
+ No authorization required
357
+
358
+ ### HTTP request headers
359
+
360
+ - **Content-Type**: application/json
361
+ - **Accept**: application/json
362
+
363
+
364
+ ### HTTP response details
365
+ | Status code | Description | Response headers |
366
+ |-------------|-------------|------------------|
367
+ |**200** | A successful response. | - |
368
+ |**0** | An unexpected error response. | - |
369
+
370
+ [[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)
371
+
372
+ # **passportAuthEnterpriseServicePassportAuthEnterpriseMaterialIDCard**
373
+ > PassportAuthEnterpriseMaterialIDCardResponse passportAuthEnterpriseServicePassportAuthEnterpriseMaterialIDCard(body)
374
+
375
+
376
+ ### Example
377
+
378
+ ```typescript
379
+ import {
380
+ PassportAuthEnterpriseServiceApi,
381
+ Configuration,
382
+ PassportAuthEnterpriseMaterialIDCardRequest
383
+ } from '@cherryin/passport-api-client';
384
+
385
+ const configuration = new Configuration();
386
+ const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
387
+
388
+ let body: PassportAuthEnterpriseMaterialIDCardRequest; //
389
+
390
+ const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseMaterialIDCard(
391
+ body
392
+ );
393
+ ```
394
+
395
+ ### Parameters
396
+
397
+ |Name | Type | Description | Notes|
398
+ |------------- | ------------- | ------------- | -------------|
399
+ | **body** | **PassportAuthEnterpriseMaterialIDCardRequest**| | |
400
+
401
+
402
+ ### Return type
403
+
404
+ **PassportAuthEnterpriseMaterialIDCardResponse**
405
+
406
+ ### Authorization
407
+
408
+ No authorization required
409
+
410
+ ### HTTP request headers
411
+
412
+ - **Content-Type**: application/json
413
+ - **Accept**: application/json
414
+
415
+
416
+ ### HTTP response details
417
+ | Status code | Description | Response headers |
418
+ |-------------|-------------|------------------|
419
+ |**200** | A successful response. | - |
420
+ |**0** | An unexpected error response. | - |
421
+
422
+ [[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)
423
+
424
+ # **passportAuthEnterpriseServicePassportAuthEnterpriseMaterialVerify**
425
+ > PassportAuthEnterpriseMaterialVerifyResponse passportAuthEnterpriseServicePassportAuthEnterpriseMaterialVerify(body)
426
+
427
+
428
+ ### Example
429
+
430
+ ```typescript
431
+ import {
432
+ PassportAuthEnterpriseServiceApi,
433
+ Configuration,
434
+ PassportAuthEnterpriseMaterialVerifyRequest
435
+ } from '@cherryin/passport-api-client';
436
+
437
+ const configuration = new Configuration();
438
+ const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
439
+
440
+ let body: PassportAuthEnterpriseMaterialVerifyRequest; //
441
+
442
+ const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseMaterialVerify(
443
+ body
444
+ );
445
+ ```
446
+
447
+ ### Parameters
448
+
449
+ |Name | Type | Description | Notes|
450
+ |------------- | ------------- | ------------- | -------------|
451
+ | **body** | **PassportAuthEnterpriseMaterialVerifyRequest**| | |
452
+
453
+
454
+ ### Return type
455
+
456
+ **PassportAuthEnterpriseMaterialVerifyResponse**
351
457
 
352
458
  ### Authorization
353
459
 
@@ -376,13 +482,14 @@ No authorization required
376
482
  ```typescript
377
483
  import {
378
484
  PassportAuthEnterpriseServiceApi,
379
- Configuration
485
+ Configuration,
486
+ PassportAuthEnterpriseMaterialVerifyStateRequest
380
487
  } from '@cherryin/passport-api-client';
381
488
 
382
489
  const configuration = new Configuration();
383
490
  const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
384
491
 
385
- let body: object; //
492
+ let body: PassportAuthEnterpriseMaterialVerifyStateRequest; //
386
493
 
387
494
  const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseMaterialVerifyState(
388
495
  body
@@ -393,7 +500,7 @@ const { status, data } = await apiInstance.passportAuthEnterpriseServicePassport
393
500
 
394
501
  |Name | Type | Description | Notes|
395
502
  |------------- | ------------- | ------------- | -------------|
396
- | **body** | **object**| | |
503
+ | **body** | **PassportAuthEnterpriseMaterialVerifyStateRequest**| | |
397
504
 
398
505
 
399
506
  ### Return type
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **code** | **string** | | [optional] [default to undefined]
9
9
  **message** | **string** | | [optional] [default to undefined]
10
- **users** | [**Array<AuthUser>**](AuthUser.md) | | [optional] [default to undefined]
10
+ **users** | [**Array<AuthEnterpriseUser>**](AuthEnterpriseUser.md) | | [optional] [default to undefined]
11
11
 
12
12
  ## Example
13
13
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cherryin/passport-api-client",
3
- "version": "0.1.7",
3
+ "version": "0.1.9",
4
4
  "description": "OpenAPI client for @cherryin/passport-api-client",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
@@ -1,26 +0,0 @@
1
- # PassportAuthEnterpriseMaterialUploadRequest
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **company_name** | **string** | | [optional] [default to undefined]
9
- **unified_social_credit_code** | **string** | | [optional] [default to undefined]
10
- **legal_person_name** | **string** | | [optional] [default to undefined]
11
- **legal_person_id_number** | **string** | | [optional] [default to undefined]
12
-
13
- ## Example
14
-
15
- ```typescript
16
- import { PassportAuthEnterpriseMaterialUploadRequest } from '@cherryin/passport-api-client';
17
-
18
- const instance: PassportAuthEnterpriseMaterialUploadRequest = {
19
- company_name,
20
- unified_social_credit_code,
21
- legal_person_name,
22
- legal_person_id_number,
23
- };
24
- ```
25
-
26
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)