@zapier/zapier-sdk-core 0.5.0 → 0.5.2

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 (25) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/index.cjs +29 -0
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.js +29 -0
  5. package/dist/index.js.map +1 -1
  6. package/dist/v0/schemas/actions.cjs +17 -2
  7. package/dist/v0/schemas/actions.cjs.map +1 -1
  8. package/dist/v0/schemas/actions.d.cts +48 -1
  9. package/dist/v0/schemas/actions.d.ts +48 -1
  10. package/dist/v0/schemas/actions.js +14 -1
  11. package/dist/v0/schemas/actions.js.map +1 -1
  12. package/dist/v0/schemas/apps.cjs +1 -1
  13. package/dist/v0/schemas/apps.cjs.map +1 -1
  14. package/dist/v0/schemas/apps.d.cts +1 -1
  15. package/dist/v0/schemas/apps.d.ts +1 -1
  16. package/dist/v0/schemas/apps.js +1 -1
  17. package/dist/v0/schemas/apps.js.map +1 -1
  18. package/dist/v0/schemas/authentications.cjs +35 -2
  19. package/dist/v0/schemas/authentications.cjs.map +1 -1
  20. package/dist/v0/schemas/authentications.d.cts +58 -1
  21. package/dist/v0/schemas/authentications.d.ts +58 -1
  22. package/dist/v0/schemas/authentications.js +32 -1
  23. package/dist/v0/schemas/authentications.js.map +1 -1
  24. package/openapi.yaml +208 -208
  25. package/package.json +1 -1
package/openapi.yaml CHANGED
@@ -346,6 +346,204 @@ components:
346
346
  description: Array of action items
347
347
  required:
348
348
  - data
349
+ description: Response schema for listActions
350
+ ListAppsResponse:
351
+ type: object
352
+ properties:
353
+ data:
354
+ type: array
355
+ items:
356
+ type: object
357
+ properties:
358
+ slug:
359
+ type: string
360
+ description: URL-friendly slug identifier
361
+ age_in_days:
362
+ type: number
363
+ description: Number of days since the implementation was created
364
+ auth_type:
365
+ type: string
366
+ description: Authentication type (e.g., oauth2, api_key)
367
+ banner:
368
+ type: string
369
+ description: Banner message or status indicator
370
+ categories:
371
+ type: array
372
+ items:
373
+ type: object
374
+ properties:
375
+ id:
376
+ type: number
377
+ description: Unique identifier for the category
378
+ name:
379
+ type: string
380
+ description: Display name of the category
381
+ slug:
382
+ type: string
383
+ description: URL-friendly slug for the category
384
+ required:
385
+ - id
386
+ - name
387
+ - slug
388
+ description: Categories the implementation belongs to
389
+ images:
390
+ type: object
391
+ properties:
392
+ url_16x16:
393
+ type: string
394
+ description: 16x16 pixel icon URL
395
+ url_32x32:
396
+ type: string
397
+ description: 32x32 pixel icon URL
398
+ url_64x64:
399
+ type: string
400
+ description: 64x64 pixel icon URL
401
+ url_128x128:
402
+ type: string
403
+ description: 128x128 pixel icon URL
404
+ description: Icon images at various sizes
405
+ popularity:
406
+ type: number
407
+ description: Popularity score for ranking apps
408
+ has_filters:
409
+ type: boolean
410
+ description: Whether the app has filter actions
411
+ has_reads:
412
+ type: boolean
413
+ description: Whether the app has read actions
414
+ has_searches:
415
+ type: boolean
416
+ description: Whether the app has search actions
417
+ has_searches_or_writes:
418
+ type: boolean
419
+ description: Whether the app has search or write actions
420
+ has_upfront_fields:
421
+ type: boolean
422
+ description: Whether the app has upfront input fields
423
+ has_writes:
424
+ type: boolean
425
+ description: Whether the app has write actions
426
+ is_beta:
427
+ type: boolean
428
+ description: Whether the app is in beta
429
+ is_built_in:
430
+ type: boolean
431
+ description: Whether the app is a built-in Zapier app
432
+ is_deprecated:
433
+ type: boolean
434
+ description: Whether the app is deprecated
435
+ is_featured:
436
+ type: boolean
437
+ description: Whether the app is featured
438
+ is_hidden:
439
+ type: boolean
440
+ description: Whether the app is hidden from listings
441
+ is_invite:
442
+ type: boolean
443
+ description: Whether the app is invite-only
444
+ is_premium:
445
+ type: boolean
446
+ description: Whether the app requires a premium plan
447
+ is_public:
448
+ type: boolean
449
+ description: Whether the app is publicly available
450
+ is_upcoming:
451
+ type: boolean
452
+ description: Whether the app is upcoming/not yet released
453
+ version:
454
+ type: string
455
+ description: App version
456
+ visibility:
457
+ type: string
458
+ description: Visibility status (e.g., public, private)
459
+ actions:
460
+ type: object
461
+ properties:
462
+ read:
463
+ type: number
464
+ description: Number of read actions
465
+ read_bulk:
466
+ type: number
467
+ description: Number of bulk read actions
468
+ write:
469
+ type: number
470
+ description: Number of write actions
471
+ search:
472
+ type: number
473
+ description: Number of search actions
474
+ search_or_write:
475
+ type: number
476
+ description: Number of search-or-write actions
477
+ search_and_write:
478
+ type: number
479
+ description: Number of search-and-write actions
480
+ filter:
481
+ type: number
482
+ description: Number of filter actions
483
+ description: Count of available actions by type
484
+ description:
485
+ type: string
486
+ description: Description of the app
487
+ primary_color:
488
+ type: string
489
+ description: Primary brand color (hex)
490
+ secondary_color:
491
+ type: string
492
+ description: Secondary brand color (hex)
493
+ classification:
494
+ type: string
495
+ description: App classification category
496
+ api_docs_url:
497
+ type: string
498
+ description: URL to API documentation
499
+ image:
500
+ type: string
501
+ description: Default image URL for the app
502
+ title:
503
+ type: string
504
+ description: Display name of the app
505
+ key:
506
+ type: string
507
+ description: App key (versionless implementation name)
508
+ implementation_id:
509
+ type: string
510
+ description: Full implementation ID including version
511
+ required:
512
+ - slug
513
+ - title
514
+ - key
515
+ - implementation_id
516
+ description: Array of app items
517
+ links:
518
+ type: object
519
+ properties:
520
+ next:
521
+ type:
522
+ - string
523
+ - "null"
524
+ description: Fully qualified URL for the next page of results (if available)
525
+ description: Pagination links for navigating through results
526
+ meta:
527
+ type: object
528
+ properties:
529
+ count:
530
+ type: number
531
+ description: Number of items in current page
532
+ limit:
533
+ type: number
534
+ description: Number of items per page
535
+ offset:
536
+ type: number
537
+ description: Offset of the current page
538
+ required:
539
+ - count
540
+ - limit
541
+ - offset
542
+ description: Metadata for the paginated result set
543
+ required:
544
+ - data
545
+ - links
546
+ - meta
349
547
  ListAuthenticationsResponse:
350
548
  type: object
351
549
  properties:
@@ -482,6 +680,7 @@ components:
482
680
  - data
483
681
  - links
484
682
  - meta
683
+ description: Response schema for listing authentications
485
684
  parameters: {}
486
685
  securitySchemes:
487
686
  userJwt:
@@ -691,13 +890,11 @@ paths:
691
890
  name: search
692
891
  in: query
693
892
  - schema:
694
- type: integer
893
+ type: number
695
894
  minimum: 1
696
- maximum: 100
697
- default: 20
698
- description: Number of apps per page (1-100)
895
+ description: Number of apps per page
699
896
  required: false
700
- description: Number of apps per page (1-100)
897
+ description: Number of apps per page
701
898
  name: pageSize
702
899
  in: query
703
900
  - schema:
@@ -713,202 +910,7 @@ paths:
713
910
  content:
714
911
  application/json:
715
912
  schema:
716
- type: object
717
- properties:
718
- data:
719
- type: array
720
- items:
721
- type: object
722
- properties:
723
- slug:
724
- type: string
725
- description: URL-friendly slug identifier
726
- age_in_days:
727
- type: number
728
- description: Number of days since the implementation was created
729
- auth_type:
730
- type: string
731
- description: Authentication type (e.g., oauth2, api_key)
732
- banner:
733
- type: string
734
- description: Banner message or status indicator
735
- categories:
736
- type: array
737
- items:
738
- type: object
739
- properties:
740
- id:
741
- type: number
742
- description: Unique identifier for the category
743
- name:
744
- type: string
745
- description: Display name of the category
746
- slug:
747
- type: string
748
- description: URL-friendly slug for the category
749
- required:
750
- - id
751
- - name
752
- - slug
753
- description: Categories the implementation belongs to
754
- images:
755
- type: object
756
- properties:
757
- url_16x16:
758
- type: string
759
- description: 16x16 pixel icon URL
760
- url_32x32:
761
- type: string
762
- description: 32x32 pixel icon URL
763
- url_64x64:
764
- type: string
765
- description: 64x64 pixel icon URL
766
- url_128x128:
767
- type: string
768
- description: 128x128 pixel icon URL
769
- description: Icon images at various sizes
770
- popularity:
771
- type: number
772
- description: Popularity score for ranking apps
773
- has_filters:
774
- type: boolean
775
- description: Whether the app has filter actions
776
- has_reads:
777
- type: boolean
778
- description: Whether the app has read actions
779
- has_searches:
780
- type: boolean
781
- description: Whether the app has search actions
782
- has_searches_or_writes:
783
- type: boolean
784
- description: Whether the app has search or write actions
785
- has_upfront_fields:
786
- type: boolean
787
- description: Whether the app has upfront input fields
788
- has_writes:
789
- type: boolean
790
- description: Whether the app has write actions
791
- is_beta:
792
- type: boolean
793
- description: Whether the app is in beta
794
- is_built_in:
795
- type: boolean
796
- description: Whether the app is a built-in Zapier app
797
- is_deprecated:
798
- type: boolean
799
- description: Whether the app is deprecated
800
- is_featured:
801
- type: boolean
802
- description: Whether the app is featured
803
- is_hidden:
804
- type: boolean
805
- description: Whether the app is hidden from listings
806
- is_invite:
807
- type: boolean
808
- description: Whether the app is invite-only
809
- is_premium:
810
- type: boolean
811
- description: Whether the app requires a premium plan
812
- is_public:
813
- type: boolean
814
- description: Whether the app is publicly available
815
- is_upcoming:
816
- type: boolean
817
- description: Whether the app is upcoming/not yet released
818
- version:
819
- type: string
820
- description: App version
821
- visibility:
822
- type: string
823
- description: Visibility status (e.g., public, private)
824
- actions:
825
- type: object
826
- properties:
827
- read:
828
- type: number
829
- description: Number of read actions
830
- read_bulk:
831
- type: number
832
- description: Number of bulk read actions
833
- write:
834
- type: number
835
- description: Number of write actions
836
- search:
837
- type: number
838
- description: Number of search actions
839
- search_or_write:
840
- type: number
841
- description: Number of search-or-write actions
842
- search_and_write:
843
- type: number
844
- description: Number of search-and-write actions
845
- filter:
846
- type: number
847
- description: Number of filter actions
848
- description: Count of available actions by type
849
- description:
850
- type: string
851
- description: Description of the app
852
- primary_color:
853
- type: string
854
- description: Primary brand color (hex)
855
- secondary_color:
856
- type: string
857
- description: Secondary brand color (hex)
858
- classification:
859
- type: string
860
- description: App classification category
861
- api_docs_url:
862
- type: string
863
- description: URL to API documentation
864
- image:
865
- type: string
866
- description: Default image URL for the app
867
- title:
868
- type: string
869
- description: Display name of the app
870
- key:
871
- type: string
872
- description: App key (versionless implementation name)
873
- implementation_id:
874
- type: string
875
- description: Full implementation ID including version
876
- required:
877
- - slug
878
- - title
879
- - key
880
- - implementation_id
881
- description: Array of app items
882
- links:
883
- type: object
884
- properties:
885
- next:
886
- type:
887
- - string
888
- - "null"
889
- description: Fully qualified URL for the next page of results (if available)
890
- description: Pagination links for navigating through results
891
- meta:
892
- type: object
893
- properties:
894
- count:
895
- type: number
896
- description: Number of items in current page
897
- limit:
898
- type: number
899
- description: Number of items per page
900
- offset:
901
- type: number
902
- description: Offset of the current page
903
- required:
904
- - count
905
- - limit
906
- - offset
907
- description: Metadata for the paginated result set
908
- required:
909
- - data
910
- - links
911
- - meta
913
+ $ref: "#/components/schemas/ListAppsResponse"
912
914
  "400":
913
915
  description: Bad Request
914
916
  content:
@@ -978,19 +980,17 @@ paths:
978
980
  in: query
979
981
  - schema:
980
982
  type: string
981
- description: Filter by owner - 'me' for your own authentications or a specific user ID
983
+ description: Filter by owner, 'me' for your own authentications or a specific user ID
982
984
  required: false
983
- description: Filter by owner - 'me' for your own authentications or a specific user ID
985
+ description: Filter by owner, 'me' for your own authentications or a specific user ID
984
986
  name: owner
985
987
  in: query
986
988
  - schema:
987
- type: integer
989
+ type: number
988
990
  minimum: 1
989
- maximum: 100
990
- default: 50
991
- description: Number of authentications per page (1-100)
991
+ description: Number of authentications per page
992
992
  required: false
993
- description: Number of authentications per page (1-100)
993
+ description: Number of authentications per page
994
994
  name: pageSize
995
995
  in: query
996
996
  - schema:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zapier/zapier-sdk-core",
3
- "version": "0.5.0",
3
+ "version": "0.5.2",
4
4
  "description": "Core schemas and TypeScript types for the Zapier SDK API",
5
5
  "license": "SEE LICENSE IN LICENSE",
6
6
  "author": "Zapier, Inc.",