@botpress/api 0.27.12 → 0.27.13

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/index.js CHANGED
@@ -5931,15 +5931,15 @@ var require_assert = __commonJS({
5931
5931
  }
5932
5932
  });
5933
5933
 
5934
- // ../../node_modules/.pnpm/extsprintf@1.4.1/node_modules/extsprintf/lib/extsprintf.js
5934
+ // ../../node_modules/.pnpm/extsprintf@1.3.0/node_modules/extsprintf/lib/extsprintf.js
5935
5935
  var require_extsprintf = __commonJS({
5936
- "../../node_modules/.pnpm/extsprintf@1.4.1/node_modules/extsprintf/lib/extsprintf.js"(exports) {
5936
+ "../../node_modules/.pnpm/extsprintf@1.3.0/node_modules/extsprintf/lib/extsprintf.js"(exports) {
5937
5937
  var mod_assert = require("assert");
5938
5938
  var mod_util = require("util");
5939
5939
  exports.sprintf = jsSprintf;
5940
5940
  exports.printf = jsPrintf;
5941
5941
  exports.fprintf = jsFprintf;
5942
- function jsSprintf(ofmt) {
5942
+ function jsSprintf(fmt) {
5943
5943
  var regex = [
5944
5944
  "([^%]*)",
5945
5945
  "%",
@@ -5951,25 +5951,14 @@ var require_extsprintf = __commonJS({
5951
5951
  ].join("");
5952
5952
  var re = new RegExp(regex);
5953
5953
  var args = Array.prototype.slice.call(arguments, 1);
5954
- var fmt = ofmt;
5955
5954
  var flags, width, precision, conversion;
5956
5955
  var left, pad, sign, arg, match;
5957
5956
  var ret = "";
5958
5957
  var argn = 1;
5959
- var posn = 0;
5960
- var convposn;
5961
- var curconv;
5962
- mod_assert.equal(
5963
- "string",
5964
- typeof fmt,
5965
- "first argument must be a format string"
5966
- );
5958
+ mod_assert.equal("string", typeof fmt);
5967
5959
  while ((match = re.exec(fmt)) !== null) {
5968
5960
  ret += match[1];
5969
5961
  fmt = fmt.substring(match[0].length);
5970
- curconv = match[0].substring(match[1].length);
5971
- convposn = posn + match[1].length + 1;
5972
- posn += match[0].length;
5973
5962
  flags = match[2] || "";
5974
5963
  width = match[3] || 0;
5975
5964
  precision = match[4] || "";
@@ -5981,32 +5970,18 @@ var require_extsprintf = __commonJS({
5981
5970
  ret += "%";
5982
5971
  continue;
5983
5972
  }
5984
- if (args.length === 0) {
5985
- throw jsError(
5986
- ofmt,
5987
- convposn,
5988
- curconv,
5989
- "has no matching argument (too few arguments passed)"
5990
- );
5991
- }
5973
+ if (args.length === 0)
5974
+ throw new Error("too few args to sprintf");
5992
5975
  arg = args.shift();
5993
5976
  argn++;
5994
- if (flags.match(/[\' #]/)) {
5995
- throw jsError(
5996
- ofmt,
5997
- convposn,
5998
- curconv,
5999
- "uses unsupported flags"
5977
+ if (flags.match(/[\' #]/))
5978
+ throw new Error(
5979
+ "unsupported flags: " + flags
6000
5980
  );
6001
- }
6002
- if (precision.length > 0) {
6003
- throw jsError(
6004
- ofmt,
6005
- convposn,
6006
- curconv,
6007
- "uses non-zero precision (not supported)"
5981
+ if (precision.length > 0)
5982
+ throw new Error(
5983
+ "non-zero precision not supported"
6008
5984
  );
6009
- }
6010
5985
  if (flags.match(/-/))
6011
5986
  left = true;
6012
5987
  if (flags.match(/0/))
@@ -6015,14 +5990,8 @@ var require_extsprintf = __commonJS({
6015
5990
  sign = true;
6016
5991
  switch (conversion) {
6017
5992
  case "s":
6018
- if (arg === void 0 || arg === null) {
6019
- throw jsError(
6020
- ofmt,
6021
- convposn,
6022
- curconv,
6023
- "attempted to print undefined or null as a string (argument " + argn + " to sprintf)"
6024
- );
6025
- }
5993
+ if (arg === void 0 || arg === null)
5994
+ throw new Error("argument " + argn + ": attempted to print undefined or null as a string");
6026
5995
  ret += doPad(pad, width, left, arg.toString());
6027
5996
  break;
6028
5997
  case "d":
@@ -6048,24 +6017,12 @@ var require_extsprintf = __commonJS({
6048
6017
  ret += dumpException(arg);
6049
6018
  break;
6050
6019
  default:
6051
- throw jsError(
6052
- ofmt,
6053
- convposn,
6054
- curconv,
6055
- "is not supported"
6056
- );
6020
+ throw new Error("unsupported conversion: " + conversion);
6057
6021
  }
6058
6022
  }
6059
6023
  ret += fmt;
6060
6024
  return ret;
6061
6025
  }
6062
- function jsError(fmtstr, convposn, curconv, reason) {
6063
- mod_assert.equal(typeof fmtstr, "string");
6064
- mod_assert.equal(typeof curconv, "string");
6065
- mod_assert.equal(typeof convposn, "number");
6066
- mod_assert.equal(typeof reason, "string");
6067
- return new Error('format string "' + fmtstr + '": conversion specifier "' + curconv + '" at character ' + convposn + " " + reason);
6068
- }
6069
6026
  function jsPrintf() {
6070
6027
  var args = Array.prototype.slice.call(arguments);
6071
6028
  args.unshift(process.stdout);
@@ -279204,6 +279161,54 @@ var state = {
279204
279161
  }
279205
279162
  }
279206
279163
  },
279164
+ "getWorkspaceMember": {
279165
+ "name": "getWorkspaceMember",
279166
+ "description": "Get details of the account authenticating with this endpoint.",
279167
+ "section": "workspaceMember",
279168
+ "method": "get",
279169
+ "path": "/v1/admin/workspace-members/me",
279170
+ "response": {
279171
+ "description": "Success",
279172
+ "schema": {
279173
+ "type": "object",
279174
+ "properties": {
279175
+ "id": {
279176
+ "type": "string"
279177
+ },
279178
+ "userId": {
279179
+ "type": "string",
279180
+ "format": "uuid"
279181
+ },
279182
+ "email": {
279183
+ "type": "string"
279184
+ },
279185
+ "createdAt": {
279186
+ "type": "string"
279187
+ },
279188
+ "role": {
279189
+ "type": "string",
279190
+ "enum": [
279191
+ "viewer",
279192
+ "billing",
279193
+ "developer",
279194
+ "manager",
279195
+ "administrator",
279196
+ "owner"
279197
+ ]
279198
+ }
279199
+ },
279200
+ "required": [
279201
+ "id",
279202
+ "email",
279203
+ "createdAt",
279204
+ "role"
279205
+ ],
279206
+ "title": "getWorkspaceMemberResponse",
279207
+ "additionalProperties": false
279208
+ }
279209
+ },
279210
+ "parameters": {}
279211
+ },
279207
279212
  "deleteWorkspaceMember": {
279208
279213
  "name": "deleteWorkspaceMember",
279209
279214
  "description": "Remove a member of a workspace",
@@ -282445,7 +282450,7 @@ var state = {
282445
282450
  "title": "Botpress API",
282446
282451
  "description": "API for Botpress Cloud",
282447
282452
  "server": "https://api.botpress.cloud",
282448
- "version": "0.27.12",
282453
+ "version": "0.27.13",
282449
282454
  "prefix": "v1"
282450
282455
  },
282451
282456
  "errors": [
@@ -282698,6 +282703,7 @@ var state = {
282698
282703
  "deleteWorkspaceResponse": true,
282699
282704
  "getAuditRecordsResponse": true,
282700
282705
  "listWorkspaceMembersResponse": true,
282706
+ "getWorkspaceMemberResponse": true,
282701
282707
  "deleteWorkspaceMemberResponse": true,
282702
282708
  "createWorkspaceMemberResponse": true,
282703
282709
  "updateWorkspaceMemberResponse": true,
@@ -285027,6 +285033,7 @@ var state = {
285027
285033
  "name": "workspaceMember",
285028
285034
  "operations": [
285029
285035
  "listWorkspaceMembers",
285036
+ "getWorkspaceMember",
285030
285037
  "deleteWorkspaceMember",
285031
285038
  "createWorkspaceMember",
285032
285039
  "updateWorkspaceMember"
@@ -5571,6 +5571,42 @@ export declare const state: {
5571
5571
  };
5572
5572
  };
5573
5573
  };
5574
+ getWorkspaceMember: {
5575
+ name: string;
5576
+ description: string;
5577
+ section: "workspaceMember";
5578
+ method: "get";
5579
+ path: string;
5580
+ response: {
5581
+ description: string;
5582
+ schema: {
5583
+ type: "object";
5584
+ properties: {
5585
+ id: {
5586
+ type: "string";
5587
+ };
5588
+ userId: {
5589
+ type: "string";
5590
+ format: string;
5591
+ };
5592
+ email: {
5593
+ type: "string";
5594
+ };
5595
+ createdAt: {
5596
+ type: "string";
5597
+ };
5598
+ role: {
5599
+ type: "string";
5600
+ enum: string[];
5601
+ };
5602
+ };
5603
+ required: string[];
5604
+ title: string;
5605
+ additionalProperties: false;
5606
+ };
5607
+ };
5608
+ parameters: {};
5609
+ };
5574
5610
  deleteWorkspaceMember: {
5575
5611
  name: string;
5576
5612
  description: string;
@@ -8636,6 +8672,7 @@ export declare const state: {
8636
8672
  deleteWorkspaceResponse: true;
8637
8673
  getAuditRecordsResponse: true;
8638
8674
  listWorkspaceMembersResponse: true;
8675
+ getWorkspaceMemberResponse: true;
8639
8676
  deleteWorkspaceMemberResponse: true;
8640
8677
  createWorkspaceMemberResponse: true;
8641
8678
  updateWorkspaceMemberResponse: true;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "0.27.12",
3
+ "version": "0.27.13",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {
@@ -1 +1 @@
1
- {"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation","listParticipants","addParticipant","getParticipant","removeParticipant"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"File","name":"file","operations":[]},{"description":"","title":"State","name":"state","operations":["getState","setState","getOrSetState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Task","name":"task","operations":["getTask","createTask","updateTask","deleteTask","listTasks"],"schema":"Task"},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["listIntegrationApiKeys","createIntegrationApiKey","deleteIntegrationApiKey","createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Workspace","description":"","name":"workspace","operations":["setWorkspacePaymentMethod","listWorkspaceInvoices","getUpcomingInvoice","chargeWorkspaceUnpaidInvoices","createWorkspace","getPublicWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","listWorkspaces","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","updateAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken","setAccountPreference","getAccountPreference"],"schema":"Account"},{"title":"Usage","description":"","name":"usage","operations":["getUsage"],"schema":"Usage"},{"title":"Quotas","description":"","name":"quotas","operations":["changeAISpendQuota"]},{"title":"Helper","description":"","name":"helper","operations":["runVrl"]},{"title":"Activity","description":"","name":"activity","operations":["listActivities"],"schema":"Activity"},{"title":"Tables","description":"Manage and interact with table structures, including creation, updates, and querying of tables and their rows.","name":"tables","operations":["listTables","getTable","getOrCreateTable","createTable","duplicateTable","updateTable","renameTableColumn","deleteTable","getTableRow","findTableRows","createTableRows","deleteTableRows","updateTableRows","upsertTableRows"],"schema":"Table"},{"title":"Files","description":"Operations related to file management.","name":"files","operations":["createFile","deleteFile","listFiles","getFile","updateFile","searchFiles"],"schema":"File"}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is related with a different resource that the one referenced in the request. This is usually caused when providing two resource identifiers that aren't linked together."},{"status":409,"type":"ReferenceConstraint","description":"The resource cannot be deleted because it's referenced by another resource"},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."},{"status":402,"type":"PaymentRequired","description":"A payment is required to perform this request."},{"status":403,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."},{"status":400,"type":"BreakingChanges","description":"Request payload contains breaking changes which is not allowed for this resource without a version increment."}]}
1
+ {"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation","listParticipants","addParticipant","getParticipant","removeParticipant"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"File","name":"file","operations":[]},{"description":"","title":"State","name":"state","operations":["getState","setState","getOrSetState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Task","name":"task","operations":["getTask","createTask","updateTask","deleteTask","listTasks"],"schema":"Task"},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["listIntegrationApiKeys","createIntegrationApiKey","deleteIntegrationApiKey","createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Workspace","description":"","name":"workspace","operations":["setWorkspacePaymentMethod","listWorkspaceInvoices","getUpcomingInvoice","chargeWorkspaceUnpaidInvoices","createWorkspace","getPublicWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","listWorkspaces","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","getWorkspaceMember","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","updateAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken","setAccountPreference","getAccountPreference"],"schema":"Account"},{"title":"Usage","description":"","name":"usage","operations":["getUsage"],"schema":"Usage"},{"title":"Quotas","description":"","name":"quotas","operations":["changeAISpendQuota"]},{"title":"Helper","description":"","name":"helper","operations":["runVrl"]},{"title":"Activity","description":"","name":"activity","operations":["listActivities"],"schema":"Activity"},{"title":"Tables","description":"Manage and interact with table structures, including creation, updates, and querying of tables and their rows.","name":"tables","operations":["listTables","getTable","getOrCreateTable","createTable","duplicateTable","updateTable","renameTableColumn","deleteTable","getTableRow","findTableRows","createTableRows","deleteTableRows","updateTableRows","upsertTableRows"],"schema":"Table"},{"title":"Files","description":"Operations related to file management.","name":"files","operations":["createFile","deleteFile","listFiles","getFile","updateFile","searchFiles"],"schema":"File"}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is related with a different resource that the one referenced in the request. This is usually caused when providing two resource identifiers that aren't linked together."},{"status":409,"type":"ReferenceConstraint","description":"The resource cannot be deleted because it's referenced by another resource"},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."},{"status":402,"type":"PaymentRequired","description":"A payment is required to perform this request."},{"status":403,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."},{"status":400,"type":"BreakingChanges","description":"Request payload contains breaking changes which is not allowed for this resource without a version increment."}]}