@zapier/zapier-sdk-core 0.5.1 → 0.6.0

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 +5 -2
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.js +5 -2
  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 +5 -2
  19. package/dist/v0/schemas/authentications.cjs.map +1 -1
  20. package/dist/v0/schemas/authentications.d.cts +2 -1
  21. package/dist/v0/schemas/authentications.d.ts +2 -1
  22. package/dist/v0/schemas/authentications.js +5 -2
  23. package/dist/v0/schemas/authentications.js.map +1 -1
  24. package/openapi.yaml +214 -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:
@@ -692,13 +890,11 @@ paths:
692
890
  name: search
693
891
  in: query
694
892
  - schema:
695
- type: integer
893
+ type: number
696
894
  minimum: 1
697
- maximum: 100
698
- default: 20
699
- description: Number of apps per page (1-100)
895
+ description: Number of apps per page
700
896
  required: false
701
- description: Number of apps per page (1-100)
897
+ description: Number of apps per page
702
898
  name: pageSize
703
899
  in: query
704
900
  - schema:
@@ -714,202 +910,7 @@ paths:
714
910
  content:
715
911
  application/json:
716
912
  schema:
717
- type: object
718
- properties:
719
- data:
720
- type: array
721
- items:
722
- type: object
723
- properties:
724
- slug:
725
- type: string
726
- description: URL-friendly slug identifier
727
- age_in_days:
728
- type: number
729
- description: Number of days since the implementation was created
730
- auth_type:
731
- type: string
732
- description: Authentication type (e.g., oauth2, api_key)
733
- banner:
734
- type: string
735
- description: Banner message or status indicator
736
- categories:
737
- type: array
738
- items:
739
- type: object
740
- properties:
741
- id:
742
- type: number
743
- description: Unique identifier for the category
744
- name:
745
- type: string
746
- description: Display name of the category
747
- slug:
748
- type: string
749
- description: URL-friendly slug for the category
750
- required:
751
- - id
752
- - name
753
- - slug
754
- description: Categories the implementation belongs to
755
- images:
756
- type: object
757
- properties:
758
- url_16x16:
759
- type: string
760
- description: 16x16 pixel icon URL
761
- url_32x32:
762
- type: string
763
- description: 32x32 pixel icon URL
764
- url_64x64:
765
- type: string
766
- description: 64x64 pixel icon URL
767
- url_128x128:
768
- type: string
769
- description: 128x128 pixel icon URL
770
- description: Icon images at various sizes
771
- popularity:
772
- type: number
773
- description: Popularity score for ranking apps
774
- has_filters:
775
- type: boolean
776
- description: Whether the app has filter actions
777
- has_reads:
778
- type: boolean
779
- description: Whether the app has read actions
780
- has_searches:
781
- type: boolean
782
- description: Whether the app has search actions
783
- has_searches_or_writes:
784
- type: boolean
785
- description: Whether the app has search or write actions
786
- has_upfront_fields:
787
- type: boolean
788
- description: Whether the app has upfront input fields
789
- has_writes:
790
- type: boolean
791
- description: Whether the app has write actions
792
- is_beta:
793
- type: boolean
794
- description: Whether the app is in beta
795
- is_built_in:
796
- type: boolean
797
- description: Whether the app is a built-in Zapier app
798
- is_deprecated:
799
- type: boolean
800
- description: Whether the app is deprecated
801
- is_featured:
802
- type: boolean
803
- description: Whether the app is featured
804
- is_hidden:
805
- type: boolean
806
- description: Whether the app is hidden from listings
807
- is_invite:
808
- type: boolean
809
- description: Whether the app is invite-only
810
- is_premium:
811
- type: boolean
812
- description: Whether the app requires a premium plan
813
- is_public:
814
- type: boolean
815
- description: Whether the app is publicly available
816
- is_upcoming:
817
- type: boolean
818
- description: Whether the app is upcoming/not yet released
819
- version:
820
- type: string
821
- description: App version
822
- visibility:
823
- type: string
824
- description: Visibility status (e.g., public, private)
825
- actions:
826
- type: object
827
- properties:
828
- read:
829
- type: number
830
- description: Number of read actions
831
- read_bulk:
832
- type: number
833
- description: Number of bulk read actions
834
- write:
835
- type: number
836
- description: Number of write actions
837
- search:
838
- type: number
839
- description: Number of search actions
840
- search_or_write:
841
- type: number
842
- description: Number of search-or-write actions
843
- search_and_write:
844
- type: number
845
- description: Number of search-and-write actions
846
- filter:
847
- type: number
848
- description: Number of filter actions
849
- description: Count of available actions by type
850
- description:
851
- type: string
852
- description: Description of the app
853
- primary_color:
854
- type: string
855
- description: Primary brand color (hex)
856
- secondary_color:
857
- type: string
858
- description: Secondary brand color (hex)
859
- classification:
860
- type: string
861
- description: App classification category
862
- api_docs_url:
863
- type: string
864
- description: URL to API documentation
865
- image:
866
- type: string
867
- description: Default image URL for the app
868
- title:
869
- type: string
870
- description: Display name of the app
871
- key:
872
- type: string
873
- description: App key (versionless implementation name)
874
- implementation_id:
875
- type: string
876
- description: Full implementation ID including version
877
- required:
878
- - slug
879
- - title
880
- - key
881
- - implementation_id
882
- description: Array of app items
883
- links:
884
- type: object
885
- properties:
886
- next:
887
- type:
888
- - string
889
- - "null"
890
- description: Fully qualified URL for the next page of results (if available)
891
- description: Pagination links for navigating through results
892
- meta:
893
- type: object
894
- properties:
895
- count:
896
- type: number
897
- description: Number of items in current page
898
- limit:
899
- type: number
900
- description: Number of items per page
901
- offset:
902
- type: number
903
- description: Offset of the current page
904
- required:
905
- - count
906
- - limit
907
- - offset
908
- description: Metadata for the paginated result set
909
- required:
910
- - data
911
- - links
912
- - meta
913
+ $ref: "#/components/schemas/ListAppsResponse"
913
914
  "400":
914
915
  description: Bad Request
915
916
  content:
@@ -979,19 +980,24 @@ paths:
979
980
  in: query
980
981
  - schema:
981
982
  type: string
982
- 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
983
984
  required: false
984
- 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
985
986
  name: owner
986
987
  in: query
987
988
  - schema:
988
- type: integer
989
+ type: boolean
990
+ description: Filter by expired status (true = expired only, false = non-expired only)
991
+ required: false
992
+ description: Filter by expired status (true = expired only, false = non-expired only)
993
+ name: isExpired
994
+ in: query
995
+ - schema:
996
+ type: number
989
997
  minimum: 1
990
- maximum: 100
991
- default: 50
992
- description: Number of authentications per page (1-100)
998
+ description: Number of authentications per page
993
999
  required: false
994
- description: Number of authentications per page (1-100)
1000
+ description: Number of authentications per page
995
1001
  name: pageSize
996
1002
  in: query
997
1003
  - schema:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zapier/zapier-sdk-core",
3
- "version": "0.5.1",
3
+ "version": "0.6.0",
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.",