@story-protocol/core-sdk 0.1.0-alpha-rc.4 → 0.1.0-alpha-rc.5

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 (38) hide show
  1. package/dist/declarations/src/enums/Relatables.d.ts +3 -0
  2. package/dist/declarations/src/enums/Relatables.d.ts.map +1 -1
  3. package/dist/declarations/src/index.d.ts +1 -1
  4. package/dist/declarations/src/index.d.ts.map +1 -1
  5. package/dist/declarations/src/resources/hook.d.ts +1 -2
  6. package/dist/declarations/src/resources/hook.d.ts.map +1 -1
  7. package/dist/declarations/src/resources/hookReadOnly.d.ts +1 -2
  8. package/dist/declarations/src/resources/hookReadOnly.d.ts.map +1 -1
  9. package/dist/declarations/src/resources/ipAsset.d.ts +1 -1
  10. package/dist/declarations/src/resources/ipAssetReadOnly.d.ts +2 -2
  11. package/dist/declarations/src/resources/ipOrg.d.ts +1 -2
  12. package/dist/declarations/src/resources/ipOrg.d.ts.map +1 -1
  13. package/dist/declarations/src/resources/ipOrgReadOnly.d.ts +2 -3
  14. package/dist/declarations/src/resources/ipOrgReadOnly.d.ts.map +1 -1
  15. package/dist/declarations/src/resources/module.d.ts +1 -2
  16. package/dist/declarations/src/resources/module.d.ts.map +1 -1
  17. package/dist/declarations/src/resources/moduleReadOnly.d.ts +3 -5
  18. package/dist/declarations/src/resources/moduleReadOnly.d.ts.map +1 -1
  19. package/dist/declarations/src/resources/relationship.d.ts +1 -1
  20. package/dist/declarations/src/resources/relationshipReadOnly.d.ts +5 -5
  21. package/dist/declarations/src/resources/relationshipType.d.ts +1 -1
  22. package/dist/declarations/src/resources/relationshipTypeReadOnly.d.ts +5 -6
  23. package/dist/declarations/src/resources/relationshipTypeReadOnly.d.ts.map +1 -1
  24. package/dist/declarations/src/resources/transaction.d.ts +1 -2
  25. package/dist/declarations/src/resources/transaction.d.ts.map +1 -1
  26. package/dist/declarations/src/resources/transactionReadOnly.d.ts +3 -5
  27. package/dist/declarations/src/resources/transactionReadOnly.d.ts.map +1 -1
  28. package/dist/declarations/src/types/config.d.ts +5 -0
  29. package/dist/declarations/src/types/config.d.ts.map +1 -1
  30. package/dist/declarations/src/types/resources/IPOrg.d.ts +7 -7
  31. package/dist/declarations/src/types/resources/relationship.d.ts +30 -0
  32. package/dist/declarations/src/types/resources/relationship.d.ts.map +1 -1
  33. package/dist/declarations/src/types/resources/relationshipType.d.ts +40 -0
  34. package/dist/declarations/src/types/resources/relationshipType.d.ts.map +1 -1
  35. package/dist/story-protocol-core-sdk.cjs.dev.js +36 -44
  36. package/dist/story-protocol-core-sdk.cjs.prod.js +36 -44
  37. package/dist/story-protocol-core-sdk.esm.js +36 -44
  38. package/package.json +1 -1
@@ -524,8 +524,7 @@ function handleError(error, msg) {
524
524
  }
525
525
 
526
526
  /**
527
- * IPOrgReadOnlyClient allows you to view, search IPOrgs on
528
- * Story Protocol.
527
+ * IPOrgReadOnlyClient allows you to view and search IPOrgs on Story Protocol.
529
528
  */
530
529
  var IPOrgReadOnlyClient = /*#__PURE__*/function () {
531
530
  function IPOrgReadOnlyClient(httpClient, rpcClient) {
@@ -576,7 +575,7 @@ var IPOrgReadOnlyClient = /*#__PURE__*/function () {
576
575
  return get;
577
576
  }()
578
577
  /**
579
- * List all IPOrgs.
578
+ * List IPOrgs.
580
579
  *
581
580
  * @returns the response object that contains a list of IPOrgs
582
581
  */
@@ -2729,8 +2728,7 @@ function typedDataToBytes(typedData) {
2729
2728
  }
2730
2729
 
2731
2730
  /**
2732
- * IPOrgClient allows you to create, update, view, search IPOrgs on
2733
- * Story Protocol.
2731
+ * IPOrgClient allows you to create, view, search IPOrgs on Story Protocol.
2734
2732
  */
2735
2733
  var IPOrgClient = /*#__PURE__*/function (_IPOrgReadOnlyClient) {
2736
2734
  _inherits(IPOrgClient, _IPOrgReadOnlyClient);
@@ -2812,7 +2810,7 @@ var IPOrgClient = /*#__PURE__*/function (_IPOrgReadOnlyClient) {
2812
2810
  }(IPOrgReadOnlyClient);
2813
2811
 
2814
2812
  /**
2815
- * Client for managing relationships.
2813
+ * RelationshipReadOnlyClient allows you to view and search relationships on Story Protocol.
2816
2814
  */
2817
2815
  var RelationshipReadOnlyClient = /*#__PURE__*/function () {
2818
2816
  function RelationshipReadOnlyClient(httpClient, rpcClient) {
@@ -2824,8 +2822,8 @@ var RelationshipReadOnlyClient = /*#__PURE__*/function () {
2824
2822
  /**
2825
2823
  * Get a relationship by its ID.
2826
2824
  *
2827
- * @param relationshipId - The ID of the relationship to retrieve.
2828
- * @returns A Promise that resolves to the RelationshipGetResponse.
2825
+ * @param request - the request object for getting the relationship
2826
+ * @returns the response object that contains the fetched relationship object
2829
2827
  */
2830
2828
  _createClass(RelationshipReadOnlyClient, [{
2831
2829
  key: "get",
@@ -2863,9 +2861,9 @@ var RelationshipReadOnlyClient = /*#__PURE__*/function () {
2863
2861
  return get;
2864
2862
  }()
2865
2863
  /**
2866
- * List all relationships.
2864
+ * List relationships.
2867
2865
  *
2868
- * @returns A Promise that resolves to the RelationshipListResponse.
2866
+ * @returns the response object that contains a list of relationships.
2869
2867
  */
2870
2868
  }, {
2871
2869
  key: "list",
@@ -2906,7 +2904,7 @@ var RelationshipReadOnlyClient = /*#__PURE__*/function () {
2906
2904
  }();
2907
2905
 
2908
2906
  /**
2909
- * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
2907
+ * IPAssetReadOnlyClient allows you to view and search IP Assets on Story Protocol.
2910
2908
  */
2911
2909
  var IPAssetReadOnlyClient = /*#__PURE__*/function () {
2912
2910
  function IPAssetReadOnlyClient(httpClient, rpcClient) {
@@ -2957,7 +2955,7 @@ var IPAssetReadOnlyClient = /*#__PURE__*/function () {
2957
2955
  return get;
2958
2956
  }()
2959
2957
  /**
2960
- * List all IP assets.
2958
+ * List IP assets.
2961
2959
  *
2962
2960
  * @returns the response object that contains results from listing query.
2963
2961
  */
@@ -3995,7 +3993,7 @@ var registrationModuleConfig = {
3995
3993
  };
3996
3994
 
3997
3995
  /**
3998
- * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
3996
+ * IpAssetClient allows you to create, view, and search IP Assets on Story Protocol.
3999
3997
  */
4000
3998
  var IPAssetClient = /*#__PURE__*/function (_IPAssetReadOnlyClien) {
4001
3999
  _inherits(IPAssetClient, _IPAssetReadOnlyClien);
@@ -4185,8 +4183,7 @@ var LicenseReadOnlyClient = /*#__PURE__*/function () {
4185
4183
  }();
4186
4184
 
4187
4185
  /**
4188
- * TransactionClient allows you to view and monitor transactions on
4189
- * Story Protocol.
4186
+ * TransactionClient allows you to view and monitor transactions on Story Protocol.
4190
4187
  */
4191
4188
  var TransactionReadOnlyClient = /*#__PURE__*/function () {
4192
4189
  function TransactionReadOnlyClient(httpClient, rpcClient) {
@@ -4231,10 +4228,9 @@ var TransactionReadOnlyClient = /*#__PURE__*/function () {
4231
4228
  return get;
4232
4229
  }()
4233
4230
  /**
4234
- * Get transaction data based on the specified transaction id.
4231
+ * List Transactions.
4235
4232
  *
4236
- * @param request - the request object for getting the transactions
4237
- * @returns the response object that contains the fetched transaction object
4233
+ * @returns the response object that contains a list of transactions
4238
4234
  */
4239
4235
  }, {
4240
4236
  key: "list",
@@ -4256,7 +4252,7 @@ var TransactionReadOnlyClient = /*#__PURE__*/function () {
4256
4252
  case 8:
4257
4253
  _context2.prev = 8;
4258
4254
  _context2.t0 = _context2["catch"](0);
4259
- handleError(_context2.t0, "Failed to get transactions");
4255
+ handleError(_context2.t0, "Failed to list transactions");
4260
4256
  case 11:
4261
4257
  case "end":
4262
4258
  return _context2.stop();
@@ -4273,8 +4269,7 @@ var TransactionReadOnlyClient = /*#__PURE__*/function () {
4273
4269
  }();
4274
4270
 
4275
4271
  /**
4276
- * TransactionClient allows you to view and monitor transactions on
4277
- * Story Protocol.
4272
+ * TransactionClient allows you to view and monitor transactions on Story Protocol.
4278
4273
  */
4279
4274
  var TransactionClient = /*#__PURE__*/function (_TransactionReadOnlyC) {
4280
4275
  _inherits(TransactionClient, _TransactionReadOnlyC);
@@ -4295,8 +4290,7 @@ var TransactionClient = /*#__PURE__*/function (_TransactionReadOnlyC) {
4295
4290
  var HTTP_TIMEOUT = 5000;
4296
4291
 
4297
4292
  /**
4298
- * ModuleClient allows you to view and monitor modules on
4299
- * Story Protocol.
4293
+ * ModuleReadOnlyClient allows you to view and search modules on Story Protocol.
4300
4294
  */
4301
4295
  var ModuleReadOnlyClient = /*#__PURE__*/function () {
4302
4296
  function ModuleReadOnlyClient(httpClient, rpcClient) {
@@ -4341,10 +4335,9 @@ var ModuleReadOnlyClient = /*#__PURE__*/function () {
4341
4335
  return get;
4342
4336
  }()
4343
4337
  /**
4344
- * Get module data based on the specified module id.
4338
+ * List Modules.
4345
4339
  *
4346
- * @param request - the request object for getting the modules
4347
- * @returns the response object that contains the fetched module object
4340
+ * @returns the response object that contains a list of modules
4348
4341
  */
4349
4342
  }, {
4350
4343
  key: "list",
@@ -4370,7 +4363,7 @@ var ModuleReadOnlyClient = /*#__PURE__*/function () {
4370
4363
  case 8:
4371
4364
  _context2.prev = 8;
4372
4365
  _context2.t0 = _context2["catch"](0);
4373
- handleError(_context2.t0, "Failed to get modules");
4366
+ handleError(_context2.t0, "Failed to list modules");
4374
4367
  case 11:
4375
4368
  case "end":
4376
4369
  return _context2.stop();
@@ -4387,8 +4380,7 @@ var ModuleReadOnlyClient = /*#__PURE__*/function () {
4387
4380
  }();
4388
4381
 
4389
4382
  /**
4390
- * ModuleClient allows you to view and monitor modules on
4391
- * Story Protocol.
4383
+ * ModuleClient allows you to view and search modules on Story Protocol.
4392
4384
  */
4393
4385
  var ModuleClient = /*#__PURE__*/function (_ModuleReadOnlyClient) {
4394
4386
  _inherits(ModuleClient, _ModuleReadOnlyClient);
@@ -4404,8 +4396,7 @@ var ModuleClient = /*#__PURE__*/function (_ModuleReadOnlyClient) {
4404
4396
  }(ModuleReadOnlyClient);
4405
4397
 
4406
4398
  /**
4407
- * HookClient allows you to view and monitor hooks on
4408
- * Story Protocol.
4399
+ * HookReadOnlyClient allows you to get and search hooks on Story Protocol.
4409
4400
  */
4410
4401
  var HookReadOnlyClient = /*#__PURE__*/function () {
4411
4402
  function HookReadOnlyClient(httpClient, rpcClient) {
@@ -4496,8 +4487,7 @@ var HookReadOnlyClient = /*#__PURE__*/function () {
4496
4487
  }();
4497
4488
 
4498
4489
  /**
4499
- * HookClient allows you to view and monitor hooks on
4500
- * Story Protocol.
4490
+ * HookClient allows you to view and search hooks on Story Protocol.
4501
4491
  */
4502
4492
  var HookClient = /*#__PURE__*/function (_HookReadOnlyClient) {
4503
4493
  _inherits(HookClient, _HookReadOnlyClient);
@@ -6536,7 +6526,7 @@ var relationshipModuleConfig = {
6536
6526
  };
6537
6527
 
6538
6528
  /**
6539
- * Client for managing relationships.
6529
+ * RelationshipClient allows you to create, view and search relationships on Story Protocol.
6540
6530
  */
6541
6531
  var RelationshipClient = /*#__PURE__*/function (_RelationshipReadOnly) {
6542
6532
  _inherits(RelationshipClient, _RelationshipReadOnly);
@@ -6624,7 +6614,7 @@ var RelationshipClient = /*#__PURE__*/function (_RelationshipReadOnly) {
6624
6614
  }(RelationshipReadOnlyClient);
6625
6615
 
6626
6616
  /**
6627
- * Client for managing RelationshipTypes.
6617
+ * RelationshipTypeReadOnlyClient allows you to view and search relationship types on Story Protocol.
6628
6618
  */
6629
6619
  var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6630
6620
  function RelationshipTypeReadOnlyClient(httpClient, rpcClient) {
@@ -6636,9 +6626,8 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6636
6626
  /**
6637
6627
  * Get a RelationshipType by ipOrgId or relType.
6638
6628
  *
6639
- * @param ipOrgId - The ID of the IP Org.
6640
- * @param relType - Relationship Type.
6641
- * @returns A Promise that resolves to the GetRelationshipTypeResponse.
6629
+ * @param request - the request object for getting the relationship type
6630
+ * @returns the response object that contains the fetched relationship type object
6642
6631
  */
6643
6632
  _createClass(RelationshipTypeReadOnlyClient, [{
6644
6633
  key: "get",
@@ -6658,7 +6647,7 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6658
6647
  case 8:
6659
6648
  _context.prev = 8;
6660
6649
  _context.t0 = _context["catch"](0);
6661
- handleError(_context.t0, "Failed to get RelationshipType");
6650
+ handleError(_context.t0, "Failed to get relationship type");
6662
6651
  case 11:
6663
6652
  case "end":
6664
6653
  return _context.stop();
@@ -6671,9 +6660,9 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6671
6660
  return get;
6672
6661
  }()
6673
6662
  /**
6674
- * List all RelationshipTypes.
6663
+ * List RelationshipTypes.
6675
6664
  *
6676
- * @returns A Promise that resolves to the ListRelationshipTypesResponse.
6665
+ * @returns the response object that contains a list of relationship types
6677
6666
  */
6678
6667
  }, {
6679
6668
  key: "list",
@@ -6697,7 +6686,7 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6697
6686
  case 7:
6698
6687
  _context2.prev = 7;
6699
6688
  _context2.t0 = _context2["catch"](0);
6700
- handleError(_context2.t0, "Failed to list RelationshipTypes");
6689
+ handleError(_context2.t0, "Failed to list relationship types");
6701
6690
  case 10:
6702
6691
  case "end":
6703
6692
  return _context2.stop();
@@ -6714,7 +6703,7 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6714
6703
  }();
6715
6704
 
6716
6705
  /**
6717
- * Client for managing relationships.
6706
+ * RelationshipTypeClient allows you to create, view and search relationship types on Story Protocol.
6718
6707
  */
6719
6708
  var RelationshipTypeClient = /*#__PURE__*/function (_RelationshipTypeRead) {
6720
6709
  _inherits(RelationshipTypeClient, _RelationshipTypeRead);
@@ -6786,7 +6775,7 @@ var RelationshipTypeClient = /*#__PURE__*/function (_RelationshipTypeRead) {
6786
6775
  case 17:
6787
6776
  _context.prev = 17;
6788
6777
  _context.t0 = _context["catch"](0);
6789
- handleError(_context.t0, "Failed to register relationship");
6778
+ handleError(_context.t0, "Failed to register relationship type");
6790
6779
  case 20:
6791
6780
  case "end":
6792
6781
  return _context.stop();
@@ -7118,6 +7107,9 @@ var ActionType = /*#__PURE__*/function (ActionType) {
7118
7107
  return ActionType;
7119
7108
  }({});
7120
7109
 
7110
+ /**
7111
+ * @public
7112
+ */
7121
7113
  var Relatables = /*#__PURE__*/function (Relatables) {
7122
7114
  Relatables[Relatables["Undefined"] = 0] = "Undefined";
7123
7115
  Relatables[Relatables["IPA"] = 1] = "IPA";
@@ -524,8 +524,7 @@ function handleError(error, msg) {
524
524
  }
525
525
 
526
526
  /**
527
- * IPOrgReadOnlyClient allows you to view, search IPOrgs on
528
- * Story Protocol.
527
+ * IPOrgReadOnlyClient allows you to view and search IPOrgs on Story Protocol.
529
528
  */
530
529
  var IPOrgReadOnlyClient = /*#__PURE__*/function () {
531
530
  function IPOrgReadOnlyClient(httpClient, rpcClient) {
@@ -576,7 +575,7 @@ var IPOrgReadOnlyClient = /*#__PURE__*/function () {
576
575
  return get;
577
576
  }()
578
577
  /**
579
- * List all IPOrgs.
578
+ * List IPOrgs.
580
579
  *
581
580
  * @returns the response object that contains a list of IPOrgs
582
581
  */
@@ -2729,8 +2728,7 @@ function typedDataToBytes(typedData) {
2729
2728
  }
2730
2729
 
2731
2730
  /**
2732
- * IPOrgClient allows you to create, update, view, search IPOrgs on
2733
- * Story Protocol.
2731
+ * IPOrgClient allows you to create, view, search IPOrgs on Story Protocol.
2734
2732
  */
2735
2733
  var IPOrgClient = /*#__PURE__*/function (_IPOrgReadOnlyClient) {
2736
2734
  _inherits(IPOrgClient, _IPOrgReadOnlyClient);
@@ -2812,7 +2810,7 @@ var IPOrgClient = /*#__PURE__*/function (_IPOrgReadOnlyClient) {
2812
2810
  }(IPOrgReadOnlyClient);
2813
2811
 
2814
2812
  /**
2815
- * Client for managing relationships.
2813
+ * RelationshipReadOnlyClient allows you to view and search relationships on Story Protocol.
2816
2814
  */
2817
2815
  var RelationshipReadOnlyClient = /*#__PURE__*/function () {
2818
2816
  function RelationshipReadOnlyClient(httpClient, rpcClient) {
@@ -2824,8 +2822,8 @@ var RelationshipReadOnlyClient = /*#__PURE__*/function () {
2824
2822
  /**
2825
2823
  * Get a relationship by its ID.
2826
2824
  *
2827
- * @param relationshipId - The ID of the relationship to retrieve.
2828
- * @returns A Promise that resolves to the RelationshipGetResponse.
2825
+ * @param request - the request object for getting the relationship
2826
+ * @returns the response object that contains the fetched relationship object
2829
2827
  */
2830
2828
  _createClass(RelationshipReadOnlyClient, [{
2831
2829
  key: "get",
@@ -2863,9 +2861,9 @@ var RelationshipReadOnlyClient = /*#__PURE__*/function () {
2863
2861
  return get;
2864
2862
  }()
2865
2863
  /**
2866
- * List all relationships.
2864
+ * List relationships.
2867
2865
  *
2868
- * @returns A Promise that resolves to the RelationshipListResponse.
2866
+ * @returns the response object that contains a list of relationships.
2869
2867
  */
2870
2868
  }, {
2871
2869
  key: "list",
@@ -2906,7 +2904,7 @@ var RelationshipReadOnlyClient = /*#__PURE__*/function () {
2906
2904
  }();
2907
2905
 
2908
2906
  /**
2909
- * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
2907
+ * IPAssetReadOnlyClient allows you to view and search IP Assets on Story Protocol.
2910
2908
  */
2911
2909
  var IPAssetReadOnlyClient = /*#__PURE__*/function () {
2912
2910
  function IPAssetReadOnlyClient(httpClient, rpcClient) {
@@ -2957,7 +2955,7 @@ var IPAssetReadOnlyClient = /*#__PURE__*/function () {
2957
2955
  return get;
2958
2956
  }()
2959
2957
  /**
2960
- * List all IP assets.
2958
+ * List IP assets.
2961
2959
  *
2962
2960
  * @returns the response object that contains results from listing query.
2963
2961
  */
@@ -3995,7 +3993,7 @@ var registrationModuleConfig = {
3995
3993
  };
3996
3994
 
3997
3995
  /**
3998
- * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
3996
+ * IpAssetClient allows you to create, view, and search IP Assets on Story Protocol.
3999
3997
  */
4000
3998
  var IPAssetClient = /*#__PURE__*/function (_IPAssetReadOnlyClien) {
4001
3999
  _inherits(IPAssetClient, _IPAssetReadOnlyClien);
@@ -4185,8 +4183,7 @@ var LicenseReadOnlyClient = /*#__PURE__*/function () {
4185
4183
  }();
4186
4184
 
4187
4185
  /**
4188
- * TransactionClient allows you to view and monitor transactions on
4189
- * Story Protocol.
4186
+ * TransactionClient allows you to view and monitor transactions on Story Protocol.
4190
4187
  */
4191
4188
  var TransactionReadOnlyClient = /*#__PURE__*/function () {
4192
4189
  function TransactionReadOnlyClient(httpClient, rpcClient) {
@@ -4231,10 +4228,9 @@ var TransactionReadOnlyClient = /*#__PURE__*/function () {
4231
4228
  return get;
4232
4229
  }()
4233
4230
  /**
4234
- * Get transaction data based on the specified transaction id.
4231
+ * List Transactions.
4235
4232
  *
4236
- * @param request - the request object for getting the transactions
4237
- * @returns the response object that contains the fetched transaction object
4233
+ * @returns the response object that contains a list of transactions
4238
4234
  */
4239
4235
  }, {
4240
4236
  key: "list",
@@ -4256,7 +4252,7 @@ var TransactionReadOnlyClient = /*#__PURE__*/function () {
4256
4252
  case 8:
4257
4253
  _context2.prev = 8;
4258
4254
  _context2.t0 = _context2["catch"](0);
4259
- handleError(_context2.t0, "Failed to get transactions");
4255
+ handleError(_context2.t0, "Failed to list transactions");
4260
4256
  case 11:
4261
4257
  case "end":
4262
4258
  return _context2.stop();
@@ -4273,8 +4269,7 @@ var TransactionReadOnlyClient = /*#__PURE__*/function () {
4273
4269
  }();
4274
4270
 
4275
4271
  /**
4276
- * TransactionClient allows you to view and monitor transactions on
4277
- * Story Protocol.
4272
+ * TransactionClient allows you to view and monitor transactions on Story Protocol.
4278
4273
  */
4279
4274
  var TransactionClient = /*#__PURE__*/function (_TransactionReadOnlyC) {
4280
4275
  _inherits(TransactionClient, _TransactionReadOnlyC);
@@ -4295,8 +4290,7 @@ var TransactionClient = /*#__PURE__*/function (_TransactionReadOnlyC) {
4295
4290
  var HTTP_TIMEOUT = 5000;
4296
4291
 
4297
4292
  /**
4298
- * ModuleClient allows you to view and monitor modules on
4299
- * Story Protocol.
4293
+ * ModuleReadOnlyClient allows you to view and search modules on Story Protocol.
4300
4294
  */
4301
4295
  var ModuleReadOnlyClient = /*#__PURE__*/function () {
4302
4296
  function ModuleReadOnlyClient(httpClient, rpcClient) {
@@ -4341,10 +4335,9 @@ var ModuleReadOnlyClient = /*#__PURE__*/function () {
4341
4335
  return get;
4342
4336
  }()
4343
4337
  /**
4344
- * Get module data based on the specified module id.
4338
+ * List Modules.
4345
4339
  *
4346
- * @param request - the request object for getting the modules
4347
- * @returns the response object that contains the fetched module object
4340
+ * @returns the response object that contains a list of modules
4348
4341
  */
4349
4342
  }, {
4350
4343
  key: "list",
@@ -4370,7 +4363,7 @@ var ModuleReadOnlyClient = /*#__PURE__*/function () {
4370
4363
  case 8:
4371
4364
  _context2.prev = 8;
4372
4365
  _context2.t0 = _context2["catch"](0);
4373
- handleError(_context2.t0, "Failed to get modules");
4366
+ handleError(_context2.t0, "Failed to list modules");
4374
4367
  case 11:
4375
4368
  case "end":
4376
4369
  return _context2.stop();
@@ -4387,8 +4380,7 @@ var ModuleReadOnlyClient = /*#__PURE__*/function () {
4387
4380
  }();
4388
4381
 
4389
4382
  /**
4390
- * ModuleClient allows you to view and monitor modules on
4391
- * Story Protocol.
4383
+ * ModuleClient allows you to view and search modules on Story Protocol.
4392
4384
  */
4393
4385
  var ModuleClient = /*#__PURE__*/function (_ModuleReadOnlyClient) {
4394
4386
  _inherits(ModuleClient, _ModuleReadOnlyClient);
@@ -4404,8 +4396,7 @@ var ModuleClient = /*#__PURE__*/function (_ModuleReadOnlyClient) {
4404
4396
  }(ModuleReadOnlyClient);
4405
4397
 
4406
4398
  /**
4407
- * HookClient allows you to view and monitor hooks on
4408
- * Story Protocol.
4399
+ * HookReadOnlyClient allows you to get and search hooks on Story Protocol.
4409
4400
  */
4410
4401
  var HookReadOnlyClient = /*#__PURE__*/function () {
4411
4402
  function HookReadOnlyClient(httpClient, rpcClient) {
@@ -4496,8 +4487,7 @@ var HookReadOnlyClient = /*#__PURE__*/function () {
4496
4487
  }();
4497
4488
 
4498
4489
  /**
4499
- * HookClient allows you to view and monitor hooks on
4500
- * Story Protocol.
4490
+ * HookClient allows you to view and search hooks on Story Protocol.
4501
4491
  */
4502
4492
  var HookClient = /*#__PURE__*/function (_HookReadOnlyClient) {
4503
4493
  _inherits(HookClient, _HookReadOnlyClient);
@@ -6536,7 +6526,7 @@ var relationshipModuleConfig = {
6536
6526
  };
6537
6527
 
6538
6528
  /**
6539
- * Client for managing relationships.
6529
+ * RelationshipClient allows you to create, view and search relationships on Story Protocol.
6540
6530
  */
6541
6531
  var RelationshipClient = /*#__PURE__*/function (_RelationshipReadOnly) {
6542
6532
  _inherits(RelationshipClient, _RelationshipReadOnly);
@@ -6624,7 +6614,7 @@ var RelationshipClient = /*#__PURE__*/function (_RelationshipReadOnly) {
6624
6614
  }(RelationshipReadOnlyClient);
6625
6615
 
6626
6616
  /**
6627
- * Client for managing RelationshipTypes.
6617
+ * RelationshipTypeReadOnlyClient allows you to view and search relationship types on Story Protocol.
6628
6618
  */
6629
6619
  var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6630
6620
  function RelationshipTypeReadOnlyClient(httpClient, rpcClient) {
@@ -6636,9 +6626,8 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6636
6626
  /**
6637
6627
  * Get a RelationshipType by ipOrgId or relType.
6638
6628
  *
6639
- * @param ipOrgId - The ID of the IP Org.
6640
- * @param relType - Relationship Type.
6641
- * @returns A Promise that resolves to the GetRelationshipTypeResponse.
6629
+ * @param request - the request object for getting the relationship type
6630
+ * @returns the response object that contains the fetched relationship type object
6642
6631
  */
6643
6632
  _createClass(RelationshipTypeReadOnlyClient, [{
6644
6633
  key: "get",
@@ -6658,7 +6647,7 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6658
6647
  case 8:
6659
6648
  _context.prev = 8;
6660
6649
  _context.t0 = _context["catch"](0);
6661
- handleError(_context.t0, "Failed to get RelationshipType");
6650
+ handleError(_context.t0, "Failed to get relationship type");
6662
6651
  case 11:
6663
6652
  case "end":
6664
6653
  return _context.stop();
@@ -6671,9 +6660,9 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6671
6660
  return get;
6672
6661
  }()
6673
6662
  /**
6674
- * List all RelationshipTypes.
6663
+ * List RelationshipTypes.
6675
6664
  *
6676
- * @returns A Promise that resolves to the ListRelationshipTypesResponse.
6665
+ * @returns the response object that contains a list of relationship types
6677
6666
  */
6678
6667
  }, {
6679
6668
  key: "list",
@@ -6697,7 +6686,7 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6697
6686
  case 7:
6698
6687
  _context2.prev = 7;
6699
6688
  _context2.t0 = _context2["catch"](0);
6700
- handleError(_context2.t0, "Failed to list RelationshipTypes");
6689
+ handleError(_context2.t0, "Failed to list relationship types");
6701
6690
  case 10:
6702
6691
  case "end":
6703
6692
  return _context2.stop();
@@ -6714,7 +6703,7 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6714
6703
  }();
6715
6704
 
6716
6705
  /**
6717
- * Client for managing relationships.
6706
+ * RelationshipTypeClient allows you to create, view and search relationship types on Story Protocol.
6718
6707
  */
6719
6708
  var RelationshipTypeClient = /*#__PURE__*/function (_RelationshipTypeRead) {
6720
6709
  _inherits(RelationshipTypeClient, _RelationshipTypeRead);
@@ -6786,7 +6775,7 @@ var RelationshipTypeClient = /*#__PURE__*/function (_RelationshipTypeRead) {
6786
6775
  case 17:
6787
6776
  _context.prev = 17;
6788
6777
  _context.t0 = _context["catch"](0);
6789
- handleError(_context.t0, "Failed to register relationship");
6778
+ handleError(_context.t0, "Failed to register relationship type");
6790
6779
  case 20:
6791
6780
  case "end":
6792
6781
  return _context.stop();
@@ -7118,6 +7107,9 @@ var ActionType = /*#__PURE__*/function (ActionType) {
7118
7107
  return ActionType;
7119
7108
  }({});
7120
7109
 
7110
+ /**
7111
+ * @public
7112
+ */
7121
7113
  var Relatables = /*#__PURE__*/function (Relatables) {
7122
7114
  Relatables[Relatables["Undefined"] = 0] = "Undefined";
7123
7115
  Relatables[Relatables["IPA"] = 1] = "IPA";