@snagsolutions/sdk 0.1.0-alpha.55 → 0.1.0-alpha.57

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 (161) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/package.json +1 -1
  3. package/resources/assets.d.ts +8 -0
  4. package/resources/assets.d.ts.map +1 -1
  5. package/resources/assets.js +8 -0
  6. package/resources/assets.js.map +1 -1
  7. package/resources/assets.mjs +8 -0
  8. package/resources/assets.mjs.map +1 -1
  9. package/resources/auctions/auctions.d.ts +19 -0
  10. package/resources/auctions/auctions.d.ts.map +1 -1
  11. package/resources/auctions/auctions.js +14 -0
  12. package/resources/auctions/auctions.js.map +1 -1
  13. package/resources/auctions/auctions.mjs +14 -0
  14. package/resources/auctions/auctions.mjs.map +1 -1
  15. package/resources/auctions/website-user-attributes/values.d.ts +28 -0
  16. package/resources/auctions/website-user-attributes/values.d.ts.map +1 -1
  17. package/resources/auctions/website-user-attributes/values.js +28 -0
  18. package/resources/auctions/website-user-attributes/values.js.map +1 -1
  19. package/resources/auctions/website-user-attributes/values.mjs +28 -0
  20. package/resources/auctions/website-user-attributes/values.mjs.map +1 -1
  21. package/resources/auctions/website-user-attributes/website-user-attributes.d.ts +24 -0
  22. package/resources/auctions/website-user-attributes/website-user-attributes.d.ts.map +1 -1
  23. package/resources/auctions/website-user-attributes/website-user-attributes.js +18 -0
  24. package/resources/auctions/website-user-attributes/website-user-attributes.js.map +1 -1
  25. package/resources/auctions/website-user-attributes/website-user-attributes.mjs +18 -0
  26. package/resources/auctions/website-user-attributes/website-user-attributes.mjs.map +1 -1
  27. package/resources/loyalty/accounts.d.ts +18 -0
  28. package/resources/loyalty/accounts.d.ts.map +1 -1
  29. package/resources/loyalty/accounts.js +13 -0
  30. package/resources/loyalty/accounts.js.map +1 -1
  31. package/resources/loyalty/accounts.mjs +13 -0
  32. package/resources/loyalty/accounts.mjs.map +1 -1
  33. package/resources/loyalty/badges.d.ts +44 -0
  34. package/resources/loyalty/badges.d.ts.map +1 -1
  35. package/resources/loyalty/badges.js +18 -0
  36. package/resources/loyalty/badges.js.map +1 -1
  37. package/resources/loyalty/badges.mjs +18 -0
  38. package/resources/loyalty/badges.mjs.map +1 -1
  39. package/resources/loyalty/currencies.d.ts +19 -0
  40. package/resources/loyalty/currencies.d.ts.map +1 -1
  41. package/resources/loyalty/currencies.js +19 -0
  42. package/resources/loyalty/currencies.js.map +1 -1
  43. package/resources/loyalty/currencies.mjs +19 -0
  44. package/resources/loyalty/currencies.mjs.map +1 -1
  45. package/resources/loyalty/multipliers.d.ts +35 -0
  46. package/resources/loyalty/multipliers.d.ts.map +1 -1
  47. package/resources/loyalty/multipliers.js +23 -0
  48. package/resources/loyalty/multipliers.js.map +1 -1
  49. package/resources/loyalty/multipliers.mjs +23 -0
  50. package/resources/loyalty/multipliers.mjs.map +1 -1
  51. package/resources/loyalty/questions-responses.d.ts +15 -0
  52. package/resources/loyalty/questions-responses.d.ts.map +1 -1
  53. package/resources/loyalty/questions-responses.js +9 -0
  54. package/resources/loyalty/questions-responses.js.map +1 -1
  55. package/resources/loyalty/questions-responses.mjs +9 -0
  56. package/resources/loyalty/questions-responses.mjs.map +1 -1
  57. package/resources/loyalty/questions.d.ts +33 -0
  58. package/resources/loyalty/questions.d.ts.map +1 -1
  59. package/resources/loyalty/questions.js +33 -0
  60. package/resources/loyalty/questions.js.map +1 -1
  61. package/resources/loyalty/questions.mjs +33 -0
  62. package/resources/loyalty/questions.mjs.map +1 -1
  63. package/resources/loyalty/rule-edits.d.ts +22 -8
  64. package/resources/loyalty/rule-edits.d.ts.map +1 -1
  65. package/resources/loyalty/rule-edits.js +14 -0
  66. package/resources/loyalty/rule-edits.js.map +1 -1
  67. package/resources/loyalty/rule-edits.mjs +14 -0
  68. package/resources/loyalty/rule-edits.mjs.map +1 -1
  69. package/resources/loyalty/rule-groups.d.ts +35 -3
  70. package/resources/loyalty/rule-groups.d.ts.map +1 -1
  71. package/resources/loyalty/rule-groups.js +18 -0
  72. package/resources/loyalty/rule-groups.js.map +1 -1
  73. package/resources/loyalty/rule-groups.mjs +18 -0
  74. package/resources/loyalty/rule-groups.mjs.map +1 -1
  75. package/resources/loyalty/rules.d.ts +76 -21
  76. package/resources/loyalty/rules.d.ts.map +1 -1
  77. package/resources/loyalty/rules.js +30 -0
  78. package/resources/loyalty/rules.js.map +1 -1
  79. package/resources/loyalty/rules.mjs +30 -0
  80. package/resources/loyalty/rules.mjs.map +1 -1
  81. package/resources/loyalty/transactions/rule-statuses.d.ts +14 -0
  82. package/resources/loyalty/transactions/rule-statuses.d.ts.map +1 -1
  83. package/resources/loyalty/transactions/rule-statuses.js +8 -0
  84. package/resources/loyalty/transactions/rule-statuses.js.map +1 -1
  85. package/resources/loyalty/transactions/rule-statuses.mjs +8 -0
  86. package/resources/loyalty/transactions/rule-statuses.mjs.map +1 -1
  87. package/resources/loyalty/transactions/transactions.d.ts +26 -1
  88. package/resources/loyalty/transactions/transactions.d.ts.map +1 -1
  89. package/resources/loyalty/transactions/transactions.js +18 -0
  90. package/resources/loyalty/transactions/transactions.js.map +1 -1
  91. package/resources/loyalty/transactions/transactions.mjs +18 -0
  92. package/resources/loyalty/transactions/transactions.mjs.map +1 -1
  93. package/resources/minting.d.ts +1 -1
  94. package/resources/minting.d.ts.map +1 -1
  95. package/resources/referral/referral.d.ts +7 -0
  96. package/resources/referral/referral.d.ts.map +1 -1
  97. package/resources/referral/referral.js +7 -0
  98. package/resources/referral/referral.js.map +1 -1
  99. package/resources/referral/referral.mjs +7 -0
  100. package/resources/referral/referral.mjs.map +1 -1
  101. package/resources/referral/users.d.ts +14 -0
  102. package/resources/referral/users.d.ts.map +1 -1
  103. package/resources/referral/users.js +14 -0
  104. package/resources/referral/users.js.map +1 -1
  105. package/resources/referral/users.mjs +14 -0
  106. package/resources/referral/users.mjs.map +1 -1
  107. package/resources/users/metadatas.d.ts +10 -0
  108. package/resources/users/metadatas.d.ts.map +1 -1
  109. package/resources/users/metadatas.js.map +1 -1
  110. package/resources/users/metadatas.mjs.map +1 -1
  111. package/resources/users/users.d.ts +48 -0
  112. package/resources/users/users.d.ts.map +1 -1
  113. package/resources/users/users.js +43 -0
  114. package/resources/users/users.js.map +1 -1
  115. package/resources/users/users.mjs +43 -0
  116. package/resources/users/users.mjs.map +1 -1
  117. package/resources/websites/website-collections.d.ts +22 -1
  118. package/resources/websites/website-collections.d.ts.map +1 -1
  119. package/resources/websites/website-collections.js +21 -0
  120. package/resources/websites/website-collections.js.map +1 -1
  121. package/resources/websites/website-collections.mjs +21 -0
  122. package/resources/websites/website-collections.mjs.map +1 -1
  123. package/resources/websites/website-user-roles.d.ts +23 -0
  124. package/resources/websites/website-user-roles.d.ts.map +1 -1
  125. package/resources/websites/website-user-roles.js +23 -0
  126. package/resources/websites/website-user-roles.js.map +1 -1
  127. package/resources/websites/website-user-roles.mjs +23 -0
  128. package/resources/websites/website-user-roles.mjs.map +1 -1
  129. package/resources/websites/websites.d.ts +12 -0
  130. package/resources/websites/websites.d.ts.map +1 -1
  131. package/resources/websites/websites.js +7 -0
  132. package/resources/websites/websites.js.map +1 -1
  133. package/resources/websites/websites.mjs +7 -0
  134. package/resources/websites/websites.mjs.map +1 -1
  135. package/src/resources/assets.ts +8 -0
  136. package/src/resources/auctions/auctions.ts +19 -0
  137. package/src/resources/auctions/website-user-attributes/values.ts +28 -0
  138. package/src/resources/auctions/website-user-attributes/website-user-attributes.ts +24 -0
  139. package/src/resources/loyalty/accounts.ts +18 -0
  140. package/src/resources/loyalty/badges.ts +44 -0
  141. package/src/resources/loyalty/currencies.ts +19 -0
  142. package/src/resources/loyalty/multipliers.ts +35 -0
  143. package/src/resources/loyalty/questions-responses.ts +15 -0
  144. package/src/resources/loyalty/questions.ts +33 -0
  145. package/src/resources/loyalty/rule-edits.ts +22 -0
  146. package/src/resources/loyalty/rule-groups.ts +35 -0
  147. package/src/resources/loyalty/rules.ts +76 -1
  148. package/src/resources/loyalty/transactions/rule-statuses.ts +14 -0
  149. package/src/resources/loyalty/transactions/transactions.ts +28 -0
  150. package/src/resources/minting.ts +1 -0
  151. package/src/resources/referral/referral.ts +7 -0
  152. package/src/resources/referral/users.ts +14 -0
  153. package/src/resources/users/metadatas.ts +10 -0
  154. package/src/resources/users/users.ts +48 -0
  155. package/src/resources/websites/website-collections.ts +22 -0
  156. package/src/resources/websites/website-user-roles.ts +23 -0
  157. package/src/resources/websites/websites.ts +12 -0
  158. package/src/version.ts +1 -1
  159. package/version.d.ts +1 -1
  160. package/version.js +1 -1
  161. package/version.mjs +1 -1
@@ -6,6 +6,19 @@ const resource_1 = require("../../resource.js");
6
6
  class WebsiteCollections extends resource_1.APIResource {
7
7
  /**
8
8
  * Creates a new collection under a website
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * await client.websites.websiteCollections.create({
13
+ * collectionAddress:
14
+ * '0x2c02efDd09B3BA1AEaDd3dCAa7aC7A37C1CBDA8A',
15
+ * name: 'x',
16
+ * network: 'abstract',
17
+ * organizationId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
18
+ * sortId: 0,
19
+ * websiteId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
20
+ * });
21
+ * ```
9
22
  */
10
23
  create(body, options) {
11
24
  return this._client.post('/api/website_collections', {
@@ -16,6 +29,14 @@ class WebsiteCollections extends resource_1.APIResource {
16
29
  }
17
30
  /**
18
31
  * Retrieves collections for a specific website.
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * const websiteCollections =
36
+ * await client.websites.websiteCollections.list({
37
+ * websiteId: '123e4567-e89b-12d3-a456-426614174000',
38
+ * });
39
+ * ```
19
40
  */
20
41
  list(query, options) {
21
42
  return this._client.get('/api/website_collections', { query, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"website-collections.js","sourceRoot":"","sources":["../../src/resources/websites/website-collections.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,kBAAmB,SAAQ,sBAAW;IACjD;;OAEG;IACH,MAAM,CAAC,IAAmC,EAAE,OAA6B;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAI,CACF,KAAkC,EAClC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF;AArBD,gDAqBC"}
1
+ {"version":3,"file":"website-collections.js","sourceRoot":"","sources":["../../src/resources/websites/website-collections.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,kBAAmB,SAAQ,sBAAW;IACjD;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAmC,EAAE,OAA6B;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAkC,EAClC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF;AA1CD,gDA0CC"}
@@ -3,6 +3,19 @@ import { APIResource } from "../../resource.mjs";
3
3
  export class WebsiteCollections extends APIResource {
4
4
  /**
5
5
  * Creates a new collection under a website
6
+ *
7
+ * @example
8
+ * ```ts
9
+ * await client.websites.websiteCollections.create({
10
+ * collectionAddress:
11
+ * '0x2c02efDd09B3BA1AEaDd3dCAa7aC7A37C1CBDA8A',
12
+ * name: 'x',
13
+ * network: 'abstract',
14
+ * organizationId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
15
+ * sortId: 0,
16
+ * websiteId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
17
+ * });
18
+ * ```
6
19
  */
7
20
  create(body, options) {
8
21
  return this._client.post('/api/website_collections', {
@@ -13,6 +26,14 @@ export class WebsiteCollections extends APIResource {
13
26
  }
14
27
  /**
15
28
  * Retrieves collections for a specific website.
29
+ *
30
+ * @example
31
+ * ```ts
32
+ * const websiteCollections =
33
+ * await client.websites.websiteCollections.list({
34
+ * websiteId: '123e4567-e89b-12d3-a456-426614174000',
35
+ * });
36
+ * ```
16
37
  */
17
38
  list(query, options) {
18
39
  return this._client.get('/api/website_collections', { query, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"website-collections.mjs","sourceRoot":"","sources":["../../src/resources/websites/website-collections.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IACjD;;OAEG;IACH,MAAM,CAAC,IAAmC,EAAE,OAA6B;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAI,CACF,KAAkC,EAClC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF"}
1
+ {"version":3,"file":"website-collections.mjs","sourceRoot":"","sources":["../../src/resources/websites/website-collections.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IACjD;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAmC,EAAE,OAA6B;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAkC,EAClC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF"}
@@ -4,10 +4,33 @@ export declare class WebsiteUserRoles extends APIResource {
4
4
  /**
5
5
  * Retrieves roles of users for a specific website. If userId is provided,
6
6
  * retrieves the role of that specific user for the website.
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * const websiteUserRoles =
11
+ * await client.websites.websiteUserRoles.list({
12
+ * websiteId: '123e4567-e89b-12d3-a456-426614174000',
13
+ * });
14
+ * ```
7
15
  */
8
16
  list(query: WebsiteUserRoleListParams, options?: Core.RequestOptions): Core.APIPromise<WebsiteUserRoleListResponse>;
9
17
  /**
10
18
  * Assign roles to users for a specific website
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * const response =
23
+ * await client.websites.websiteUserRoles.assign({
24
+ * websiteId: '123e4567-e89b-12d3-a456-426614174000',
25
+ * websiteUserRoles: [
26
+ * {
27
+ * roleType: 'WEBSITE_ADMIN',
28
+ * walletAddress:
29
+ * '0x1234567890abcdef1234567890abcdef12345678',
30
+ * },
31
+ * ],
32
+ * });
33
+ * ```
11
34
  */
12
35
  assign(body: WebsiteUserRoleAssignParams, options?: Core.RequestOptions): Core.APIPromise<WebsiteUserRoleAssignResponse>;
13
36
  }
@@ -1 +1 @@
1
- {"version":3,"file":"website-user-roles.d.ts","sourceRoot":"","sources":["../../src/resources/websites/website-user-roles.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;OAGG;IACH,IAAI,CACF,KAAK,EAAE,yBAAyB,EAChC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAI/C;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;CAGlD;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,KAAK,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;CAC/C;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,2BAA2B,CAAC,eAAe,CAAC,CAAC;CACtE;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,eAAe;QAC9B;;WAEG;QACH,QAAQ,EACJ,qBAAqB,GACrB,eAAe,GACf,mBAAmB,GACnB,iBAAiB,GACjB,iBAAiB,CAAC;QAEtB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
1
+ {"version":3,"file":"website-user-roles.d.ts","sourceRoot":"","sources":["../../src/resources/websites/website-user-roles.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,EAAE,yBAAyB,EAChC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAI/C;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;CAGlD;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,KAAK,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;CAC/C;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,2BAA2B,CAAC,eAAe,CAAC,CAAC;CACtE;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,eAAe;QAC9B;;WAEG;QACH,QAAQ,EACJ,qBAAqB,GACrB,eAAe,GACf,mBAAmB,GACnB,iBAAiB,GACjB,iBAAiB,CAAC;QAEtB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
@@ -7,12 +7,35 @@ class WebsiteUserRoles extends resource_1.APIResource {
7
7
  /**
8
8
  * Retrieves roles of users for a specific website. If userId is provided,
9
9
  * retrieves the role of that specific user for the website.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const websiteUserRoles =
14
+ * await client.websites.websiteUserRoles.list({
15
+ * websiteId: '123e4567-e89b-12d3-a456-426614174000',
16
+ * });
17
+ * ```
10
18
  */
11
19
  list(query, options) {
12
20
  return this._client.get('/api/website_user_roles', { query, ...options });
13
21
  }
14
22
  /**
15
23
  * Assign roles to users for a specific website
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * const response =
28
+ * await client.websites.websiteUserRoles.assign({
29
+ * websiteId: '123e4567-e89b-12d3-a456-426614174000',
30
+ * websiteUserRoles: [
31
+ * {
32
+ * roleType: 'WEBSITE_ADMIN',
33
+ * walletAddress:
34
+ * '0x1234567890abcdef1234567890abcdef12345678',
35
+ * },
36
+ * ],
37
+ * });
38
+ * ```
16
39
  */
17
40
  assign(body, options) {
18
41
  return this._client.post('/api/website_user_roles', { body, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"website-user-roles.js","sourceRoot":"","sources":["../../src/resources/websites/website-user-roles.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;OAGG;IACH,IAAI,CACF,KAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;CACF;AArBD,4CAqBC"}
1
+ {"version":3,"file":"website-user-roles.js","sourceRoot":"","sources":["../../src/resources/websites/website-user-roles.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;CACF;AA5CD,4CA4CC"}
@@ -4,12 +4,35 @@ export class WebsiteUserRoles extends APIResource {
4
4
  /**
5
5
  * Retrieves roles of users for a specific website. If userId is provided,
6
6
  * retrieves the role of that specific user for the website.
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * const websiteUserRoles =
11
+ * await client.websites.websiteUserRoles.list({
12
+ * websiteId: '123e4567-e89b-12d3-a456-426614174000',
13
+ * });
14
+ * ```
7
15
  */
8
16
  list(query, options) {
9
17
  return this._client.get('/api/website_user_roles', { query, ...options });
10
18
  }
11
19
  /**
12
20
  * Assign roles to users for a specific website
21
+ *
22
+ * @example
23
+ * ```ts
24
+ * const response =
25
+ * await client.websites.websiteUserRoles.assign({
26
+ * websiteId: '123e4567-e89b-12d3-a456-426614174000',
27
+ * websiteUserRoles: [
28
+ * {
29
+ * roleType: 'WEBSITE_ADMIN',
30
+ * walletAddress:
31
+ * '0x1234567890abcdef1234567890abcdef12345678',
32
+ * },
33
+ * ],
34
+ * });
35
+ * ```
13
36
  */
14
37
  assign(body, options) {
15
38
  return this._client.post('/api/website_user_roles', { body, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"website-user-roles.mjs","sourceRoot":"","sources":["../../src/resources/websites/website-user-roles.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;OAGG;IACH,IAAI,CACF,KAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;CACF"}
1
+ {"version":3,"file":"website-user-roles.mjs","sourceRoot":"","sources":["../../src/resources/websites/website-user-roles.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;CACF"}
@@ -9,11 +9,23 @@ export declare class Websites extends APIResource {
9
9
  websiteUserRoles: WebsiteUserRolesAPI.WebsiteUserRoles;
10
10
  /**
11
11
  * Creates a new website
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const website = await client.websites.create({
16
+ * name: 'My New Website',
17
+ * });
18
+ * ```
12
19
  */
13
20
  create(body: WebsiteCreateParams, options?: Core.RequestOptions): Core.APIPromise<WebsiteCreateResponse>;
14
21
  /**
15
22
  * Returns a list of websites. Includes optional query parameters for filtering and
16
23
  * pagination.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * const websites = await client.websites.list();
28
+ * ```
17
29
  */
18
30
  list(query?: WebsiteListParams, options?: Core.RequestOptions): Core.APIPromise<WebsiteListResponse>;
19
31
  list(options?: Core.RequestOptions): Core.APIPromise<WebsiteListResponse>;
@@ -1 +1 @@
1
- {"version":3,"file":"websites.d.ts","sourceRoot":"","sources":["../../src/resources/websites/websites.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,qBAAqB,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EACL,6BAA6B,EAC7B,2BAA2B,EAC3B,6BAA6B,EAC7B,kBAAkB,EACnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,mBAAmB,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EACL,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,2BAA2B,EAC3B,gBAAgB,EACjB,MAAM,sBAAsB,CAAC;AAE9B,qBAAa,QAAS,SAAQ,WAAW;IACvC,kBAAkB,EAAE,qBAAqB,CAAC,kBAAkB,CAE1D;IACF,gBAAgB,EAAE,mBAAmB,CAAC,gBAAgB,CAEpD;IAEF;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAIxG;;;OAGG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IACpG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAU1E;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC,MAAM,CAAC;IAErC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;IAErD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,qBAAqB,EAAE,MAAM,CAAC;KAC/B;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;KAC3B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAEtC;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;CACtB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,EAAE,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEpC;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,qBAAqB,EAAE,MAAM,CAAC;SAC/B;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,iBAAiB,EAAE,MAAM,CAAC;SAC3B;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAKD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,kBAAkB,IAAI,kBAAkB,EACxC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;IAEF,OAAO,EACL,gBAAgB,IAAI,gBAAgB,EACpC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
1
+ {"version":3,"file":"websites.d.ts","sourceRoot":"","sources":["../../src/resources/websites/websites.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,qBAAqB,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EACL,6BAA6B,EAC7B,2BAA2B,EAC3B,6BAA6B,EAC7B,kBAAkB,EACnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,mBAAmB,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EACL,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,2BAA2B,EAC3B,gBAAgB,EACjB,MAAM,sBAAsB,CAAC;AAE9B,qBAAa,QAAS,SAAQ,WAAW;IACvC,kBAAkB,EAAE,qBAAqB,CAAC,kBAAkB,CAE1D;IACF,gBAAgB,EAAE,mBAAmB,CAAC,gBAAgB,CAEpD;IAEF;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAIxG;;;;;;;;OAQG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IACpG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAU1E;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAC,MAAM,CAAC;IAErC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;IAErD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,qBAAqB,EAAE,MAAM,CAAC;KAC/B;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;KAC3B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAEtC;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;CACtB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,EAAE,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEpC;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,qBAAqB,EAAE,MAAM,CAAC;SAC/B;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,iBAAiB,EAAE,MAAM,CAAC;SAC3B;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAKD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,kBAAkB,IAAI,kBAAkB,EACxC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;IAEF,OAAO,EACL,gBAAgB,IAAI,gBAAgB,EACpC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
@@ -39,6 +39,13 @@ class Websites extends resource_1.APIResource {
39
39
  }
40
40
  /**
41
41
  * Creates a new website
42
+ *
43
+ * @example
44
+ * ```ts
45
+ * const website = await client.websites.create({
46
+ * name: 'My New Website',
47
+ * });
48
+ * ```
42
49
  */
43
50
  create(body, options) {
44
51
  return this._client.post('/api/websites', { body, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"websites.js","sourceRoot":"","sources":["../../src/resources/websites/websites.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,gFAA+D;AAC/D,kEAK+B;AAC/B,6EAA4D;AAC5D,gEAM8B;AAE9B,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,uBAAkB,GAA6C,IAAI,qBAAqB,CAAC,kBAAkB,CACzG,IAAI,CAAC,OAAO,CACb,CAAC;QACF,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IAwBJ,CAAC;IAtBC;;OAEG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAQD,IAAI,CACF,QAAiD,EAAE,EACnD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AA9BD,4BA8BC;AA8ND,QAAQ,CAAC,kBAAkB,GAAG,wCAAkB,CAAC;AACjD,QAAQ,CAAC,gBAAgB,GAAG,qCAAgB,CAAC"}
1
+ {"version":3,"file":"websites.js","sourceRoot":"","sources":["../../src/resources/websites/websites.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,gFAA+D;AAC/D,kEAK+B;AAC/B,6EAA4D;AAC5D,gEAM8B;AAE9B,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,uBAAkB,GAA6C,IAAI,qBAAqB,CAAC,kBAAkB,CACzG,IAAI,CAAC,OAAO,CACb,CAAC;QACF,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IAoCJ,CAAC;IAlCC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAaD,IAAI,CACF,QAAiD,EAAE,EACnD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AA1CD,4BA0CC;AA8ND,QAAQ,CAAC,kBAAkB,GAAG,wCAAkB,CAAC;AACjD,QAAQ,CAAC,gBAAgB,GAAG,qCAAgB,CAAC"}
@@ -13,6 +13,13 @@ export class Websites extends APIResource {
13
13
  }
14
14
  /**
15
15
  * Creates a new website
16
+ *
17
+ * @example
18
+ * ```ts
19
+ * const website = await client.websites.create({
20
+ * name: 'My New Website',
21
+ * });
22
+ * ```
16
23
  */
17
24
  create(body, options) {
18
25
  return this._client.post('/api/websites', { body, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"websites.mjs","sourceRoot":"","sources":["../../src/resources/websites/websites.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,KAAK,qBAAqB;OAC1B,EAIL,kBAAkB,GACnB;OACM,KAAK,mBAAmB;OACxB,EAKL,gBAAgB,GACjB;AAED,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,uBAAkB,GAA6C,IAAI,qBAAqB,CAAC,kBAAkB,CACzG,IAAI,CAAC,OAAO,CACb,CAAC;QACF,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IAwBJ,CAAC;IAtBC;;OAEG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAQD,IAAI,CACF,QAAiD,EAAE,EACnD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AA8ND,QAAQ,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;AACjD,QAAQ,CAAC,gBAAgB,GAAG,gBAAgB,CAAC"}
1
+ {"version":3,"file":"websites.mjs","sourceRoot":"","sources":["../../src/resources/websites/websites.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,KAAK,qBAAqB;OAC1B,EAIL,kBAAkB,GACnB;OACM,KAAK,mBAAmB;OACxB,EAKL,gBAAgB,GACjB;AAED,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,uBAAkB,GAA6C,IAAI,qBAAqB,CAAC,kBAAkB,CACzG,IAAI,CAAC,OAAO,CACb,CAAC;QACF,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;IAoCJ,CAAC;IAlCC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAaD,IAAI,CACF,QAAiD,EAAE,EACnD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AA8ND,QAAQ,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;AACjD,QAAQ,CAAC,gBAAgB,GAAG,gBAAgB,CAAC"}
@@ -8,6 +8,14 @@ export class Assets extends APIResource {
8
8
  * This endpoint enables you to upload a file to the resource. Returns a presigned
9
9
  * URL and the asset's public URL. Call PUT with the file as the body to upload the
10
10
  * asset using the presigned URL.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const response = await client.assets.createAsset({
15
+ * fileName: 'example.png',
16
+ * fileSize: 1024,
17
+ * });
18
+ * ```
11
19
  */
12
20
  createAsset(
13
21
  body: AssetCreateAssetParams,
@@ -20,6 +20,15 @@ export class Auctions extends APIResource {
20
20
 
21
21
  /**
22
22
  * This endpoint allows you to fetch page sections
23
+ *
24
+ * @example
25
+ * ```ts
26
+ * const response = await client.auctions.getPageSections({
27
+ * organizationId: '123e4567-e89b-12d3-a456-426614174334',
28
+ * placement: 'page',
29
+ * websiteId: '123e4567-e89b-12d3-a456-426614174333',
30
+ * });
31
+ * ```
23
32
  */
24
33
  getPageSections(
25
34
  query: AuctionGetPageSectionsParams,
@@ -30,6 +39,11 @@ export class Auctions extends APIResource {
30
39
 
31
40
  /**
32
41
  * Returns a list of auction bids with optional filtering and pagination.
42
+ *
43
+ * @example
44
+ * ```ts
45
+ * await client.auctions.listAuctionBids();
46
+ * ```
33
47
  */
34
48
  listAuctionBids(query?: AuctionListAuctionBidsParams, options?: Core.RequestOptions): Core.APIPromise<void>;
35
49
  listAuctionBids(options?: Core.RequestOptions): Core.APIPromise<void>;
@@ -49,6 +63,11 @@ export class Auctions extends APIResource {
49
63
 
50
64
  /**
51
65
  * Returns a list of auctions with optional filtering and pagination.
66
+ *
67
+ * @example
68
+ * ```ts
69
+ * const response = await client.auctions.listAuctions();
70
+ * ```
52
71
  */
53
72
  listAuctions(options?: Core.RequestOptions): Core.APIPromise<AuctionListAuctionsResponse> {
54
73
  return this._client.get('/api/auctions', options);
@@ -6,6 +6,26 @@ import * as Core from '../../../core';
6
6
  export class Values extends APIResource {
7
7
  /**
8
8
  * Create a new website user attribute value
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const values =
13
+ * await client.auctions.websiteUserAttributes.values.create(
14
+ * {
15
+ * data: [
16
+ * {
17
+ * userId: '123e4567-e89b-12d3-a456-426614174005',
18
+ * value: 'Website User Attribute Value',
19
+ * websiteUserAttributeId:
20
+ * '123e4567-e89b-12d3-a456-426614174004',
21
+ * },
22
+ * ],
23
+ * organizationId:
24
+ * '123e4567-e89b-12d3-a456-426614174002',
25
+ * websiteId: '123e4567-e89b-12d3-a456-426614174001',
26
+ * },
27
+ * );
28
+ * ```
9
29
  */
10
30
  create(body: ValueCreateParams, options?: Core.RequestOptions): Core.APIPromise<ValueCreateResponse> {
11
31
  return this._client.post('/api/website_user_attributes/values', { body, ...options });
@@ -13,6 +33,14 @@ export class Values extends APIResource {
13
33
 
14
34
  /**
15
35
  * Get all website user attribute values
36
+ *
37
+ * @example
38
+ * ```ts
39
+ * const values =
40
+ * await client.auctions.websiteUserAttributes.values.list({
41
+ * userIds: '123e4567-e89b-12d3-a456-426614174004',
42
+ * });
43
+ * ```
16
44
  */
17
45
  list(query: ValueListParams, options?: Core.RequestOptions): Core.APIPromise<ValueListResponse> {
18
46
  return this._client.get('/api/website_user_attributes/values', { query, ...options });
@@ -11,6 +11,14 @@ export class WebsiteUserAttributes extends APIResource {
11
11
 
12
12
  /**
13
13
  * Create a new website user attribute
14
+ *
15
+ * @example
16
+ * ```ts
17
+ * const websiteUserAttribute =
18
+ * await client.auctions.websiteUserAttributes.create({
19
+ * data: [{ label: 'Website User Attribute Label' }],
20
+ * });
21
+ * ```
14
22
  */
15
23
  create(
16
24
  body: WebsiteUserAttributeCreateParams,
@@ -21,6 +29,12 @@ export class WebsiteUserAttributes extends APIResource {
21
29
 
22
30
  /**
23
31
  * Get all website user attributes
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * const websiteUserAttributes =
36
+ * await client.auctions.websiteUserAttributes.list();
37
+ * ```
24
38
  */
25
39
  list(
26
40
  query?: WebsiteUserAttributeListParams,
@@ -39,6 +53,16 @@ export class WebsiteUserAttributes extends APIResource {
39
53
 
40
54
  /**
41
55
  * Delete a website user attribute
56
+ *
57
+ * @example
58
+ * ```ts
59
+ * const websiteUserAttribute =
60
+ * await client.auctions.websiteUserAttributes.delete('id', {
61
+ * body_id: '123e4567-e89b-12d3-a456-426614174003',
62
+ * organizationId: '123e4567-e89b-12d3-a456-426614174002',
63
+ * websiteId: '123e4567-e89b-12d3-a456-426614174001',
64
+ * });
65
+ * ```
42
66
  */
43
67
  delete(
44
68
  pathId: string,
@@ -7,6 +7,11 @@ import * as Core from '../../core';
7
7
  export class Accounts extends APIResource {
8
8
  /**
9
9
  * Get loyalty accounts
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const accounts = await client.loyalty.accounts.list();
14
+ * ```
10
15
  */
11
16
  list(query?: AccountListParams, options?: Core.RequestOptions): Core.APIPromise<AccountListResponse>;
12
17
  list(options?: Core.RequestOptions): Core.APIPromise<AccountListResponse>;
@@ -24,6 +29,19 @@ export class Accounts extends APIResource {
24
29
  * Returns the user's rank determined by their loyalty points for the specified
25
30
  * loyalty currency. This can be a slow operation for large organizations. We
26
31
  * recommend caching when possible.
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * const response = await client.loyalty.accounts.retrieveRank(
36
+ * '123e4567-e89b-12d3-a456-426614174333',
37
+ * {
38
+ * loyaltyCurrencyId:
39
+ * '123e4567-e89b-12d3-a456-426614174333',
40
+ * organizationId: '123e4567-e89b-12d3-a456-426614174333',
41
+ * websiteId: '123e4567-e89b-12d3-a456-426614174333',
42
+ * },
43
+ * );
44
+ * ```
27
45
  */
28
46
  retrieveRank(
29
47
  id: string,
@@ -7,6 +7,17 @@ import * as Core from '../../core';
7
7
  export class Badges extends APIResource {
8
8
  /**
9
9
  * This endpoint allows you to configure a new badge.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const badge = await client.loyalty.badges.create({
14
+ * conditions: [{}],
15
+ * imageUrl: 'https://example.com/image.png',
16
+ * name: 'Example Badge',
17
+ * organizationId: '123e4567-e89b-12d3-a456-426614174222',
18
+ * websiteId: '123e4567-e89b-12d3-a456-426614174111',
19
+ * });
20
+ * ```
10
21
  */
11
22
  create(body: BadgeCreateParams, options?: Core.RequestOptions): Core.APIPromise<BadgeCreateResponse> {
12
23
  return this._client.post('/api/loyalty/badges', { body, ...options });
@@ -14,6 +25,13 @@ export class Badges extends APIResource {
14
25
 
15
26
  /**
16
27
  * This endpoint allows you to update an existing badge.
28
+ *
29
+ * @example
30
+ * ```ts
31
+ * const badge = await client.loyalty.badges.update(
32
+ * '123e4567-e89b-12d3-a456-426614174333',
33
+ * );
34
+ * ```
17
35
  */
18
36
  update(
19
37
  id: string,
@@ -34,6 +52,11 @@ export class Badges extends APIResource {
34
52
 
35
53
  /**
36
54
  * This endpoint allows you to fetch badge(s) data.
55
+ *
56
+ * @example
57
+ * ```ts
58
+ * const badges = await client.loyalty.badges.list();
59
+ * ```
37
60
  */
38
61
  list(query?: BadgeListParams, options?: Core.RequestOptions): Core.APIPromise<BadgeListResponse>;
39
62
  list(options?: Core.RequestOptions): Core.APIPromise<BadgeListResponse>;
@@ -49,6 +72,13 @@ export class Badges extends APIResource {
49
72
 
50
73
  /**
51
74
  * This endpoint allows you to delete a badge.
75
+ *
76
+ * @example
77
+ * ```ts
78
+ * const badge = await client.loyalty.badges.delete(
79
+ * '123e4567-e89b-12d3-a456-426614174333',
80
+ * );
81
+ * ```
52
82
  */
53
83
  delete(id: string, options?: Core.RequestOptions): Core.APIPromise<BadgeDeleteResponse> {
54
84
  return this._client.delete(`/api/loyalty/badges/${id}`, options);
@@ -56,6 +86,13 @@ export class Badges extends APIResource {
56
86
 
57
87
  /**
58
88
  * This endpoint allows you to revoke a badge from an account
89
+ *
90
+ * @example
91
+ * ```ts
92
+ * const response = await client.loyalty.badges.revoke(
93
+ * '123e4567-e89b-12d3-a456-426614174333',
94
+ * );
95
+ * ```
59
96
  */
60
97
  revoke(
61
98
  id: string,
@@ -76,6 +113,13 @@ export class Badges extends APIResource {
76
113
 
77
114
  /**
78
115
  * This endpoint allows you to reward a badge for an account
116
+ *
117
+ * @example
118
+ * ```ts
119
+ * const response = await client.loyalty.badges.reward(
120
+ * '123e4567-e89b-12d3-a456-426614174333',
121
+ * );
122
+ * ```
79
123
  */
80
124
  reward(
81
125
  id: string,
@@ -6,6 +6,17 @@ import * as Core from '../../core';
6
6
  export class Currencies extends APIResource {
7
7
  /**
8
8
  * Create a loyalty currency
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const currency = await client.loyalty.currencies.create({
13
+ * decimals: 2,
14
+ * name: 'Loyalty Points',
15
+ * organizationId: '123e4567-e89b-12d3-a456-426614174001',
16
+ * symbol: 'LP',
17
+ * websiteId: '123e4567-e89b-12d3-a456-426614174002',
18
+ * });
19
+ * ```
9
20
  */
10
21
  create(body: CurrencyCreateParams, options?: Core.RequestOptions): Core.APIPromise<CurrencyCreateResponse> {
11
22
  return this._client.post('/api/loyalty/currencies', { body, ...options });
@@ -13,6 +24,14 @@ export class Currencies extends APIResource {
13
24
 
14
25
  /**
15
26
  * Get loyalty currencies
27
+ *
28
+ * @example
29
+ * ```ts
30
+ * const currencies = await client.loyalty.currencies.list({
31
+ * organizationId: '123e4567-e89b-12d3-a456-426614174001',
32
+ * websiteId: '123e4567-e89b-12d3-a456-426614174002',
33
+ * });
34
+ * ```
16
35
  */
17
36
  list(query: CurrencyListParams, options?: Core.RequestOptions): Core.APIPromise<CurrencyListResponse> {
18
37
  return this._client.get('/api/loyalty/currencies', { query, ...options });
@@ -7,6 +7,14 @@ import * as Core from '../../core';
7
7
  export class Multipliers extends APIResource {
8
8
  /**
9
9
  * Create a new loyalty multiplier for a wallet.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const multiplier = await client.loyalty.multipliers.create({
14
+ * multiplier: 0.01,
15
+ * walletAddress: 'walletAddress',
16
+ * });
17
+ * ```
10
18
  */
11
19
  create(
12
20
  body: MultiplierCreateParams,
@@ -17,6 +25,13 @@ export class Multipliers extends APIResource {
17
25
 
18
26
  /**
19
27
  * Update an existing loyalty multiplier.
28
+ *
29
+ * @example
30
+ * ```ts
31
+ * const multiplier = await client.loyalty.multipliers.update(
32
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
33
+ * );
34
+ * ```
20
35
  */
21
36
  update(
22
37
  multiplierId: string,
@@ -37,6 +52,11 @@ export class Multipliers extends APIResource {
37
52
 
38
53
  /**
39
54
  * Get Loyalty Multipliers
55
+ *
56
+ * @example
57
+ * ```ts
58
+ * const multipliers = await client.loyalty.multipliers.list();
59
+ * ```
40
60
  */
41
61
  list(query?: MultiplierListParams, options?: Core.RequestOptions): Core.APIPromise<MultiplierListResponse>;
42
62
  list(options?: Core.RequestOptions): Core.APIPromise<MultiplierListResponse>;
@@ -52,6 +72,13 @@ export class Multipliers extends APIResource {
52
72
 
53
73
  /**
54
74
  * Delete a loyalty multiplier by its ID.
75
+ *
76
+ * @example
77
+ * ```ts
78
+ * const multiplier = await client.loyalty.multipliers.delete(
79
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
80
+ * );
81
+ * ```
55
82
  */
56
83
  delete(multiplierId: string, options?: Core.RequestOptions): Core.APIPromise<MultiplierDeleteResponse> {
57
84
  return this._client.delete(`/api/loyalty/multipliers/${multiplierId}`, options);
@@ -59,6 +86,14 @@ export class Multipliers extends APIResource {
59
86
 
60
87
  /**
61
88
  * Delete a loyalty multiplier by its external identifier.
89
+ *
90
+ * @example
91
+ * ```ts
92
+ * const response =
93
+ * await client.loyalty.multipliers.deleteByExternalId({
94
+ * externalIdentifier: 'externalIdentifier',
95
+ * });
96
+ * ```
62
97
  */
63
98
  deleteByExternalId(
64
99
  body: MultiplierDeleteByExternalIDParams,