@mazmo/sdk 3.0.0 → 3.1.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.
- package/README.md +1 -1
- package/dist/index.cjs +1 -0
- package/dist/index.d.cts +60 -0
- package/dist/index.d.ts +60 -0
- package/dist/index.js +1 -0
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -52,4 +52,4 @@ Each release says, at the end of this page, which version of the API it was buil
|
|
|
52
52
|
|
|
53
53
|
The reference of every endpoint is at [docs.mazmo.net](https://docs.mazmo.net).
|
|
54
54
|
|
|
55
|
-
Built against version 7.7.
|
|
55
|
+
Built against version 7.7.85 of the Mazmo API.
|
package/dist/index.cjs
CHANGED
|
@@ -302,6 +302,7 @@ var routes = {
|
|
|
302
302
|
listBlocks: { method: "GET", path: "/users/blocks" },
|
|
303
303
|
listFollowLists: { method: "GET", path: "/users/followlists" },
|
|
304
304
|
listMyOrgPointsLedger: { method: "GET", path: "/users/orgpoints/ledger" },
|
|
305
|
+
listOrganizationWebhookDeliveries: { method: "GET", path: "/users/:username/webhookdeliveries" },
|
|
305
306
|
listOrgPointsHolders: { method: "GET", path: "/users/orgpoints/users" },
|
|
306
307
|
listReports: { method: "GET", path: "/users/reports" },
|
|
307
308
|
listSavedSearches: { method: "GET", path: "/users/saved-searches" },
|
package/dist/index.d.cts
CHANGED
|
@@ -1459,6 +1459,45 @@ interface Order {
|
|
|
1459
1459
|
createdAt: string;
|
|
1460
1460
|
updatedAt: string;
|
|
1461
1461
|
}
|
|
1462
|
+
interface OrganizationWebhookDeliveries {
|
|
1463
|
+
deliveries: OrganizationWebhookDelivery[];
|
|
1464
|
+
}
|
|
1465
|
+
interface OrganizationWebhookDelivery {
|
|
1466
|
+
id: string;
|
|
1467
|
+
event: "channel.message" | "channel.join" | "channel.part" | "channel.ban" | "channel.unban";
|
|
1468
|
+
/**
|
|
1469
|
+
* The URL the event was sent to.
|
|
1470
|
+
*/
|
|
1471
|
+
url: string;
|
|
1472
|
+
/**
|
|
1473
|
+
* When the last attempt was sent.
|
|
1474
|
+
*/
|
|
1475
|
+
sentAt: string;
|
|
1476
|
+
/**
|
|
1477
|
+
* How many attempts it took, the last one included.
|
|
1478
|
+
*/
|
|
1479
|
+
attempts: number;
|
|
1480
|
+
/**
|
|
1481
|
+
* Whether the URL answered a 2xx status.
|
|
1482
|
+
*/
|
|
1483
|
+
delivered: boolean;
|
|
1484
|
+
/**
|
|
1485
|
+
* The HTTP status the URL answered on the last attempt, or null when it answered none.
|
|
1486
|
+
*/
|
|
1487
|
+
status: number | null;
|
|
1488
|
+
/**
|
|
1489
|
+
* Why the last attempt got no response: `timeout` when the URL answered nothing in time, `refused` when it refused the connection, `dns` when its host does not resolve, `not-public` when it points to an address that is not public, `connection` when it could not be reached otherwise. Null when it answered a status.
|
|
1490
|
+
*/
|
|
1491
|
+
error: "timeout" | "refused" | "dns" | "not-public" | "connection" | null;
|
|
1492
|
+
/**
|
|
1493
|
+
* How long the last attempt took, in milliseconds.
|
|
1494
|
+
*/
|
|
1495
|
+
durationMs: number;
|
|
1496
|
+
/**
|
|
1497
|
+
* The first 500 characters of the body the URL answered, or null when it answered none.
|
|
1498
|
+
*/
|
|
1499
|
+
response: string | null;
|
|
1500
|
+
}
|
|
1462
1501
|
interface OrganizationWebhookError {
|
|
1463
1502
|
/**
|
|
1464
1503
|
* `status` when the URL answered an error status, `timeout` when it answered nothing in time, `connection` when it could not be reached.
|
|
@@ -6470,6 +6509,26 @@ interface UsersListMyOrgPointsLedger {
|
|
|
6470
6509
|
};
|
|
6471
6510
|
error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR">;
|
|
6472
6511
|
}
|
|
6512
|
+
/**
|
|
6513
|
+
* GET /users/:username/webhookdeliveries
|
|
6514
|
+
*
|
|
6515
|
+
* List the webhook deliveries
|
|
6516
|
+
*/
|
|
6517
|
+
interface UsersListOrganizationWebhookDeliveries {
|
|
6518
|
+
request: {
|
|
6519
|
+
params: {
|
|
6520
|
+
username: string;
|
|
6521
|
+
};
|
|
6522
|
+
query?: {
|
|
6523
|
+
/**
|
|
6524
|
+
* Only the deliveries of this event. Leaving it out answers those of every event.
|
|
6525
|
+
*/
|
|
6526
|
+
event?: "channel.message" | "channel.join" | "channel.part" | "channel.ban" | "channel.unban";
|
|
6527
|
+
};
|
|
6528
|
+
};
|
|
6529
|
+
response: OrganizationWebhookDeliveries;
|
|
6530
|
+
error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"NOT_ORGANIZATION">;
|
|
6531
|
+
}
|
|
6473
6532
|
/**
|
|
6474
6533
|
* GET /users/orgpoints/users
|
|
6475
6534
|
*
|
|
@@ -8384,6 +8443,7 @@ type Endpoints = {
|
|
|
8384
8443
|
listBlocks: UsersListBlocks;
|
|
8385
8444
|
listFollowLists: UsersListFollowLists;
|
|
8386
8445
|
listMyOrgPointsLedger: UsersListMyOrgPointsLedger;
|
|
8446
|
+
listOrganizationWebhookDeliveries: UsersListOrganizationWebhookDeliveries;
|
|
8387
8447
|
listOrgPointsHolders: UsersListOrgPointsHolders;
|
|
8388
8448
|
listReports: UsersListReports;
|
|
8389
8449
|
listSavedSearches: UsersListSavedSearches;
|
package/dist/index.d.ts
CHANGED
|
@@ -1459,6 +1459,45 @@ interface Order {
|
|
|
1459
1459
|
createdAt: string;
|
|
1460
1460
|
updatedAt: string;
|
|
1461
1461
|
}
|
|
1462
|
+
interface OrganizationWebhookDeliveries {
|
|
1463
|
+
deliveries: OrganizationWebhookDelivery[];
|
|
1464
|
+
}
|
|
1465
|
+
interface OrganizationWebhookDelivery {
|
|
1466
|
+
id: string;
|
|
1467
|
+
event: "channel.message" | "channel.join" | "channel.part" | "channel.ban" | "channel.unban";
|
|
1468
|
+
/**
|
|
1469
|
+
* The URL the event was sent to.
|
|
1470
|
+
*/
|
|
1471
|
+
url: string;
|
|
1472
|
+
/**
|
|
1473
|
+
* When the last attempt was sent.
|
|
1474
|
+
*/
|
|
1475
|
+
sentAt: string;
|
|
1476
|
+
/**
|
|
1477
|
+
* How many attempts it took, the last one included.
|
|
1478
|
+
*/
|
|
1479
|
+
attempts: number;
|
|
1480
|
+
/**
|
|
1481
|
+
* Whether the URL answered a 2xx status.
|
|
1482
|
+
*/
|
|
1483
|
+
delivered: boolean;
|
|
1484
|
+
/**
|
|
1485
|
+
* The HTTP status the URL answered on the last attempt, or null when it answered none.
|
|
1486
|
+
*/
|
|
1487
|
+
status: number | null;
|
|
1488
|
+
/**
|
|
1489
|
+
* Why the last attempt got no response: `timeout` when the URL answered nothing in time, `refused` when it refused the connection, `dns` when its host does not resolve, `not-public` when it points to an address that is not public, `connection` when it could not be reached otherwise. Null when it answered a status.
|
|
1490
|
+
*/
|
|
1491
|
+
error: "timeout" | "refused" | "dns" | "not-public" | "connection" | null;
|
|
1492
|
+
/**
|
|
1493
|
+
* How long the last attempt took, in milliseconds.
|
|
1494
|
+
*/
|
|
1495
|
+
durationMs: number;
|
|
1496
|
+
/**
|
|
1497
|
+
* The first 500 characters of the body the URL answered, or null when it answered none.
|
|
1498
|
+
*/
|
|
1499
|
+
response: string | null;
|
|
1500
|
+
}
|
|
1462
1501
|
interface OrganizationWebhookError {
|
|
1463
1502
|
/**
|
|
1464
1503
|
* `status` when the URL answered an error status, `timeout` when it answered nothing in time, `connection` when it could not be reached.
|
|
@@ -6470,6 +6509,26 @@ interface UsersListMyOrgPointsLedger {
|
|
|
6470
6509
|
};
|
|
6471
6510
|
error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR">;
|
|
6472
6511
|
}
|
|
6512
|
+
/**
|
|
6513
|
+
* GET /users/:username/webhookdeliveries
|
|
6514
|
+
*
|
|
6515
|
+
* List the webhook deliveries
|
|
6516
|
+
*/
|
|
6517
|
+
interface UsersListOrganizationWebhookDeliveries {
|
|
6518
|
+
request: {
|
|
6519
|
+
params: {
|
|
6520
|
+
username: string;
|
|
6521
|
+
};
|
|
6522
|
+
query?: {
|
|
6523
|
+
/**
|
|
6524
|
+
* Only the deliveries of this event. Leaving it out answers those of every event.
|
|
6525
|
+
*/
|
|
6526
|
+
event?: "channel.message" | "channel.join" | "channel.part" | "channel.ban" | "channel.unban";
|
|
6527
|
+
};
|
|
6528
|
+
};
|
|
6529
|
+
response: OrganizationWebhookDeliveries;
|
|
6530
|
+
error: ApiErrorOf<"BAD_REQUEST" | "VALIDATION_FAILED" | "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "RATE_LIMITED" | "EMAIL_VERIFICATION_REQUIRED" | "INTERNAL_ERROR"> | ApiErrorOf<"NOT_ORGANIZATION">;
|
|
6531
|
+
}
|
|
6473
6532
|
/**
|
|
6474
6533
|
* GET /users/orgpoints/users
|
|
6475
6534
|
*
|
|
@@ -8384,6 +8443,7 @@ type Endpoints = {
|
|
|
8384
8443
|
listBlocks: UsersListBlocks;
|
|
8385
8444
|
listFollowLists: UsersListFollowLists;
|
|
8386
8445
|
listMyOrgPointsLedger: UsersListMyOrgPointsLedger;
|
|
8446
|
+
listOrganizationWebhookDeliveries: UsersListOrganizationWebhookDeliveries;
|
|
8387
8447
|
listOrgPointsHolders: UsersListOrgPointsHolders;
|
|
8388
8448
|
listReports: UsersListReports;
|
|
8389
8449
|
listSavedSearches: UsersListSavedSearches;
|
package/dist/index.js
CHANGED
|
@@ -300,6 +300,7 @@ var routes = {
|
|
|
300
300
|
listBlocks: { method: "GET", path: "/users/blocks" },
|
|
301
301
|
listFollowLists: { method: "GET", path: "/users/followlists" },
|
|
302
302
|
listMyOrgPointsLedger: { method: "GET", path: "/users/orgpoints/ledger" },
|
|
303
|
+
listOrganizationWebhookDeliveries: { method: "GET", path: "/users/:username/webhookdeliveries" },
|
|
303
304
|
listOrgPointsHolders: { method: "GET", path: "/users/orgpoints/users" },
|
|
304
305
|
listReports: { method: "GET", path: "/users/reports" },
|
|
305
306
|
listSavedSearches: { method: "GET", path: "/users/saved-searches" },
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mazmo/sdk",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.1.0",
|
|
4
4
|
"description": "Typed client for the Mazmo API",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://docs.mazmo.net",
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
"node": ">=18"
|
|
34
34
|
},
|
|
35
35
|
"mazmo": {
|
|
36
|
-
"commit": "
|
|
37
|
-
"apiVersion": "7.7.
|
|
36
|
+
"commit": "2a14e9bf74372e764d5bdab5cb2fea41c5d7a144",
|
|
37
|
+
"apiVersion": "7.7.85"
|
|
38
38
|
}
|
|
39
39
|
}
|