-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathswagger2.yaml
More file actions
6306 lines (6254 loc) · 190 KB
/
swagger2.yaml
File metadata and controls
6306 lines (6254 loc) · 190 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
swagger: '2.0'
info:
contact:
email: integrations@getaccept.com
name: GetAccept API Team
url: 'https://app.getaccept.com/api'
description: >-
GetAccept provides a sales enablement platform for sales to design, send,
promote, track, and e-sign sales documents, leveraging sales collateral,
contract management, proposals, and electronic signatures in one place.
license:
name: Apache 2.0
url: 'https://www.apache.org/licenses/LICENSE-2.0.html'
termsOfService: 'https://www.getaccept.com/terms.html'
title: GetAccept
version: '1.6'
host: api.getaccept.com
basePath: /v1
schemes:
- https
paths:
/attachments:
get:
produces:
- application/json
parameters: []
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Attachments'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
tags:
- Attachments
description: >-
Receive a list of available attachments. You can add new attachments in
GetAccept using a new document.
operationId: ListAttachments
summary: List attachments
/auth:
post:
consumes:
- application/json
produces:
- application/json
parameters:
- description: A JSON object containing authentication credentials
in: body
name: body
required: true
schema:
description: Authentication model
properties:
client_id:
default: ''
description: >-
The client id of your app if you received one from our API
team
type: string
email:
description: This is the email of the user in GetAccept
format: email
type: string
entity_id:
default: ''
description: >-
This specifies what entity to select if multiple entities are
available for a user. If no value is specified the default
entity will be selected.
type: string
password:
description: This is the password of the user in GetAccept
format: password
type: string
required:
- email
- password
type: object
x-examples:
Example:
email: user@example.com
password: mysecret
responses:
'200':
description: OK
schema:
properties:
access_token:
description: Token to be used in consequtive requests using bearer header
type: string
expires_in:
description: Seconds until the access token expires
format: int64
minimum: 0
type: integer
type: object
'400':
description: Invalid data
schema:
$ref: '#/definitions/Error'
security: []
tags:
- Authentication
description: >-
Token based authentication is recommended for server-based access or
access from clients where OAuth is not suitable. Access tokens has to be
requested using an administrators login credentials.
Requests should include the header Content-Type with value
application/json
operationId: Authenticate
summary: Authentication by token
x-ms-visibility: internal
/communication-templates:
get:
produces:
- application/json
parameters:
- default: 0
description: Start list from record x
in: query
name: offset
type: integer
- default: 20
description: Number of records to list
in: query
name: limit
type: integer
- description: Filter list on status
enum:
- published
- draft
in: query
name: statuses
type: string
responses:
'200':
description: OK
schema:
properties:
communication_templates:
items:
$ref: '#/definitions/CommunicationTemplate'
type: array
type: object
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
tags:
- Communication Templates
description: Receive a list of available communication templates.
operationId: GetCommunicationTemplates
summary: Get communication templates
post:
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
required: true
schema:
properties:
tags:
items:
type: string
type: array
conversation_sendout_template:
type: object
email_sendout_reminder_template:
type: object
email_sendout_template:
type: object
language:
description: One language code in ISO 639 form
type: string
name:
description: Communication template name
type: string
signed_sendout_template:
type: object
status:
enum:
- published
- draft
type: string
required:
- name
- language
type: object
responses:
'200':
description: OK
schema:
$ref: '#/definitions/CommunicationTemplate'
'400':
description: Invalid data
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
tags:
- Communication Templates
description: Create a communication template.
operationId: CreateCommunicationTemplate
summary: Create communication template
'/communication-templates/{communicationTemplateId}':
get:
produces:
- application/json
parameters:
- description: Communication Template ID
in: path
name: communicationTemplateId
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/CommunicationTemplate'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'404':
description: The specified resource was not found
schema:
$ref: '#/definitions/Error'
tags:
- Communication Templates
description: Receive a specific communication template.
operationId: GetCommunicationTemplate
summary: Get communication template
put:
consumes:
- application/json
produces:
- application/json
parameters:
- description: Communication Template ID
in: path
name: communicationTemplateId
required: true
type: string
- in: body
name: body
required: true
schema:
properties:
tags:
items:
type: string
type: array
conversation_sendout_template:
type: object
email_sendout_reminder_template:
type: object
email_sendout_template:
type: object
language:
type: string
name:
type: string
signed_sendout_template:
type: object
status:
enum:
- published
- draft
type: string
type: object
responses:
'204':
description: No Content
'400':
description: Invalid data
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'404':
description: The specified resource was not found
schema:
$ref: '#/definitions/Error'
tags:
- Communication Templates
description: Updates a specific communication template.
operationId: UpdateCommunicationTemplate
summary: Update communication template
/contacts:
get:
produces:
- application/json
parameters:
- description: Filter list on status
enum:
- active
- inactive
- signed
in: query
name: filter
type: string
- description: How to sort results
enum:
- name
- email
- company_name
- document_count
- created
in: query
name: sort_by
type: string
- description: Sort order of results
enum:
- asc
- desc
in: query
name: sort_order
type: string
- description: Include documents from team members
in: query
name: showteam
type: boolean
- description: Include all contacts from entity
in: query
name: showall
type: boolean
- default: 0
description: Start list from record x
in: query
name: offset
type: integer
- default: 100
description: Number of records to list
in: query
name: limit
type: integer
- description: 'Search string to match first_name, last_name or email'
in: query
name: search
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Contacts'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
tags:
- Contacts
description: >-
Receive a list of available contact for the current entity.
All contacts added as a recipient are saved as a contact and is
available for later use on that entity.
operationId: ListContacts
summary: List contacts
post:
consumes:
- application/json
produces:
- application/json
parameters:
- description: A JSON object containing contact information
in: body
name: body
required: true
schema:
properties:
company_name:
description: Associated company name
type: string
x-ms-summary: Company Name
company_number:
description: Associated company number
type: string
x-ms-summary: Company Number
email:
description: Email address of the contact
type: string
x-ms-summary: Email
first_name:
description: First name of the contact
type: string
x-ms-summary: First name
fullname:
description: Use to specify full name instead of first/last name
type: string
x-ms-summary: Full name
last_name:
description: Last name of the contact
type: string
x-ms-summary: Last name
mobile:
description: Mobile number in international format
type: string
x-ms-summary: Mobile
note:
description: Optional internal note for contact
type: string
x-ms-summary: Note
phone:
description: Phone number in international format
type: string
x-ms-summary: Phone
title:
description: 'The title of the contact, ex. CEO, Sales manager'
type: string
x-ms-summary: Title
type: object
responses:
'200':
description: OK
schema:
properties:
contact_id:
description: ID of the created contact
example: abc58129f
type: string
x-ms-summary: Contact ID
type: object
'400':
description: Invalid data
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
tags:
- Contacts
description: This will create a new contact in the database for the current entity
operationId: CreateContact
summary: Create contact
x-ms-visibility: important
'/contacts/{contactId}':
delete:
produces:
- application/json
parameters:
- description: Contact ID
in: path
name: contactId
required: true
type: string
responses:
'204':
description: No Content
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'404':
description: The specified resource was not found
schema:
$ref: '#/definitions/Error'
tags:
- Contacts
description: >-
Delete a contact. Contacts who are connected to active or signed
documents cannot be deleted.
operationId: DeleteContact
summary: Delete contact
/custom-data/entity:
get:
produces:
- application/json
parameters: []
responses:
'200':
description: OK
schema:
$ref: '#/definitions/EntityCustomData'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
tags:
- Custom Data
description: Get the custom data settings for the current entity.
operationId: GetEntityCustomData
summary: Get entity custom data properties
post:
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
required: true
schema:
properties:
key:
description: Unique key for the custom data property
type: string
label:
description: Human-readable label
type: string
value_type:
description: 'Type of value: string, number, boolean'
enum:
- string
- number
- boolean
type: string
required:
- key
- value_type
- label
type: object
responses:
'200':
description: OK
'400':
description: Invalid data
schema:
$ref: '#/definitions/Error'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
tags:
- Custom Data
description: Add a new custom data property to the current entity.
operationId: AddEntityCustomDataProperty
summary: Add entity custom data property
'/custom-data/entity/{propertyKey}':
delete:
produces:
- application/json
parameters:
- description: Property Key
in: path
name: propertyKey
required: true
type: string
responses:
'204':
description: No Content
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
'404':
description: The specified resource was not found
schema:
$ref: '#/definitions/Error'
tags:
- Custom Data
description: Delete a custom data property from the current entity.
operationId: DeleteEntityCustomDataProperty
summary: Delete entity custom data property
/documents:
get:
produces:
- application/json
parameters:
- description: Filter list on status
enum:
- draft
- sent
- viewed
- reviewed
- signed
- rejected
- recalled
in: query
name: filter
type: string
x-ms-summary: Filter list on status
- description: How to sort results
enum:
- name
- value
- created
- recipient
- status
- owner
in: query
name: sort_by
type: string
x-ms-summary: How to sort results
- description: Sort order of results
enum:
- asc
- desc
in: query
name: sort_order
type: string
x-ms-summary: Sort order of results
- description: Include documents from team members
enum:
- true
- false
in: query
name: showteam
type: boolean
x-ms-summary: Include documents from team members
- description: Include all documents from entity
enum:
- true
- false
in: query
name: showall
type: boolean
x-ms-summary: Include all documents from entity
- description: >-
An external ID is a custom field which can contain a unique record
identifier from a system outside of GetAccept
in: query
name: external_id
type: string
x-ms-summary: External ID
- description: Start list from record x until limit
in: query
name: offset
type: number
x-ms-summary: Offset
- description: Number of records to list
in: query
name: limit
type: number
x-ms-summary: Limit
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Documents'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/Error'
tags:
- Documents
description: Get a list of available documents
operationId: ListDocuments
summary: List documents
post:
consumes:
- application/json
produces:
- application/json
parameters:
- description: A JSON object containing document information
in: body
name: body
required: true
schema:
properties:
attachments:
description: Attachments
items:
properties:
id:
description: Attachment ID received from list or after upload
type: string
x-ms-dynamic-values:
operationId: ListAttachments
value-collection: attachments
value-path: attachment_id
value-title: attachment_title
x-ms-summary: ID
require_view:
description: Require that recipient view the attachment
enum:
- true
- false
example: true
type: boolean
x-ms-summary: Require view
x-nullable: true
type:
description: >-
file or external where file is an uploaded file and
external is a link to an external file
enum:
- file
- external
type: string
x-ms-summary: Type
type: object
type: array
x-ms-summary: Attachment
custom_data:
description: >-
A list of custom data to include with the document. If the
property is already defined on the template, it will be
overridden by the value provided here.
properties:
properties:
description: An array of objects containing custom data properties
items:
properties:
key:
description: Key of the custom data property
type: string
x-ms-summary: Key
label:
description: Label of the custom data property
type: string
x-ms-summary: Label
value:
description: Value of the custom data property
type: string
x-ms-summary: Value
value_type:
description: 'Type of the value: string, number, boolean'
enum:
- string
- number
- boolean
type: string
x-ms-summary: Value Type
type: object
type: array
x-ms-summary: Properties
type: object
x-ms-summary: Custom Data
x-ms-visibility: advanced
custom_fields:
description: Custom field
items:
properties:
id:
description: ID of custom template field
type: string
x-ms-summary: Field ID
name:
description: Name of custom template field
type: string
x-ms-summary: Field Name
value:
description: Value of custom template field
type: string
x-ms-summary: Field Value
type: object
type: array
x-ms-summary: Custom
custom_pricing_tables:
description: Pricing
items:
properties:
currency_settings:
description: Currency Settings
properties:
currency:
description: 'Currency, ex. SEK'
type: string
x-ms-summary: Currency
locale:
description: 'Locale, ex. sv-SE'
type: string
x-ms-summary: Locale
type: object
x-ms-summary: Currency Settings
x-ms-visibility: advanced
display_name:
description: Display name of the pricing table
type: string
x-ms-summary: Display Name
x-ms-visibility: advanced
external_id:
description: >-
External ID to represent the summary object within a
third-party system
type: string
x-ms-summary: External ID
x-ms-visibility: advanced
id:
description: Table ID
type: string
x-ms-summary: Table ID
x-ms-visibility: advanced
pre_calculated:
default: false
description: If pricing table totals should be pre-calculated
enum:
- true
- false
example: true
type: boolean
x-ms-summary: Precalculated totals
x-ms-visibility: advanced
sections:
description: Sections
items:
properties:
display_name:
description: Display name of the pricing table
type: string
x-ms-summary: Display Name
id:
description: Section ID
type: string
x-ms-summary: ID
rows:
additionalProperties:
items:
type: object
type: array
description: >-
Array with values object with array of column_id,
value
example:
- values:
- column_id: abc123
value: My product
- column_id: def456
value: 240
x-ms-summary: Rows
section_summary:
properties:
discount:
properties:
enabled:
description: If section discount should be enabled
enum:
- true
- false
example: true
type: boolean
x-ms-summary: Enabled
x-nullable: true
flat_fee:
description: >-
If section should use using flat fee
discounts
enum:
- true
- false
example: true
type: boolean
x-ms-summary: Flat fee
x-nullable: true
value:
description: The value for section discount
type: string
x-ms-summary: Discount Value
type: object
x-ms-summary: Discount
price:
properties:
enabled:
description: If section price should be enabled
enum:
- true
- false
example: true
type: boolean
x-ms-summary: Enabled
x-nullable: true
flat_fee:
description: >-
If section should use using flat fee
pricing
enum:
- true
- false
example: true
type: boolean
x-ms-summary: Flat fee
x-nullable: true
value:
description: The value for section price
type: string
x-ms-summary: Price Value
type: object
x-ms-summary: Price
tax:
properties:
enabled:
description: If section tax should be enabled
enum:
- true
- false
example: true
type: boolean
x-ms-summary: Enabled
x-nullable: true
flat_fee:
description: If section should use using flat fee taxes
enum:
- true
- false
example: true
type: boolean
x-ms-summary: Flat fee
x-nullable: true
value:
description: The value for section tax
type: string
x-ms-summary: Tax Value
type: object
x-ms-summary: Tax
type: object
x-ms-summary: Summary Values
type: object
type: array
x-ms-summary: Section
x-ms-visibility: advanced
summary_values:
properties:
discount:
properties:
enabled:
description: If pricing table discount should be enabled
enum:
- true
- false
example: true
type: boolean
x-ms-summary: Enabled
x-ms-visibility: advanced
x-nullable: true
flat_fee:
description: >-
If pricing table should use using flat fee
discounts
enum:
- true
- false
example: true
type: boolean
x-ms-summary: Flat fee
x-ms-visibility: advanced
x-nullable: true
value:
description: The value for summary discount
type: string
x-ms-summary: Discount Value
type: object
x-ms-summary: Discount
price:
properties:
enabled:
description: If pricing table price should be enabled
enum:
- true
- false
example: true
type: boolean
x-ms-summary: Enabled
x-ms-visibility: advanced
x-nullable: true
flat_fee:
description: >-
If pricing table should use using flat fee
pricing
enum:
- true
- false
example: true
type: boolean
x-ms-summary: Flat fee
x-ms-visibility: advanced
x-nullable: true
value:
description: The value for summary price
type: string
x-ms-summary: Price Value
type: object
x-ms-summary: Price
tax:
properties:
enabled:
description: If pricing table tax should be enabled
enum:
- true
- false
example: true
type: boolean
x-ms-summary: Enabled
x-ms-visibility: advanced
x-nullable: true
flat_fee:
description: If pricing table should use using flat fee taxes
enum:
- true
- false
example: true
type: boolean
x-ms-summary: Flat fee
x-ms-visibility: advanced
x-nullable: true
value:
description: The value for summary tax
type: string