@convertrilo/sdk 0.0.7 → 0.0.8
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.
- package/dist/src/types.d.ts +12 -5
- package/openapi.yaml +12 -9
- package/package.json +1 -1
package/dist/src/types.d.ts
CHANGED
|
@@ -564,7 +564,7 @@ export interface paths {
|
|
|
564
564
|
};
|
|
565
565
|
/**
|
|
566
566
|
* List webhooks
|
|
567
|
-
* @description List managed webhook subscriptions for the authenticated user. Managed webhook deliveries include HMAC-SHA256 signatures.
|
|
567
|
+
* @description List managed webhook subscriptions for the authenticated user. API keys need the `webhooks:manage` scope. Managed webhook deliveries include HMAC-SHA256 signatures.
|
|
568
568
|
*/
|
|
569
569
|
get: {
|
|
570
570
|
parameters: {
|
|
@@ -591,6 +591,7 @@ export interface paths {
|
|
|
591
591
|
* Create a webhook
|
|
592
592
|
* @description Create a managed webhook subscription. The response includes `secret` exactly once.
|
|
593
593
|
* Store it securely and use it to verify `X-Webhook-Signature`.
|
|
594
|
+
* API keys need the `webhooks:manage` scope.
|
|
594
595
|
*/
|
|
595
596
|
post: {
|
|
596
597
|
parameters: {
|
|
@@ -633,7 +634,7 @@ export interface paths {
|
|
|
633
634
|
put?: never;
|
|
634
635
|
/**
|
|
635
636
|
* Test a webhook
|
|
636
|
-
* @description Sends a `webhook.test` event to the configured URL using the same HMAC signature header as managed deliveries.
|
|
637
|
+
* @description Sends a `webhook.test` event to the configured URL using the same HMAC signature header as managed deliveries. API keys need the `webhooks:manage` scope.
|
|
637
638
|
*/
|
|
638
639
|
post: {
|
|
639
640
|
parameters: {
|
|
@@ -655,7 +656,10 @@ export interface paths {
|
|
|
655
656
|
};
|
|
656
657
|
};
|
|
657
658
|
};
|
|
658
|
-
/**
|
|
659
|
+
/**
|
|
660
|
+
* Delete a webhook
|
|
661
|
+
* @description API keys need the `webhooks:manage` scope.
|
|
662
|
+
*/
|
|
659
663
|
delete: {
|
|
660
664
|
parameters: {
|
|
661
665
|
query?: never;
|
|
@@ -678,7 +682,10 @@ export interface paths {
|
|
|
678
682
|
};
|
|
679
683
|
options?: never;
|
|
680
684
|
head?: never;
|
|
681
|
-
/**
|
|
685
|
+
/**
|
|
686
|
+
* Update a webhook
|
|
687
|
+
* @description API keys need the `webhooks:manage` scope.
|
|
688
|
+
*/
|
|
682
689
|
patch: {
|
|
683
690
|
parameters: {
|
|
684
691
|
query?: never;
|
|
@@ -716,7 +723,7 @@ export interface paths {
|
|
|
716
723
|
};
|
|
717
724
|
/**
|
|
718
725
|
* List webhook delivery attempts
|
|
719
|
-
* @description Returns the 50 most recent managed or test delivery attempts for this webhook.
|
|
726
|
+
* @description Returns the 50 most recent managed or test delivery attempts for this webhook. API keys need the `webhooks:manage` scope.
|
|
720
727
|
*/
|
|
721
728
|
get: {
|
|
722
729
|
parameters: {
|
package/openapi.yaml
CHANGED
|
@@ -839,9 +839,9 @@ paths:
|
|
|
839
839
|
|
|
840
840
|
/webhooks:
|
|
841
841
|
get:
|
|
842
|
-
security: [{ BearerAuth: [] }]
|
|
842
|
+
security: [{ BearerAuth: [] }, { ApiKeyAuth: [] }]
|
|
843
843
|
summary: List webhooks
|
|
844
|
-
description: List managed webhook subscriptions for the authenticated user. Managed webhook deliveries include HMAC-SHA256 signatures.
|
|
844
|
+
description: List managed webhook subscriptions for the authenticated user. API keys need the `webhooks:manage` scope. Managed webhook deliveries include HMAC-SHA256 signatures.
|
|
845
845
|
responses:
|
|
846
846
|
"200":
|
|
847
847
|
description: List of webhooks
|
|
@@ -850,11 +850,12 @@ paths:
|
|
|
850
850
|
schema:
|
|
851
851
|
$ref: "#/components/schemas/WebhookListResponse"
|
|
852
852
|
post:
|
|
853
|
-
security: [{ BearerAuth: [] }]
|
|
853
|
+
security: [{ BearerAuth: [] }, { ApiKeyAuth: [] }]
|
|
854
854
|
summary: Create a webhook
|
|
855
855
|
description: |
|
|
856
856
|
Create a managed webhook subscription. The response includes `secret` exactly once.
|
|
857
857
|
Store it securely and use it to verify `X-Webhook-Signature`.
|
|
858
|
+
API keys need the `webhooks:manage` scope.
|
|
858
859
|
requestBody:
|
|
859
860
|
required: true
|
|
860
861
|
content:
|
|
@@ -876,8 +877,9 @@ paths:
|
|
|
876
877
|
$ref: "#/components/schemas/WebhookResponse"
|
|
877
878
|
/webhooks/{id}:
|
|
878
879
|
patch:
|
|
879
|
-
security: [{ BearerAuth: [] }]
|
|
880
|
+
security: [{ BearerAuth: [] }, { ApiKeyAuth: [] }]
|
|
880
881
|
summary: Update a webhook
|
|
882
|
+
description: API keys need the `webhooks:manage` scope.
|
|
881
883
|
parameters:
|
|
882
884
|
- in: path
|
|
883
885
|
name: id
|
|
@@ -906,8 +908,9 @@ paths:
|
|
|
906
908
|
schema:
|
|
907
909
|
$ref: "#/components/schemas/WebhookResponse"
|
|
908
910
|
delete:
|
|
909
|
-
security: [{ BearerAuth: [] }]
|
|
911
|
+
security: [{ BearerAuth: [] }, { ApiKeyAuth: [] }]
|
|
910
912
|
summary: Delete a webhook
|
|
913
|
+
description: API keys need the `webhooks:manage` scope.
|
|
911
914
|
parameters:
|
|
912
915
|
- in: path
|
|
913
916
|
name: id
|
|
@@ -916,9 +919,9 @@ paths:
|
|
|
916
919
|
responses:
|
|
917
920
|
"204": { description: Deleted }
|
|
918
921
|
post:
|
|
919
|
-
security: [{ BearerAuth: [] }]
|
|
922
|
+
security: [{ BearerAuth: [] }, { ApiKeyAuth: [] }]
|
|
920
923
|
summary: Test a webhook
|
|
921
|
-
description: Sends a `webhook.test` event to the configured URL using the same HMAC signature header as managed deliveries.
|
|
924
|
+
description: Sends a `webhook.test` event to the configured URL using the same HMAC signature header as managed deliveries. API keys need the `webhooks:manage` scope.
|
|
922
925
|
parameters:
|
|
923
926
|
- in: path
|
|
924
927
|
name: id
|
|
@@ -928,9 +931,9 @@ paths:
|
|
|
928
931
|
"200": { description: Test event sent }
|
|
929
932
|
/webhooks/{id}/deliveries:
|
|
930
933
|
get:
|
|
931
|
-
security: [{ BearerAuth: [] }]
|
|
934
|
+
security: [{ BearerAuth: [] }, { ApiKeyAuth: [] }]
|
|
932
935
|
summary: List webhook delivery attempts
|
|
933
|
-
description: Returns the 50 most recent managed or test delivery attempts for this webhook.
|
|
936
|
+
description: Returns the 50 most recent managed or test delivery attempts for this webhook. API keys need the `webhooks:manage` scope.
|
|
934
937
|
parameters:
|
|
935
938
|
- in: path
|
|
936
939
|
name: id
|