Skip to content

Commit 5f322d8

Browse files
committed
use union types instead of enum
1 parent 1523fdf commit 5f322d8

23 files changed

+48
-540
lines changed

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
"main": "src/index.ts",
66
"scripts": {
77
"test": "echo \"Error: no test specified\" && exit 1",
8-
"generate.spec.node": "./node_modules/.bin/openapi --input openapi.yaml --output ./src/api --useOptions --client node",
9-
"generate.spec.browser": "./node_modules/.bin/openapi --input openapi.yaml --output ./src/api --useOptions --client xhr",
8+
"generate.spec.node": "./node_modules/.bin/openapi --input openapi.yaml --output ./src/api --useOptions --useUnionTypes --client node",
9+
"generate.spec.browser": "./node_modules/.bin/openapi --input openapi.yaml --output ./src/api --useOptions --useUnionTypes --client xhr",
1010
"webpack": "npm run generate.spec.browser && npx webpack --mode=development && npx webpack && npm run generate.spec.node"
1111
},
1212
"keywords": [],

src/api/index.ts

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,55 +8,55 @@ export type { AttachmentsConfig } from './models/AttachmentsConfig';
88
export type { AuthToken } from './models/AuthToken';
99
export type { BannerNotification } from './models/BannerNotification';
1010
export type { BannerNotificationAction } from './models/BannerNotificationAction';
11-
export { BulkGen } from './models/BulkGen';
11+
export type { BulkGen } from './models/BulkGen';
1212
export type { BulkGenData } from './models/BulkGenData';
1313
export type { BulkGenerateMeta } from './models/BulkGenerateMeta';
1414
export type { BulkGenTask } from './models/BulkGenTask';
1515
export type { BulkGenUpload } from './models/BulkGenUpload';
1616
export type { ChangePassword } from './models/ChangePassword';
1717
export type { ChargebeeSubscription } from './models/ChargebeeSubscription';
18-
export { ChildTemplate } from './models/ChildTemplate';
18+
export type { ChildTemplate } from './models/ChildTemplate';
1919
export type { CopyTemplate } from './models/CopyTemplate';
20-
export { DeliveryAccount } from './models/DeliveryAccount';
20+
export type { DeliveryAccount } from './models/DeliveryAccount';
2121
export type { DocumentMergeLink } from './models/DocumentMergeLink';
22-
export { DocuSignDelivery } from './models/DocuSignDelivery';
23-
export { DropboxDelivery } from './models/DropboxDelivery';
22+
export type { DocuSignDelivery } from './models/DocuSignDelivery';
23+
export type { DropboxDelivery } from './models/DropboxDelivery';
2424
export type { DynamicImage } from './models/DynamicImage';
25-
export { EmailDelivery } from './models/EmailDelivery';
25+
export type { EmailDelivery } from './models/EmailDelivery';
2626
export type { EmailDeliveryAttachment } from './models/EmailDeliveryAttachment';
27-
export { EversignDelivery } from './models/EversignDelivery';
27+
export type { EversignDelivery } from './models/EversignDelivery';
2828
export type { File } from './models/File';
2929
export type { FileUploadMeta } from './models/FileUploadMeta';
3030
export type { FillablePdfSettings } from './models/FillablePdfSettings';
3131
export type { Folder } from './models/Folder';
3232
export type { ForbiddenError } from './models/ForbiddenError';
33-
export { GoogleDriveDelivery } from './models/GoogleDriveDelivery';
34-
export { HelloSignDelivery } from './models/HelloSignDelivery';
35-
export { MergeHistory } from './models/MergeHistory';
33+
export type { GoogleDriveDelivery } from './models/GoogleDriveDelivery';
34+
export type { HelloSignDelivery } from './models/HelloSignDelivery';
35+
export type { MergeHistory } from './models/MergeHistory';
3636
export type { Meta } from './models/Meta';
37-
export { NewTemplate } from './models/NewTemplate';
37+
export type { NewTemplate } from './models/NewTemplate';
3838
export type { NotFoundError } from './models/NotFoundError';
39-
export { OneDriveDelivery } from './models/OneDriveDelivery';
39+
export type { OneDriveDelivery } from './models/OneDriveDelivery';
4040
export type { Organization } from './models/Organization';
4141
export type { PaginatedBulkGenList } from './models/PaginatedBulkGenList';
4242
export type { PaginatedMergeHistoryList } from './models/PaginatedMergeHistoryList';
4343
export type { PaginatedTemplateList } from './models/PaginatedTemplateList';
4444
export type { PatchedUpdateNewTemplate } from './models/PatchedUpdateNewTemplate';
45-
export { Plan } from './models/Plan';
45+
export type { Plan } from './models/Plan';
4646
export type { PolymorphicDelivery } from './models/PolymorphicDelivery';
47-
export { S3Delivery } from './models/S3Delivery';
48-
export { SignNowDelivery } from './models/SignNowDelivery';
47+
export type { S3Delivery } from './models/S3Delivery';
48+
export type { SignNowDelivery } from './models/SignNowDelivery';
4949
export type { SubscriptionMeta } from './models/SubscriptionMeta';
50-
export { Template } from './models/Template';
51-
export { TemplateDelivery } from './models/TemplateDelivery';
52-
export { TemplateSettings } from './models/TemplateSettings';
50+
export type { Template } from './models/Template';
51+
export type { TemplateDelivery } from './models/TemplateDelivery';
52+
export type { TemplateSettings } from './models/TemplateSettings';
5353
export type { Timezone } from './models/Timezone';
5454
export type { UnauthenticatedError } from './models/UnauthenticatedError';
55-
export { UpdateDeliveryAccount } from './models/UpdateDeliveryAccount';
56-
export { User } from './models/User';
55+
export type { UpdateDeliveryAccount } from './models/UpdateDeliveryAccount';
56+
export type { User } from './models/User';
5757
export type { UserPersonalization } from './models/UserPersonalization';
5858
export type { ValidationError } from './models/ValidationError';
59-
export { WebhookDelivery } from './models/WebhookDelivery';
59+
export type { WebhookDelivery } from './models/WebhookDelivery';
6060

6161
export { AuthTokensService } from './services/AuthTokensService';
6262
export { FoldersService } from './services/FoldersService';

src/api/models/BulkGen.ts

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,9 @@ import type { BulkGenTask } from './BulkGenTask';
77
export type BulkGen = {
88
readonly id: number;
99
readonly errors: Array<BulkGenTask>;
10-
status?: BulkGen.status;
10+
status?: 0 | 1 | 2 | 3 | 4 | 5;
1111
start_time?: string | null;
1212
end_time?: string | null;
1313
total?: number | null;
1414
success?: number | null;
1515
}
16-
17-
export namespace BulkGen {
18-
19-
export enum status {
20-
_0 = 0,
21-
_1 = 1,
22-
_2 = 2,
23-
_3 = 3,
24-
_4 = 4,
25-
_5 = 5,
26-
}
27-
28-
29-
}

src/api/models/ChildTemplate.ts

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,10 @@ export type ChildTemplate = {
66
readonly id: number;
77
readonly title: string;
88
description?: string | null;
9-
type?: ChildTemplate.type;
9+
type?: 'docx' | 'html' | 'fillable_pdf' | 'pptx' | 'xlsx' | 'g_document' | 'g_presentation' | 'g_spreadsheet';
1010
readonly created_time: string;
11-
document_status?: ChildTemplate.document_status;
11+
document_status?: 'active' | 'test';
1212
deleted_time?: string | null;
1313
created_by: number;
1414
folder?: number | null;
1515
}
16-
17-
export namespace ChildTemplate {
18-
19-
export enum type {
20-
DOCX = 'docx',
21-
HTML = 'html',
22-
FILLABLE_PDF = 'fillable_pdf',
23-
PPTX = 'pptx',
24-
XLSX = 'xlsx',
25-
G_DOCUMENT = 'g_document',
26-
G_PRESENTATION = 'g_presentation',
27-
G_SPREADSHEET = 'g_spreadsheet',
28-
}
29-
30-
export enum document_status {
31-
ACTIVE = 'active',
32-
TEST = 'test',
33-
}
34-
35-
36-
}

src/api/models/DeliveryAccount.ts

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,9 @@
44

55
export type DeliveryAccount = {
66
readonly id: number;
7-
type: DeliveryAccount.type;
7+
type: 'hellosign' | 'aws_s3';
88
readonly sub_type: string;
99
readonly name: string | null;
1010
credentials: Record<string, any>;
1111
readonly is_expired: boolean;
1212
}
13-
14-
export namespace DeliveryAccount {
15-
16-
export enum type {
17-
HELLOSIGN = 'hellosign',
18-
AWS_S3 = 'aws_s3',
19-
}
20-
21-
22-
}

src/api/models/DocuSignDelivery.ts

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export type DocuSignDelivery = {
1212
email_address: string,
1313
}>;
1414
name: string;
15-
type?: DocuSignDelivery.type;
15+
type?: 'email' | 'webhook' | 'docu_sign' | 'sign_now' | 'zoho_crm' | 'dropbox' | 'google_drive' | 'podio' | 'one_drive' | 'eversign' | 'hellosign' | 'aws_s3';
1616
subject?: string | null;
1717
message?: string | null;
1818
fullname_anchor_tags?: boolean;
@@ -21,23 +21,3 @@ export type DocuSignDelivery = {
2121
expire_after?: number | null;
2222
enable_optional_signers?: boolean;
2323
}
24-
25-
export namespace DocuSignDelivery {
26-
27-
export enum type {
28-
EMAIL = 'email',
29-
WEBHOOK = 'webhook',
30-
DOCU_SIGN = 'docu_sign',
31-
SIGN_NOW = 'sign_now',
32-
ZOHO_CRM = 'zoho_crm',
33-
DROPBOX = 'dropbox',
34-
GOOGLE_DRIVE = 'google_drive',
35-
PODIO = 'podio',
36-
ONE_DRIVE = 'one_drive',
37-
EVERSIGN = 'eversign',
38-
HELLOSIGN = 'hellosign',
39-
AWS_S3 = 'aws_s3',
40-
}
41-
42-
43-
}

src/api/models/DropboxDelivery.ts

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,6 @@ export type DropboxDelivery = {
66
readonly id: number;
77
account?: number | null;
88
name: string;
9-
type?: DropboxDelivery.type;
9+
type?: 'email' | 'webhook' | 'docu_sign' | 'sign_now' | 'zoho_crm' | 'dropbox' | 'google_drive' | 'podio' | 'one_drive' | 'eversign' | 'hellosign' | 'aws_s3';
1010
folder?: string;
1111
}
12-
13-
export namespace DropboxDelivery {
14-
15-
export enum type {
16-
EMAIL = 'email',
17-
WEBHOOK = 'webhook',
18-
DOCU_SIGN = 'docu_sign',
19-
SIGN_NOW = 'sign_now',
20-
ZOHO_CRM = 'zoho_crm',
21-
DROPBOX = 'dropbox',
22-
GOOGLE_DRIVE = 'google_drive',
23-
PODIO = 'podio',
24-
ONE_DRIVE = 'one_drive',
25-
EVERSIGN = 'eversign',
26-
HELLOSIGN = 'hellosign',
27-
AWS_S3 = 'aws_s3',
28-
}
29-
30-
31-
}

src/api/models/EmailDelivery.ts

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ export type EmailDelivery = {
66
readonly id: number;
77
readonly attachments: Array<Buffer | ArrayBuffer | ArrayBufferView>;
88
name: string;
9-
type?: EmailDelivery.type;
9+
type?: 'email' | 'webhook' | 'docu_sign' | 'sign_now' | 'zoho_crm' | 'dropbox' | 'google_drive' | 'podio' | 'one_drive' | 'eversign' | 'hellosign' | 'aws_s3';
1010
from_email: string;
1111
to_email: Array<string>;
1212
cc?: Array<string> | null;
@@ -15,23 +15,3 @@ export type EmailDelivery = {
1515
subject?: string;
1616
body?: string;
1717
}
18-
19-
export namespace EmailDelivery {
20-
21-
export enum type {
22-
EMAIL = 'email',
23-
WEBHOOK = 'webhook',
24-
DOCU_SIGN = 'docu_sign',
25-
SIGN_NOW = 'sign_now',
26-
ZOHO_CRM = 'zoho_crm',
27-
DROPBOX = 'dropbox',
28-
GOOGLE_DRIVE = 'google_drive',
29-
PODIO = 'podio',
30-
ONE_DRIVE = 'one_drive',
31-
EVERSIGN = 'eversign',
32-
HELLOSIGN = 'hellosign',
33-
AWS_S3 = 'aws_s3',
34-
}
35-
36-
37-
}

src/api/models/EversignDelivery.ts

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export type EversignDelivery = {
1616
email: string,
1717
}> | null;
1818
name: string;
19-
type?: EversignDelivery.type;
19+
type?: 'email' | 'webhook' | 'docu_sign' | 'sign_now' | 'zoho_crm' | 'dropbox' | 'google_drive' | 'podio' | 'one_drive' | 'eversign' | 'hellosign' | 'aws_s3';
2020
title?: string | null;
2121
message?: string | null;
2222
use_signer_order?: boolean;
@@ -25,23 +25,3 @@ export type EversignDelivery = {
2525
expires_in?: number | null;
2626
enable_optional_signers?: boolean;
2727
}
28-
29-
export namespace EversignDelivery {
30-
31-
export enum type {
32-
EMAIL = 'email',
33-
WEBHOOK = 'webhook',
34-
DOCU_SIGN = 'docu_sign',
35-
SIGN_NOW = 'sign_now',
36-
ZOHO_CRM = 'zoho_crm',
37-
DROPBOX = 'dropbox',
38-
GOOGLE_DRIVE = 'google_drive',
39-
PODIO = 'podio',
40-
ONE_DRIVE = 'one_drive',
41-
EVERSIGN = 'eversign',
42-
HELLOSIGN = 'hellosign',
43-
AWS_S3 = 'aws_s3',
44-
}
45-
46-
47-
}

src/api/models/GoogleDriveDelivery.ts

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,7 @@ export type GoogleDriveDelivery = {
66
readonly id: number;
77
account?: number | null;
88
name: string;
9-
type?: GoogleDriveDelivery.type;
9+
type?: 'email' | 'webhook' | 'docu_sign' | 'sign_now' | 'zoho_crm' | 'dropbox' | 'google_drive' | 'podio' | 'one_drive' | 'eversign' | 'hellosign' | 'aws_s3';
1010
folder?: string;
1111
folder_id?: string | null;
1212
}
13-
14-
export namespace GoogleDriveDelivery {
15-
16-
export enum type {
17-
EMAIL = 'email',
18-
WEBHOOK = 'webhook',
19-
DOCU_SIGN = 'docu_sign',
20-
SIGN_NOW = 'sign_now',
21-
ZOHO_CRM = 'zoho_crm',
22-
DROPBOX = 'dropbox',
23-
GOOGLE_DRIVE = 'google_drive',
24-
PODIO = 'podio',
25-
ONE_DRIVE = 'one_drive',
26-
EVERSIGN = 'eversign',
27-
HELLOSIGN = 'hellosign',
28-
AWS_S3 = 'aws_s3',
29-
}
30-
31-
32-
}

0 commit comments

Comments
 (0)