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

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 +1668 -4014
  36. package/dist/story-protocol-core-sdk.cjs.prod.js +1668 -4014
  37. package/dist/story-protocol-core-sdk.esm.js +1668 -4014
  38. package/package.json +1 -1
@@ -1,3 +1,6 @@
1
+ /**
2
+ * @public
3
+ */
1
4
  export declare enum Relatables {
2
5
  Undefined = 0,
3
6
  IPA = 1,
@@ -1 +1 @@
1
- {"version":3,"file":"Relatables.d.ts","sourceRoot":"../../../../src/enums","sources":["Relatables.ts"],"names":[],"mappings":"AAAA,oBAAY,UAAU;IACpB,SAAS,IAAI;IACb,GAAG,IAAI;IACP,UAAU,IAAI;IACd,OAAO,IAAI;IACX,OAAO,IAAI;IACX,WAAW,IAAI;CAChB"}
1
+ {"version":3,"file":"Relatables.d.ts","sourceRoot":"../../../../src/enums","sources":["Relatables.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,UAAU;IACpB,SAAS,IAAI;IACb,GAAG,IAAI;IACP,UAAU,IAAI;IACd,OAAO,IAAI;IACX,OAAO,IAAI;IACX,WAAW,IAAI;CAChB"}
@@ -19,7 +19,7 @@ export type { StoryConfig, StoryReadOnlyConfig } from "./types/config.js";
19
19
  export type { Client, ReadOnlyClient } from "./types/client.js";
20
20
  export type { Hex, TypedData } from "./types/common.js";
21
21
  export type { IPOrg, GetIPOrgRequest, GetIPOrgResponse, CreateIPOrgRequest, CreateIPOrgResponse, ListIPOrgRequest, ListIPOrgResponse, } from "./types/resources/IPOrg.js";
22
- export type { IPAsset, GetIpAssetRequest, GetIpAssetResponse, CreateIpAssetRequest, CreateIpAssetResponse, ListIpAssetRequest, ListIpAssetResponse, } from "./types/resources/ipAsset.js";
22
+ export type { IPAsset, IPAssetType, GetIpAssetRequest, GetIpAssetResponse, CreateIpAssetRequest, CreateIpAssetResponse, ListIpAssetRequest, ListIpAssetResponse, } from "./types/resources/ipAsset.js";
23
23
  export type { License, GetLicenseRequest, GetLicenseResponse, CreateLicenseNftRequest, CreateIpaBoundLicenseRequest, CreateLicenseResponse, ListLicenseRequest, ListLicenseResponse, } from "./types/resources/license.js";
24
24
  export type { Relationship, RegisterRelationshipRequest, RegisterRelationshipResponse, ListRelationshipRequest, ListRelationshipResponse, GetRelationshipRequest, GetRelationshipResponse, } from "./types/resources/relationship.js";
25
25
  export type { RelationshipType, GetRelationshipTypeRequest, GetRelationshipTypeResponse, ListRelationshipTypesRequest, ListRelationshipTypesResponse, RegisterRelationshipTypeRequest, RegisterRelationshipTypeResponse, } from "./types/resources/relationshipType.js";
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,oBAAiB;AACvC,OAAO,EAAE,YAAY,EAAE,gCAA6B;AACpD,OAAO,EAAE,QAAQ,EAAE,4BAAyB;AAC5C,OAAO,EAAE,UAAU,EAAE,8BAA2B;AAChD,OAAO,EAAE,UAAU,EAAE,8BAA2B;AAChD,OAAO,EAAE,kBAAkB,EAAE,oCAAiC;AAC9D,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,qBAAqB,EAAE,uCAAoC;AACpE,OAAO,EAAE,WAAW,EAAE,6BAA0B;AAChD,OAAO,EAAE,mBAAmB,EAAE,qCAAkC;AAChE,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,qBAAqB,EAAE,uCAAoC;AACpE,OAAO,EAAE,oBAAoB,EAAE,sCAAmC;AAClE,OAAO,EAAE,kBAAkB,EAAE,oCAAiC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,mCAAgC;AAC5D,OAAO,EAAE,cAAc,EAAE,4BAAyB;AAClD,OAAO,EAAE,WAAW,EAAE,iCAA8B;AAEpD,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,0BAAuB;AACvE,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,0BAAuB;AAC7D,YAAY,EAAE,GAAG,EAAE,SAAS,EAAE,0BAAuB;AAErD,YAAY,EACV,KAAK,EACL,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,GAClB,mCAAgC;AAEjC,YAAY,EACV,OAAO,EACP,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,GACpB,qCAAkC;AAEnC,YAAY,EACV,OAAO,EACP,iBAAiB,EACjB,kBAAkB,EAClB,uBAAuB,EACvB,4BAA4B,EAC5B,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,GACpB,qCAAkC;AAEnC,YAAY,EACV,YAAY,EACZ,2BAA2B,EAC3B,4BAA4B,EAC5B,uBAAuB,EACvB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,GACxB,0CAAuC;AAExC,YAAY,EACV,gBAAgB,EAChB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,gCAAgC,GACjC,8CAA2C;AAE5C,YAAY,EACV,WAAW,EACX,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,GACxB,yCAAsC;AAEvC,YAAY,EACV,MAAM,EACN,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,GACnB,oCAAiC;AAElC,YAAY,EACV,IAAI,EACJ,cAAc,EACd,eAAe,EACf,eAAe,EACf,gBAAgB,GACjB,kCAA+B"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,oBAAiB;AACvC,OAAO,EAAE,YAAY,EAAE,gCAA6B;AACpD,OAAO,EAAE,QAAQ,EAAE,4BAAyB;AAC5C,OAAO,EAAE,UAAU,EAAE,8BAA2B;AAChD,OAAO,EAAE,UAAU,EAAE,8BAA2B;AAChD,OAAO,EAAE,kBAAkB,EAAE,oCAAiC;AAC9D,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,qBAAqB,EAAE,uCAAoC;AACpE,OAAO,EAAE,WAAW,EAAE,6BAA0B;AAChD,OAAO,EAAE,mBAAmB,EAAE,qCAAkC;AAChE,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,qBAAqB,EAAE,uCAAoC;AACpE,OAAO,EAAE,oBAAoB,EAAE,sCAAmC;AAClE,OAAO,EAAE,kBAAkB,EAAE,oCAAiC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,mCAAgC;AAC5D,OAAO,EAAE,cAAc,EAAE,4BAAyB;AAClD,OAAO,EAAE,WAAW,EAAE,iCAA8B;AAEpD,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,0BAAuB;AACvE,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,0BAAuB;AAC7D,YAAY,EAAE,GAAG,EAAE,SAAS,EAAE,0BAAuB;AAErD,YAAY,EACV,KAAK,EACL,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,GAClB,mCAAgC;AAEjC,YAAY,EACV,OAAO,EACP,WAAW,EACX,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,GACpB,qCAAkC;AAEnC,YAAY,EACV,OAAO,EACP,iBAAiB,EACjB,kBAAkB,EAClB,uBAAuB,EACvB,4BAA4B,EAC5B,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,GACpB,qCAAkC;AAEnC,YAAY,EACV,YAAY,EACZ,2BAA2B,EAC3B,4BAA4B,EAC5B,uBAAuB,EACvB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,GACxB,0CAAuC;AAExC,YAAY,EACV,gBAAgB,EAChB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,gCAAgC,GACjC,8CAA2C;AAE5C,YAAY,EACV,WAAW,EACX,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,GACxB,yCAAsC;AAEvC,YAAY,EACV,MAAM,EACN,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,GACnB,oCAAiC;AAElC,YAAY,EACV,IAAI,EACJ,cAAc,EACd,eAAe,EACf,eAAe,EACf,gBAAgB,GACjB,kCAA+B"}
@@ -2,8 +2,7 @@ import { AxiosInstance } from "axios";
2
2
  import { PublicClient, WalletClient } from "viem";
3
3
  import { HookReadOnlyClient } from "./hookReadOnly.js";
4
4
  /**
5
- * HookClient allows you to view and monitor hooks on
6
- * Story Protocol.
5
+ * HookClient allows you to view and search hooks on Story Protocol.
7
6
  */
8
7
  export declare class HookClient extends HookReadOnlyClient {
9
8
  private readonly wallet;
@@ -1 +1 @@
1
- {"version":3,"file":"hook.d.ts","sourceRoot":"../../../../src/resources","sources":["hook.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAElD,OAAO,EAAE,kBAAkB,EAAE,0BAAuB;AAEpD;;;GAGG;AACH,qBAAa,UAAW,SAAQ,kBAAkB;IAChD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;CAIrF"}
1
+ {"version":3,"file":"hook.d.ts","sourceRoot":"../../../../src/resources","sources":["hook.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAElD,OAAO,EAAE,kBAAkB,EAAE,0BAAuB;AAEpD;;GAEG;AACH,qBAAa,UAAW,SAAQ,kBAAkB;IAChD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;CAIrF"}
@@ -2,8 +2,7 @@ import { AxiosInstance } from "axios";
2
2
  import { PublicClient } from "viem";
3
3
  import { GetHookRequest, GetHookResponse, ListHookRequest, ListHookResponse } from "../types/resources/hook.js";
4
4
  /**
5
- * HookClient allows you to view and monitor hooks on
6
- * Story Protocol.
5
+ * HookReadOnlyClient allows you to get and search hooks on Story Protocol.
7
6
  */
8
7
  export declare class HookReadOnlyClient {
9
8
  protected readonly httpClient: AxiosInstance;
@@ -1 +1 @@
1
- {"version":3,"file":"hookReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["hookReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAGpC,OAAO,EACL,cAAc,EACd,eAAe,EACf,eAAe,EACf,gBAAgB,EACjB,mCAAgC;AAEjC;;;GAGG;AACH,qBAAa,kBAAkB;IAC7B,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;gBAE/B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY;IAK9D;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IASnE;;;;;OAKG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAexE"}
1
+ {"version":3,"file":"hookReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["hookReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAGpC,OAAO,EACL,cAAc,EACd,eAAe,EACf,eAAe,EACf,gBAAgB,EACjB,mCAAgC;AAEjC;;GAEG;AACH,qBAAa,kBAAkB;IAC7B,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;gBAE/B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY;IAK9D;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IASnE;;;;;OAKG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAexE"}
@@ -3,7 +3,7 @@ import { PublicClient, WalletClient } from "viem";
3
3
  import { CreateIpAssetRequest, CreateIpAssetResponse } from "../types/resources/ipAsset.js";
4
4
  import { IPAssetReadOnlyClient } from "./ipAssetReadOnly.js";
5
5
  /**
6
- * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
6
+ * IpAssetClient allows you to create, view, and search IP Assets on Story Protocol.
7
7
  */
8
8
  export declare class IPAssetClient extends IPAssetReadOnlyClient {
9
9
  private readonly wallet;
@@ -2,7 +2,7 @@ import { AxiosInstance } from "axios";
2
2
  import { PublicClient } from "viem";
3
3
  import { GetIpAssetRequest, GetIpAssetResponse, ListIpAssetRequest, ListIpAssetResponse } from "../types/resources/ipAsset.js";
4
4
  /**
5
- * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
5
+ * IPAssetReadOnlyClient allows you to view and search IP Assets on Story Protocol.
6
6
  */
7
7
  export declare class IPAssetReadOnlyClient {
8
8
  protected readonly httpClient: AxiosInstance;
@@ -16,7 +16,7 @@ export declare class IPAssetReadOnlyClient {
16
16
  */
17
17
  get(request: GetIpAssetRequest): Promise<GetIpAssetResponse>;
18
18
  /**
19
- * List all IP assets.
19
+ * List IP assets.
20
20
  *
21
21
  * @returns the response object that contains results from listing query.
22
22
  */
@@ -3,8 +3,7 @@ import { PublicClient, WalletClient } from "viem";
3
3
  import { CreateIPOrgRequest, CreateIPOrgResponse } from "../types/resources/IPOrg.js";
4
4
  import { IPOrgReadOnlyClient } from "./ipOrgReadOnly.js";
5
5
  /**
6
- * IPOrgClient allows you to create, update, view, search IPOrgs on
7
- * Story Protocol.
6
+ * IPOrgClient allows you to create, view, search IPOrgs on Story Protocol.
8
7
  */
9
8
  export declare class IPOrgClient extends IPOrgReadOnlyClient {
10
9
  private readonly wallet;
@@ -1 +1 @@
1
- {"version":3,"file":"ipOrg.d.ts","sourceRoot":"../../../../src/resources","sources":["ipOrg.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAc,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,oCAAiC;AAEnF,OAAO,EAAE,mBAAmB,EAAE,2BAAwB;AAKtD;;;GAGG;AACH,qBAAa,WAAY,SAAQ,mBAAmB;IAClD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;IAKpF;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CA4B/E"}
1
+ {"version":3,"file":"ipOrg.d.ts","sourceRoot":"../../../../src/resources","sources":["ipOrg.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAc,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,oCAAiC;AAEnF,OAAO,EAAE,mBAAmB,EAAE,2BAAwB;AAKtD;;GAEG;AACH,qBAAa,WAAY,SAAQ,mBAAmB;IAClD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;IAKpF;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CA4B/E"}
@@ -2,8 +2,7 @@ import { AxiosInstance } from "axios";
2
2
  import { PublicClient } from "viem";
3
3
  import { GetIPOrgRequest, GetIPOrgResponse, ListIPOrgRequest, ListIPOrgResponse } from "../types/resources/IPOrg.js";
4
4
  /**
5
- * IPOrgReadOnlyClient allows you to view, search IPOrgs on
6
- * Story Protocol.
5
+ * IPOrgReadOnlyClient allows you to view and search IPOrgs on Story Protocol.
7
6
  */
8
7
  export declare class IPOrgReadOnlyClient {
9
8
  protected readonly httpClient: AxiosInstance;
@@ -17,7 +16,7 @@ export declare class IPOrgReadOnlyClient {
17
16
  */
18
17
  get(request: GetIPOrgRequest): Promise<GetIPOrgResponse>;
19
18
  /**
20
- * List all IPOrgs.
19
+ * List IPOrgs.
21
20
  *
22
21
  * @returns the response object that contains a list of IPOrgs
23
22
  */
@@ -1 +1 @@
1
- {"version":3,"file":"ipOrgReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["ipOrgReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAa,YAAY,EAAE,MAAM,MAAM,CAAC;AAE/C,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EAClB,oCAAiC;AAGlC;;;GAGG;AACH,qBAAa,mBAAmB;IAC9B,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;gBAE/B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY;IAK9D;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYrE;;;;OAIG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAW1E"}
1
+ {"version":3,"file":"ipOrgReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["ipOrgReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAa,YAAY,EAAE,MAAM,MAAM,CAAC;AAE/C,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EAClB,oCAAiC;AAGlC;;GAEG;AACH,qBAAa,mBAAmB;IAC9B,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;gBAE/B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY;IAK9D;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYrE;;;;OAIG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAW1E"}
@@ -2,8 +2,7 @@ import { AxiosInstance } from "axios";
2
2
  import { PublicClient, WalletClient } from "viem";
3
3
  import { ModuleReadOnlyClient } from "./moduleReadOnly.js";
4
4
  /**
5
- * ModuleClient allows you to view and monitor modules on
6
- * Story Protocol.
5
+ * ModuleClient allows you to view and search modules on Story Protocol.
7
6
  */
8
7
  export declare class ModuleClient extends ModuleReadOnlyClient {
9
8
  private readonly wallet;
@@ -1 +1 @@
1
- {"version":3,"file":"module.d.ts","sourceRoot":"../../../../src/resources","sources":["module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAElD,OAAO,EAAE,oBAAoB,EAAE,4BAAyB;AAExD;;;GAGG;AACH,qBAAa,YAAa,SAAQ,oBAAoB;IACpD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;CAIrF"}
1
+ {"version":3,"file":"module.d.ts","sourceRoot":"../../../../src/resources","sources":["module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAElD,OAAO,EAAE,oBAAoB,EAAE,4BAAyB;AAExD;;GAEG;AACH,qBAAa,YAAa,SAAQ,oBAAoB;IACpD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;CAIrF"}
@@ -2,8 +2,7 @@ import { AxiosInstance } from "axios";
2
2
  import { PublicClient } from "viem";
3
3
  import { GetModuleRequest, GetModuleResponse, ListModuleRequest, ListModuleResponse } from "../types/resources/module.js";
4
4
  /**
5
- * ModuleClient allows you to view and monitor modules on
6
- * Story Protocol.
5
+ * ModuleReadOnlyClient allows you to view and search modules on Story Protocol.
7
6
  */
8
7
  export declare class ModuleReadOnlyClient {
9
8
  protected readonly httpClient: AxiosInstance;
@@ -17,10 +16,9 @@ export declare class ModuleReadOnlyClient {
17
16
  */
18
17
  get(request: GetModuleRequest): Promise<GetModuleResponse>;
19
18
  /**
20
- * Get module data based on the specified module id.
19
+ * List Modules.
21
20
  *
22
- * @param request - the request object for getting the modules
23
- * @returns the response object that contains the fetched module object
21
+ * @returns the response object that contains a list of modules
24
22
  */
25
23
  list(request?: ListModuleRequest): Promise<ListModuleResponse>;
26
24
  }
@@ -1 +1 @@
1
- {"version":3,"file":"moduleReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["moduleReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAGpC,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EACnB,qCAAkC;AAEnC;;;GAGG;AACH,qBAAa,oBAAoB;IAC/B,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;gBAE/B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY;IAK9D;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IASvE;;;;;OAKG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAe5E"}
1
+ {"version":3,"file":"moduleReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["moduleReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAGpC,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EACnB,qCAAkC;AAEnC;;GAEG;AACH,qBAAa,oBAAoB;IAC/B,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;gBAE/B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY;IAK9D;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IASvE;;;;OAIG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAe5E"}
@@ -3,7 +3,7 @@ import { AxiosInstance } from "axios";
3
3
  import { RegisterRelationshipRequest, RegisterRelationshipResponse } from "../types/resources/relationship.js";
4
4
  import { RelationshipReadOnlyClient } from "./relationshipReadOnly.js";
5
5
  /**
6
- * Client for managing relationships.
6
+ * RelationshipClient allows you to create, view and search relationships on Story Protocol.
7
7
  */
8
8
  export declare class RelationshipClient extends RelationshipReadOnlyClient {
9
9
  private readonly wallet;
@@ -2,7 +2,7 @@ import { AxiosInstance } from "axios";
2
2
  import { PublicClient } from "viem";
3
3
  import { GetRelationshipRequest, GetRelationshipResponse, ListRelationshipRequest, ListRelationshipResponse } from "../types/resources/relationship.js";
4
4
  /**
5
- * Client for managing relationships.
5
+ * RelationshipReadOnlyClient allows you to view and search relationships on Story Protocol.
6
6
  */
7
7
  export declare class RelationshipReadOnlyClient {
8
8
  protected readonly httpClient: AxiosInstance;
@@ -11,14 +11,14 @@ export declare class RelationshipReadOnlyClient {
11
11
  /**
12
12
  * Get a relationship by its ID.
13
13
  *
14
- * @param relationshipId - The ID of the relationship to retrieve.
15
- * @returns A Promise that resolves to the RelationshipGetResponse.
14
+ * @param request - the request object for getting the relationship
15
+ * @returns the response object that contains the fetched relationship object
16
16
  */
17
17
  get(request: GetRelationshipRequest): Promise<GetRelationshipResponse>;
18
18
  /**
19
- * List all relationships.
19
+ * List relationships.
20
20
  *
21
- * @returns A Promise that resolves to the RelationshipListResponse.
21
+ * @returns the response object that contains a list of relationships.
22
22
  */
23
23
  list(request: ListRelationshipRequest): Promise<ListRelationshipResponse>;
24
24
  }
@@ -3,7 +3,7 @@ import { AxiosInstance } from "axios";
3
3
  import { RegisterRelationshipTypeRequest, RegisterRelationshipTypeResponse } from "../types/resources/relationshipType.js";
4
4
  import { RelationshipTypeReadOnlyClient } from "./relationshipTypeReadOnly.js";
5
5
  /**
6
- * Client for managing relationships.
6
+ * RelationshipTypeClient allows you to create, view and search relationship types on Story Protocol.
7
7
  */
8
8
  export declare class RelationshipTypeClient extends RelationshipTypeReadOnlyClient {
9
9
  private readonly wallet;
@@ -2,7 +2,7 @@ import { AxiosInstance } from "axios";
2
2
  import { PublicClient } from "viem";
3
3
  import { GetRelationshipTypeRequest, GetRelationshipTypeResponse, ListRelationshipTypesRequest, ListRelationshipTypesResponse } from "../types/resources/relationshipType.js";
4
4
  /**
5
- * Client for managing RelationshipTypes.
5
+ * RelationshipTypeReadOnlyClient allows you to view and search relationship types on Story Protocol.
6
6
  */
7
7
  export declare class RelationshipTypeReadOnlyClient {
8
8
  protected readonly httpClient: AxiosInstance;
@@ -11,15 +11,14 @@ export declare class RelationshipTypeReadOnlyClient {
11
11
  /**
12
12
  * Get a RelationshipType by ipOrgId or relType.
13
13
  *
14
- * @param ipOrgId - The ID of the IP Org.
15
- * @param relType - Relationship Type.
16
- * @returns A Promise that resolves to the GetRelationshipTypeResponse.
14
+ * @param request - the request object for getting the relationship type
15
+ * @returns the response object that contains the fetched relationship type object
17
16
  */
18
17
  get(request: GetRelationshipTypeRequest): Promise<GetRelationshipTypeResponse>;
19
18
  /**
20
- * List all RelationshipTypes.
19
+ * List RelationshipTypes.
21
20
  *
22
- * @returns A Promise that resolves to the ListRelationshipTypesResponse.
21
+ * @returns the response object that contains a list of relationship types
23
22
  */
24
23
  list(request: ListRelationshipTypesRequest): Promise<ListRelationshipTypesResponse>;
25
24
  }
@@ -1 +1 @@
1
- {"version":3,"file":"relationshipTypeReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["relationshipTypeReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EACL,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC9B,+CAA4C;AAG7C;;GAEG;AACH,qBAAa,8BAA8B;IACzC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;gBAE/B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY;IAK9D;;;;;;OAMG;IACU,GAAG,CAAC,OAAO,EAAE,0BAA0B,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAa3F;;;;OAIG;IACU,IAAI,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,6BAA6B,CAAC;CAkBjG"}
1
+ {"version":3,"file":"relationshipTypeReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["relationshipTypeReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EACL,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC9B,+CAA4C;AAI7C;;GAEG;AACH,qBAAa,8BAA8B;IACzC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;gBAE/B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY;IAK9D;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,0BAA0B,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAa3F;;;;OAIG;IACU,IAAI,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,6BAA6B,CAAC;CAkBjG"}
@@ -2,8 +2,7 @@ import { AxiosInstance } from "axios";
2
2
  import { PublicClient, WalletClient } from "viem";
3
3
  import { TransactionReadOnlyClient } from "./transactionReadOnly.js";
4
4
  /**
5
- * TransactionClient allows you to view and monitor transactions on
6
- * Story Protocol.
5
+ * TransactionClient allows you to view and monitor transactions on Story Protocol.
7
6
  */
8
7
  export declare class TransactionClient extends TransactionReadOnlyClient {
9
8
  private readonly wallet;
@@ -1 +1 @@
1
- {"version":3,"file":"transaction.d.ts","sourceRoot":"../../../../src/resources","sources":["transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAElD,OAAO,EAAE,yBAAyB,EAAE,iCAA8B;AAElE;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,yBAAyB;IAC9D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;CAIrF"}
1
+ {"version":3,"file":"transaction.d.ts","sourceRoot":"../../../../src/resources","sources":["transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAElD,OAAO,EAAE,yBAAyB,EAAE,iCAA8B;AAElE;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,yBAAyB;IAC9D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;CAIrF"}
@@ -2,8 +2,7 @@ import { AxiosInstance } from "axios";
2
2
  import { PublicClient } from "viem";
3
3
  import { GetTransactionRequest, GetTransactionResponse, ListTransactionRequest, ListTransactionResponse } from "../types/resources/transaction.js";
4
4
  /**
5
- * TransactionClient allows you to view and monitor transactions on
6
- * Story Protocol.
5
+ * TransactionClient allows you to view and monitor transactions on Story Protocol.
7
6
  */
8
7
  export declare class TransactionReadOnlyClient {
9
8
  protected readonly httpClient: AxiosInstance;
@@ -17,10 +16,9 @@ export declare class TransactionReadOnlyClient {
17
16
  */
18
17
  get(request: GetTransactionRequest): Promise<GetTransactionResponse>;
19
18
  /**
20
- * Get transaction data based on the specified transaction id.
19
+ * List Transactions.
21
20
  *
22
- * @param request - the request object for getting the transactions
23
- * @returns the response object that contains the fetched transaction object
21
+ * @returns the response object that contains a list of transactions
24
22
  */
25
23
  list(request?: ListTransactionRequest): Promise<ListTransactionResponse>;
26
24
  }
@@ -1 +1 @@
1
- {"version":3,"file":"transactionReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["transactionReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAGpC,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACxB,0CAAuC;AAExC;;;GAGG;AACH,qBAAa,yBAAyB;IACpC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;gBAE/B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY;IAK9D;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IASjF;;;;;OAKG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAWtF"}
1
+ {"version":3,"file":"transactionReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["transactionReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAGpC,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACxB,0CAAuC;AAExC;;GAEG;AACH,qBAAa,yBAAyB;IACpC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;gBAE/B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY;IAK9D;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IASjF;;;;OAIG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAWtF"}
@@ -7,6 +7,11 @@ import { Account, Chain, Transport } from "viem";
7
7
  export interface StoryConfig extends StoryReadOnlyConfig {
8
8
  readonly account: Account;
9
9
  }
10
+ /**
11
+ * Configuration for the read-only SDK Client.
12
+ *
13
+ * @public
14
+ */
10
15
  export interface StoryReadOnlyConfig {
11
16
  readonly chain?: Chain;
12
17
  readonly transport?: Transport;
@@ -1 +1 @@
1
- {"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAEjD;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,mBAAmB;IACtD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IACvB,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;CAChC"}
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAEjD;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,mBAAmB;IACtD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IACvB,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;CAChC"}
@@ -1,6 +1,6 @@
1
1
  import { QueryOptions, TxOptions } from "../options.js";
2
2
  /**
3
- * Core data model for franchise.
3
+ * Core data model for IP Org.
4
4
  *
5
5
  * @public
6
6
  */
@@ -16,7 +16,7 @@ export type IPOrg = {
16
16
  txHash: string;
17
17
  };
18
18
  /**
19
- * Request type for franchise.get method.
19
+ * Request type for iporg.get method.
20
20
  *
21
21
  * @public
22
22
  */
@@ -24,7 +24,7 @@ export type GetIPOrgRequest = {
24
24
  ipOrgId: string;
25
25
  };
26
26
  /**
27
- * Response type for franchise.get method.
27
+ * Response type for iporg.get method.
28
28
  *
29
29
  * @public
30
30
  */
@@ -32,7 +32,7 @@ export type GetIPOrgResponse = {
32
32
  ipOrg: IPOrg;
33
33
  };
34
34
  /**
35
- * Request type for franchise.create method.
35
+ * Request type for iporg.create method.
36
36
  *
37
37
  * @public
38
38
  */
@@ -44,7 +44,7 @@ export type CreateIPOrgRequest = {
44
44
  txOptions?: TxOptions;
45
45
  };
46
46
  /**
47
- * Response type for franchise.create method.
47
+ * Response type for iporg.create method.
48
48
  *
49
49
  * @public
50
50
  */
@@ -53,7 +53,7 @@ export type CreateIPOrgResponse = {
53
53
  ipOrgId?: string;
54
54
  };
55
55
  /**
56
- * Request type for franchise.list method.
56
+ * Request type for iporg.list method.
57
57
  *
58
58
  * @public
59
59
  */
@@ -61,7 +61,7 @@ export type ListIPOrgRequest = {
61
61
  options?: QueryOptions;
62
62
  };
63
63
  /**
64
- * Response type for franchise.list method.
64
+ * Response type for iporg.list method.
65
65
  *
66
66
  * @public
67
67
  */
@@ -11,6 +11,11 @@ export type Relationship = {
11
11
  registeredAt: string;
12
12
  txHash: string;
13
13
  };
14
+ /**
15
+ * Request type for relationship.register method.
16
+ *
17
+ * @public
18
+ */
14
19
  export type RegisterRelationshipRequest = {
15
20
  ipOrgId: string;
16
21
  relType: string;
@@ -22,23 +27,48 @@ export type RegisterRelationshipRequest = {
22
27
  postHookData?: Array<TypedData>;
23
28
  txOptions?: TxOptions;
24
29
  };
30
+ /**
31
+ * Response type for relationship.register method.
32
+ *
33
+ * @public
34
+ */
25
35
  export type RegisterRelationshipResponse = {
26
36
  txHash: string;
27
37
  relationshipId?: string;
28
38
  success?: boolean;
29
39
  };
40
+ /**
41
+ * Request type for relationship.get method.
42
+ *
43
+ * @public
44
+ */
30
45
  export type GetRelationshipRequest = {
31
46
  relationshipId: string;
32
47
  options?: QueryOptions;
33
48
  };
49
+ /**
50
+ * Response type for relationship.get method.
51
+ *
52
+ * @public
53
+ */
34
54
  export type GetRelationshipResponse = {
35
55
  relationship: Relationship;
36
56
  };
57
+ /**
58
+ * Request type for relationship.list method.
59
+ *
60
+ * @public
61
+ */
37
62
  export type ListRelationshipRequest = {
38
63
  tokenId: string;
39
64
  contract: string;
40
65
  options?: QueryOptions;
41
66
  };
67
+ /**
68
+ * Response type for relationship.list method.
69
+ *
70
+ * @public
71
+ */
42
72
  export type ListRelationshipResponse = {
43
73
  relationships: Relationship[];
44
74
  };
@@ -1 +1 @@
1
- {"version":3,"file":"relationship.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["relationship.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,sBAAmB;AACrD,OAAO,EAAE,SAAS,EAAE,qBAAkB;AAEtC,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAC/B,YAAY,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAChC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AACF,MAAM,MAAM,wBAAwB,GAAG;IACrC,aAAa,EAAE,YAAY,EAAE,CAAC;CAC/B,CAAC"}
1
+ {"version":3,"file":"relationship.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["relationship.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,sBAAmB;AACrD,OAAO,EAAE,SAAS,EAAE,qBAAkB;AAEtC,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAC/B,YAAY,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAChC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,aAAa,EAAE,YAAY,EAAE,CAAC;CAC/B,CAAC"}
@@ -1,6 +1,11 @@
1
1
  import { QueryOptions, TxOptions } from "../options.js";
2
2
  import { TypedData } from "../common.js";
3
3
  import { Relatables } from "../../enums/Relatables.js";
4
+ /**
5
+ * Core data model for Relationship Type.
6
+ *
7
+ * @public
8
+ */
4
9
  export type RelationshipType = {
5
10
  type: string;
6
11
  ipOrgId: string;
@@ -13,24 +18,54 @@ export type RelationshipType = {
13
18
  registeredAt: string;
14
19
  txHash: string;
15
20
  };
21
+ /**
22
+ * Request type for relationshipType.get method.
23
+ *
24
+ * @public
25
+ */
16
26
  export type GetRelationshipTypeRequest = {
17
27
  ipOrgId: string;
18
28
  relType: string;
19
29
  };
30
+ /**
31
+ * Response type for relationshipType.get method.
32
+ *
33
+ * @public
34
+ */
20
35
  export type GetRelationshipTypeResponse = {
21
36
  relationshipType: RelationshipType;
22
37
  };
38
+ /**
39
+ * Request type for relationshipType.list method.
40
+ *
41
+ * @public
42
+ */
23
43
  export type ListRelationshipTypesRequest = {
24
44
  ipOrgId?: string;
25
45
  options?: QueryOptions;
26
46
  };
47
+ /**
48
+ * Response type for relationshipType.list method.
49
+ *
50
+ * @public
51
+ */
27
52
  export type ListRelationshipTypesResponse = {
28
53
  relationshipTypes: RelationshipType[];
29
54
  };
55
+ /**
56
+ * RelatedElements contains relatables from the source and the destination entity.
57
+ *
58
+ * @public
59
+ */
30
60
  export type RelatedElements = {
31
61
  src: Relatables;
32
62
  dst: Relatables;
33
63
  };
64
+ /**
65
+ * Request type for relationshipType.register method.
66
+ *
67
+ * @public
68
+ */
34
69
  export type RegisterRelationshipTypeRequest = {
35
70
  ipOrgId: string;
36
71
  relType: string;
@@ -41,6 +76,11 @@ export type RegisterRelationshipTypeRequest = {
41
76
  postHooksConfig?: Array<TypedData>;
42
77
  txOptions?: TxOptions;
43
78
  };
79
+ /**
80
+ * Response type for relationshipType.register method.
81
+ *
82
+ * @public
83
+ */
44
84
  export type RegisterRelationshipTypeResponse = {
45
85
  txHash: string;
46
86
  success?: boolean;
@@ -1 +1 @@
1
- {"version":3,"file":"relationshipType.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["relationshipType.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,sBAAmB;AACrD,OAAO,EAAE,SAAS,EAAE,qBAAkB;AACtC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,gBAAgB,EAAE,gBAAgB,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,UAAU,CAAC;IAChB,GAAG,EAAE,UAAU,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,eAAe,CAAC;IACjC,sBAAsB,EAAE,MAAM,EAAE,CAAC;IACjC,sBAAsB,EAAE,MAAM,EAAE,CAAC;IACjC,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAClC,eAAe,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IACnC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC"}
1
+ {"version":3,"file":"relationshipType.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["relationshipType.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,sBAAmB;AACrD,OAAO,EAAE,SAAS,EAAE,qBAAkB;AACtC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,gBAAgB,EAAE,gBAAgB,CAAC;CACpC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;CACvC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,UAAU,CAAC;IAChB,GAAG,EAAE,UAAU,CAAC;CACjB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,eAAe,CAAC;IACjC,sBAAsB,EAAE,MAAM,EAAE,CAAC;IACjC,sBAAsB,EAAE,MAAM,EAAE,CAAC;IACjC,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAClC,eAAe,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IACnC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC"}