swcombine-sdk 3.2.4 → 3.2.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 (62) hide show
  1. package/README.md +26 -27
  2. package/dist/cjs/resources/CharacterResource.js +11 -2
  3. package/dist/cjs/resources/CharacterResource.js.map +1 -1
  4. package/dist/cjs/resources/DatacardResource.js +28 -2
  5. package/dist/cjs/resources/DatacardResource.js.map +1 -1
  6. package/dist/cjs/resources/EventsResource.js +8 -1
  7. package/dist/cjs/resources/EventsResource.js.map +1 -1
  8. package/dist/cjs/resources/FactionResource.js +23 -3
  9. package/dist/cjs/resources/FactionResource.js.map +1 -1
  10. package/dist/cjs/resources/GalaxyResource.js +38 -5
  11. package/dist/cjs/resources/GalaxyResource.js.map +1 -1
  12. package/dist/cjs/resources/InventoryResource.js +16 -2
  13. package/dist/cjs/resources/InventoryResource.js.map +1 -1
  14. package/dist/cjs/resources/LocationResource.js +8 -1
  15. package/dist/cjs/resources/LocationResource.js.map +1 -1
  16. package/dist/cjs/resources/MarketResource.js +8 -1
  17. package/dist/cjs/resources/MarketResource.js.map +1 -1
  18. package/dist/cjs/resources/NewsResource.js +10 -0
  19. package/dist/cjs/resources/NewsResource.js.map +1 -1
  20. package/dist/cjs/resources/TypesResource.js +8 -1
  21. package/dist/cjs/resources/TypesResource.js.map +1 -1
  22. package/dist/esm/resources/CharacterResource.js +11 -2
  23. package/dist/esm/resources/CharacterResource.js.map +1 -1
  24. package/dist/esm/resources/DatacardResource.js +28 -2
  25. package/dist/esm/resources/DatacardResource.js.map +1 -1
  26. package/dist/esm/resources/EventsResource.js +8 -1
  27. package/dist/esm/resources/EventsResource.js.map +1 -1
  28. package/dist/esm/resources/FactionResource.js +23 -3
  29. package/dist/esm/resources/FactionResource.js.map +1 -1
  30. package/dist/esm/resources/GalaxyResource.js +38 -5
  31. package/dist/esm/resources/GalaxyResource.js.map +1 -1
  32. package/dist/esm/resources/InventoryResource.js +16 -2
  33. package/dist/esm/resources/InventoryResource.js.map +1 -1
  34. package/dist/esm/resources/LocationResource.js +8 -1
  35. package/dist/esm/resources/LocationResource.js.map +1 -1
  36. package/dist/esm/resources/MarketResource.js +8 -1
  37. package/dist/esm/resources/MarketResource.js.map +1 -1
  38. package/dist/esm/resources/NewsResource.js +10 -0
  39. package/dist/esm/resources/NewsResource.js.map +1 -1
  40. package/dist/esm/resources/TypesResource.js +8 -1
  41. package/dist/esm/resources/TypesResource.js.map +1 -1
  42. package/dist/types/resources/CharacterResource.d.ts +11 -2
  43. package/dist/types/resources/CharacterResource.d.ts.map +1 -1
  44. package/dist/types/resources/DatacardResource.d.ts +28 -2
  45. package/dist/types/resources/DatacardResource.d.ts.map +1 -1
  46. package/dist/types/resources/EventsResource.d.ts +8 -1
  47. package/dist/types/resources/EventsResource.d.ts.map +1 -1
  48. package/dist/types/resources/FactionResource.d.ts +23 -3
  49. package/dist/types/resources/FactionResource.d.ts.map +1 -1
  50. package/dist/types/resources/GalaxyResource.d.ts +38 -5
  51. package/dist/types/resources/GalaxyResource.d.ts.map +1 -1
  52. package/dist/types/resources/InventoryResource.d.ts +16 -2
  53. package/dist/types/resources/InventoryResource.d.ts.map +1 -1
  54. package/dist/types/resources/LocationResource.d.ts +8 -1
  55. package/dist/types/resources/LocationResource.d.ts.map +1 -1
  56. package/dist/types/resources/MarketResource.d.ts +8 -1
  57. package/dist/types/resources/MarketResource.d.ts.map +1 -1
  58. package/dist/types/resources/NewsResource.d.ts +10 -0
  59. package/dist/types/resources/NewsResource.d.ts.map +1 -1
  60. package/dist/types/resources/TypesResource.d.ts +8 -1
  61. package/dist/types/resources/TypesResource.d.ts.map +1 -1
  62. package/package.json +4 -6
@@ -201,13 +201,17 @@ export declare class CharacterPrivilegesResource extends BaseResource {
201
201
  faction_id?: number;
202
202
  }): Promise<PrivilegesResponse>;
203
203
  /**
204
- * Get a specific privilege
204
+ * Get a specific privilege.
205
+ *
206
+ * Returns the `PrivilegeDetail` object directly — not wrapped in a `Page`.
207
+ *
205
208
  * @requires_auth Yes
206
209
  * @requires_scope CHARACTER_PRIVILEGES
207
210
  * @param options.uid - Character UID
208
211
  * @param options.privilegeGroup - Privilege group name
209
212
  * @param options.privilege - Privilege name
210
213
  * @param options.faction_id - Optional faction ID to view privileges for (defaults to token owner's primary faction)
214
+ * @returns The `PrivilegeDetail` entity.
211
215
  */
212
216
  get(options: {
213
217
  uid: string;
@@ -354,12 +358,17 @@ export declare class CharacterResource extends BaseResource {
354
358
  */
355
359
  me(): Promise<CharacterMe>;
356
360
  /**
357
- * Get character by UID
361
+ * Get character by UID.
362
+ *
363
+ * Returns the `Character` object directly — not wrapped in a `Page`.
364
+ *
358
365
  * @requires_auth Yes
359
366
  * @requires_scope CHARACTER_READ
360
367
  * @param options - Character UID
368
+ * @returns The `Character` entity.
361
369
  * @example
362
370
  * const character = await client.character.get({ uid: '1:12345' });
371
+ * console.log(character.name); // access properties directly, not character.data
363
372
  */
364
373
  get(options: GetCharacterOptions): Promise<Character>;
365
374
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"CharacterResource.d.ts","sourceRoot":"","sources":["../../../src/resources/CharacterResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EACL,SAAS,EACT,WAAW,EACX,OAAO,EACP,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,2BAA2B,EAC3B,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EACpB,yBAAyB,EACzB,6BAA6B,EAC7B,0BAA0B,EAC1B,4BAA4B,EAC5B,8BAA8B,EAC/B,MAAM,mBAAmB,CAAC;AAM3B;;;;GAIG;AACH,qBAAa,yBAA0B,SAAQ,YAAY;IACzD,OAAO,CAAC,6BAA6B;IAqCrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,IAAI,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IA8BxE;;;;;;;;;;;;;;;;;;OAkBG;IACG,GAAG,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvD;;;;OAIG;IACG,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;CAQ9D;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE;QACX,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,KAAK,EAAE,UAAU,EAAE,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;IACzB,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,IAAI,CAAC,EAAE,aAAa,EAAE,CAAC;IACvB,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,EAAE,GAAG,SAAS,CAAC;CAC5C;AAED;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IACvD;;;;;;;;OAQG;IACG,IAAI,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,eAAe,CAAC;CAGzE;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE;QACV,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IACF,SAAS,EAAE,eAAe,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,cAAc,EAAE,cAAc,EAAE,CAAC;IACjC,UAAU,EAAE;QACV,UAAU,EAAE,MAAM,CAAC;QACnB,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;;;GAIG;AACH,qBAAa,2BAA4B,SAAQ,YAAY;IAC3D;;;;;;;;;;;;OAYG;IACG,IAAI,CACR,OAAO,EAAE,6BAA6B,GAAG;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAC/D,OAAO,CAAC,kBAAkB,CAAC;IAQ9B;;;;;;;;OAQG;IACG,GAAG,CAAC,OAAO,EAAE;QACjB,GAAG,EAAE,MAAM,CAAC;QACZ,cAAc,EAAE,MAAM,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,eAAe,CAAC;IAY5B;;;;;;;OAOG;IACG,MAAM,CAAC,OAAO,EAAE;QACpB,GAAG,EAAE,MAAM,CAAC;QACZ,cAAc,EAAE,MAAM,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,OAAO,CAAC;CAmBrB;AAED;;;;GAIG;AACH,qBAAa,wBAAyB,SAAQ,YAAY;IACxD;;;;;;;;OAQG;IACG,GAAG,CAAC,OAAO,EAAE,0BAA0B,GAAG,OAAO,CAAC,MAAM,CAAC;IAI/D;;;;;;;;OAQG;IACG,QAAQ,CAAC,OAAO,EAAE;QACtB,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,OAAO,CAAC;CAYrB;AAED;;;;GAIG;AACH,qBAAa,0BAA2B,SAAQ,YAAY;IAC1D;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,IAAI,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;CA4BjF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE;QACN,KAAK,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;IACF,UAAU,EAAE;QACV,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,UAAU,EAAE,wBAAwB,EAAE,CAAC;CACxC;AAED;;;;GAIG;AACH,qBAAa,4BAA6B,SAAQ,YAAY;IAC5D;;;;;;;OAOG;IACG,IAAI,CAAC,OAAO,EAAE,8BAA8B,GAAG,OAAO,CAAC,4BAA4B,CAAC;IAO1F;;;OAGG;IACG,SAAS,CAAC,OAAO,EAAE,8BAA8B,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAI5E;AAED;;;;GAIG;AACH,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,SAAgB,QAAQ,EAAE,yBAAyB,CAAC;IACpD,SAAgB,MAAM,EAAE,uBAAuB,CAAC;IAChD,SAAgB,UAAU,EAAE,2BAA2B,CAAC;IACxD,SAAgB,OAAO,EAAE,wBAAwB,CAAC;IAClD,SAAgB,SAAS,EAAE,0BAA0B,CAAC;IACtD,SAAgB,WAAW,EAAE,4BAA4B,CAAC;gBAE9C,IAAI,EAAE,UAAU;IAU5B;;;;;;;OAOG;IACG,EAAE,IAAI,OAAO,CAAC,WAAW,CAAC;IAIhC;;;;;;;OAOG;IACG,GAAG,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,SAAS,CAAC;IAI3D;;;;;;;;;;;;;;;OAeG;IACG,WAAW,CACf,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAO3C;;;;;;;;;;OAUG;IACG,aAAa,CAAC,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CASpF"}
1
+ {"version":3,"file":"CharacterResource.d.ts","sourceRoot":"","sources":["../../../src/resources/CharacterResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EACL,SAAS,EACT,WAAW,EACX,OAAO,EACP,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,2BAA2B,EAC3B,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EACpB,yBAAyB,EACzB,6BAA6B,EAC7B,0BAA0B,EAC1B,4BAA4B,EAC5B,8BAA8B,EAC/B,MAAM,mBAAmB,CAAC;AAM3B;;;;GAIG;AACH,qBAAa,yBAA0B,SAAQ,YAAY;IACzD,OAAO,CAAC,6BAA6B;IAqCrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,IAAI,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IA8BxE;;;;;;;;;;;;;;;;;;OAkBG;IACG,GAAG,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvD;;;;OAIG;IACG,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;CAQ9D;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE;QACX,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,KAAK,EAAE,UAAU,EAAE,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;IACzB,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,IAAI,CAAC,EAAE,aAAa,EAAE,CAAC;IACvB,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,EAAE,GAAG,SAAS,CAAC;CAC5C;AAED;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IACvD;;;;;;;;OAQG;IACG,IAAI,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,eAAe,CAAC;CAGzE;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE;QACV,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IACF,SAAS,EAAE,eAAe,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,cAAc,EAAE,cAAc,EAAE,CAAC;IACjC,UAAU,EAAE;QACV,UAAU,EAAE,MAAM,CAAC;QACnB,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;;;GAIG;AACH,qBAAa,2BAA4B,SAAQ,YAAY;IAC3D;;;;;;;;;;;;OAYG;IACG,IAAI,CACR,OAAO,EAAE,6BAA6B,GAAG;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAC/D,OAAO,CAAC,kBAAkB,CAAC;IAQ9B;;;;;;;;;;;;OAYG;IACG,GAAG,CAAC,OAAO,EAAE;QACjB,GAAG,EAAE,MAAM,CAAC;QACZ,cAAc,EAAE,MAAM,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,eAAe,CAAC;IAY5B;;;;;;;OAOG;IACG,MAAM,CAAC,OAAO,EAAE;QACpB,GAAG,EAAE,MAAM,CAAC;QACZ,cAAc,EAAE,MAAM,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,OAAO,CAAC;CAmBrB;AAED;;;;GAIG;AACH,qBAAa,wBAAyB,SAAQ,YAAY;IACxD;;;;;;;;OAQG;IACG,GAAG,CAAC,OAAO,EAAE,0BAA0B,GAAG,OAAO,CAAC,MAAM,CAAC;IAI/D;;;;;;;;OAQG;IACG,QAAQ,CAAC,OAAO,EAAE;QACtB,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,OAAO,CAAC;CAYrB;AAED;;;;GAIG;AACH,qBAAa,0BAA2B,SAAQ,YAAY;IAC1D;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,IAAI,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;CA4BjF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE;QACN,KAAK,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;IACF,UAAU,EAAE;QACV,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,UAAU,EAAE,wBAAwB,EAAE,CAAC;CACxC;AAED;;;;GAIG;AACH,qBAAa,4BAA6B,SAAQ,YAAY;IAC5D;;;;;;;OAOG;IACG,IAAI,CAAC,OAAO,EAAE,8BAA8B,GAAG,OAAO,CAAC,4BAA4B,CAAC;IAO1F;;;OAGG;IACG,SAAS,CAAC,OAAO,EAAE,8BAA8B,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAI5E;AAED;;;;GAIG;AACH,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,SAAgB,QAAQ,EAAE,yBAAyB,CAAC;IACpD,SAAgB,MAAM,EAAE,uBAAuB,CAAC;IAChD,SAAgB,UAAU,EAAE,2BAA2B,CAAC;IACxD,SAAgB,OAAO,EAAE,wBAAwB,CAAC;IAClD,SAAgB,SAAS,EAAE,0BAA0B,CAAC;IACtD,SAAgB,WAAW,EAAE,4BAA4B,CAAC;gBAE9C,IAAI,EAAE,UAAU;IAU5B;;;;;;;OAOG;IACG,EAAE,IAAI,OAAO,CAAC,WAAW,CAAC;IAIhC;;;;;;;;;;;;OAYG;IACG,GAAG,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,SAAS,CAAC;IAI3D;;;;;;;;;;;;;;;OAeG;IACG,WAAW,CACf,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAO3C;;;;;;;;;;OAUG;IACG,aAAa,CAAC,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CASpF"}
@@ -16,14 +16,40 @@ export interface Datacard {
16
16
  */
17
17
  export declare class DatacardResource extends BaseResource {
18
18
  /**
19
- * List datacards owned by faction
19
+ * List datacards owned by faction.
20
+ *
21
+ * Returns a `Page<Datacard>` — access the array of datacards via `.data`.
22
+ *
23
+ * @returns A `Page<Datacard>` with `.data`, `.total`, `.hasMore`, and `.getNextPage()`.
24
+ *
25
+ * @example
26
+ * ```typescript
27
+ * const page = await client.datacard.list({ factionId: '20:123' });
28
+ * console.log(page.data); // Datacard[] — items on this page
29
+ * console.log(page.total); // total datacards across all pages
30
+ *
31
+ * for await (const card of page) {
32
+ * console.log(card.name); // auto-paginates
33
+ * }
34
+ * ```
20
35
  */
21
36
  list(options: {
22
37
  factionId: string;
23
38
  pageDelay?: number;
24
39
  }): Promise<Page<Datacard>>;
25
40
  /**
26
- * Get specific datacard
41
+ * Get a specific datacard by UID.
42
+ *
43
+ * Returns the `Datacard` object directly — not wrapped in a `Page`.
44
+ * Access properties like `.name` and `.uid` on the result itself.
45
+ *
46
+ * @returns The `Datacard` entity.
47
+ *
48
+ * @example
49
+ * ```typescript
50
+ * const card = await client.datacard.get({ uid: 'datacard-uid' });
51
+ * console.log(card.name); // access properties directly, not card.data
52
+ * ```
27
53
  */
28
54
  get(options: {
29
55
  uid: string;
@@ -1 +1 @@
1
- {"version":3,"file":"DatacardResource.d.ts","sourceRoot":"","sources":["../../../src/resources/DatacardResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAE7C,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAChD;;OAEG;IACG,IAAI,CAAC,OAAO,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IA6BvF;;OAEG;IACG,GAAG,CAAC,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;IAItD;;;;;;OAMG;IACG,MAAM,CAAC,OAAO,EAAE;QACpB,GAAG,EAAE,MAAM,CAAC;QACZ,qBAAqB,EAAE,MAAM,CAAC;QAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAcrB;;;;OAIG;IACG,MAAM,CAAC,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,qBAAqB,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAMrF"}
1
+ {"version":3,"file":"DatacardResource.d.ts","sourceRoot":"","sources":["../../../src/resources/DatacardResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAE7C,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAChD;;;;;;;;;;;;;;;;;OAiBG;IACG,IAAI,CAAC,OAAO,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IA6BvF;;;;;;;;;;;;;OAaG;IACG,GAAG,CAAC,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;IAItD;;;;;;OAMG;IACG,MAAM,CAAC,OAAO,EAAE;QACpB,GAAG,EAAE,MAAM,CAAC;QACZ,qBAAqB,EAAE,MAAM,CAAC;QAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAcrB;;;;OAIG;IACG,MAAM,CAAC,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,qBAAqB,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAMrF"}
@@ -46,7 +46,14 @@ export declare class EventsResource extends BaseResource {
46
46
  pageDelay?: number;
47
47
  }): Promise<Page<Event>>;
48
48
  /**
49
- * Get specific event
49
+ * Get a specific event by UID.
50
+ *
51
+ * Returns the `Event` object directly — not wrapped in a `Page`.
52
+ *
53
+ * @returns The `Event` entity.
54
+ * @example
55
+ * const event = await client.events.get({ uid: '5:99001' });
56
+ * console.log(event.type); // access properties directly, not event.data
50
57
  */
51
58
  get(options: {
52
59
  uid: string;
@@ -1 +1 @@
1
- {"version":3,"file":"EventsResource.d.ts","sourceRoot":"","sources":["../../../src/resources/EventsResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAe,MAAM,mBAAmB,CAAC;AAEvD;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C;;;;;;;;;;;;;;;;;;;OAmBG;IACG,IAAI,CAAC,OAAO,EAAE;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,oEAAoE;QACpE,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,8CAA8C;QAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,0DAA0D;QAC1D,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,sDAAsD;QACtD,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,kCAAkC;QAClC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,iHAAiH;QACjH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IA4CxB;;OAEG;IACG,GAAG,CAAC,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,CAAC;CAGpD"}
1
+ {"version":3,"file":"EventsResource.d.ts","sourceRoot":"","sources":["../../../src/resources/EventsResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAe,MAAM,mBAAmB,CAAC;AAEvD;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C;;;;;;;;;;;;;;;;;;;OAmBG;IACG,IAAI,CAAC,OAAO,EAAE;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,oEAAoE;QACpE,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,8CAA8C;QAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,0DAA0D;QAC1D,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,sDAAsD;QACtD,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,kCAAkC;QAClC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,iHAAiH;QACjH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IA4CxB;;;;;;;;;OASG;IACG,GAAG,CAAC,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,CAAC;CAGpD"}
@@ -84,7 +84,14 @@ export declare class FactionBudgetsResource extends BaseResource {
84
84
  pageDelay?: number;
85
85
  }): Promise<Page<Budget>>;
86
86
  /**
87
- * Get specific budget
87
+ * Get a specific faction budget.
88
+ *
89
+ * Returns the `Budget` object directly — not wrapped in a `Page`.
90
+ *
91
+ * @returns The `Budget` entity.
92
+ * @example
93
+ * const budget = await client.faction.budgets.get({ factionId: '20:123', budgetId: 'budget-uid' });
94
+ * console.log(budget); // access properties directly, not budget.data
88
95
  */
89
96
  get(options: {
90
97
  factionId: string;
@@ -120,7 +127,14 @@ export declare class FactionStockholdersResource extends BaseResource {
120
127
  */
121
128
  export declare class FactionCreditsResource extends BaseResource {
122
129
  /**
123
- * Get faction credits
130
+ * Get faction credit balance.
131
+ *
132
+ * Returns the `FactionCredits` object directly — not wrapped in a `Page`.
133
+ *
134
+ * @returns The `FactionCredits` data.
135
+ * @example
136
+ * const credits = await client.faction.credits.get({ factionId: '20:123' });
137
+ * console.log(credits); // access properties directly, not credits.data
124
138
  */
125
139
  get(options: GetFactionCreditsOptions): Promise<FactionCredits>;
126
140
  /**
@@ -179,13 +193,19 @@ export declare class FactionResource extends BaseResource {
179
193
  readonly creditlog: FactionCreditlogResource;
180
194
  constructor(http: HttpClient);
181
195
  /**
182
- * Get faction by UID
196
+ * Get faction by UID.
197
+ *
198
+ * Returns the `FactionDetail` object directly — not wrapped in a `Page`.
199
+ *
183
200
  * @requires_auth Yes
184
201
  * @requires_scope FACTION_READ
185
202
  * @param options - Optional faction UID. If omitted or uid not provided, returns the authenticated user's primary faction.
203
+ * @returns The `FactionDetail` entity.
186
204
  * @example
187
205
  * // Get a specific faction
188
206
  * const faction = await client.faction.get({ uid: '20:123' });
207
+ * console.log(faction.name); // access properties directly, not faction.data
208
+ *
189
209
  * // Get the authenticated user's faction
190
210
  * const myFaction = await client.faction.get();
191
211
  */
@@ -1 +1 @@
1
- {"version":3,"file":"FactionResource.d.ts","sourceRoot":"","sources":["../../../src/resources/FactionResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EACL,aAAa,EACb,SAAS,EACT,iBAAiB,EACjB,wBAAwB,EACxB,6BAA6B,EAC7B,cAAc,EACd,eAAe,EACf,mBAAmB,EACpB,MAAM,mBAAmB,CAAC;AAE3B,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,SAAS,GAAG,MAAM,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,MAAM;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,SAAS,GAAG,MAAM,CAAC;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,YAAY;IACtD;;;;;;;;OAQG;IACG,IAAI,CAAC,OAAO,EAAE;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAyBhC;;;;;;OAMG;IACG,gBAAgB,CAAC,OAAO,EAAE;QAC9B,SAAS,EAAE,MAAM,CAAC;QAClB,GAAG,EAAE,MAAM,CAAC;QACZ,QAAQ,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;QACtC,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAOrC;AAED;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,YAAY;IACtD;;;;;;;;OAQG;IACG,IAAI,CAAC,OAAO,EAAE;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAyBzB;;OAEG;IACG,GAAG,CAAC,OAAO,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;CAG7E;AAED;;;;GAIG;AACH,qBAAa,2BAA4B,SAAQ,YAAY;IAC3D;;;;;;;;OAQG;IACG,IAAI,CAAC,OAAO,EAAE;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;CAwB/B;AAED;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,YAAY;IACtD;;OAEG;IACG,GAAG,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,cAAc,CAAC;IAIrE;;;;;;;OAOG;IACG,QAAQ,CAAC,OAAO,EAAE,6BAA6B,GAAG,OAAO,CAAC,OAAO,CAAC;CAezE;AAED;;;;GAIG;AACH,qBAAa,wBAAyB,SAAQ,YAAY;IACxD;;;;;;;;;;;;;;OAcG;IACG,IAAI,CAAC,OAAO,EAAE;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,8CAA8C;QAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,0DAA0D;QAC1D,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,iFAAiF;QACjF,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,iHAAiH;QACjH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;CA6BlC;AAED;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,YAAY;IAC/C,SAAgB,OAAO,EAAE,sBAAsB,CAAC;IAChD,SAAgB,OAAO,EAAE,sBAAsB,CAAC;IAChD,SAAgB,YAAY,EAAE,2BAA2B,CAAC;IAC1D,SAAgB,OAAO,EAAE,sBAAsB,CAAC;IAChD,SAAgB,SAAS,EAAE,wBAAwB,CAAC;gBAExC,IAAI,EAAE,UAAU;IAS5B;;;;;;;;;;OAUG;IACG,GAAG,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC;IAK9D;;;;;;;;;;;OAWG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;CAqB1E"}
1
+ {"version":3,"file":"FactionResource.d.ts","sourceRoot":"","sources":["../../../src/resources/FactionResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EACL,aAAa,EACb,SAAS,EACT,iBAAiB,EACjB,wBAAwB,EACxB,6BAA6B,EAC7B,cAAc,EACd,eAAe,EACf,mBAAmB,EACpB,MAAM,mBAAmB,CAAC;AAE3B,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,SAAS,GAAG,MAAM,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,MAAM;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,SAAS,GAAG,MAAM,CAAC;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,YAAY;IACtD;;;;;;;;OAQG;IACG,IAAI,CAAC,OAAO,EAAE;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAyBhC;;;;;;OAMG;IACG,gBAAgB,CAAC,OAAO,EAAE;QAC9B,SAAS,EAAE,MAAM,CAAC;QAClB,GAAG,EAAE,MAAM,CAAC;QACZ,QAAQ,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;QACtC,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAOrC;AAED;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,YAAY;IACtD;;;;;;;;OAQG;IACG,IAAI,CAAC,OAAO,EAAE;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAyBzB;;;;;;;;;OASG;IACG,GAAG,CAAC,OAAO,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;CAG7E;AAED;;;;GAIG;AACH,qBAAa,2BAA4B,SAAQ,YAAY;IAC3D;;;;;;;;OAQG;IACG,IAAI,CAAC,OAAO,EAAE;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;CAwB/B;AAED;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,YAAY;IACtD;;;;;;;;;OASG;IACG,GAAG,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,cAAc,CAAC;IAIrE;;;;;;;OAOG;IACG,QAAQ,CAAC,OAAO,EAAE,6BAA6B,GAAG,OAAO,CAAC,OAAO,CAAC;CAezE;AAED;;;;GAIG;AACH,qBAAa,wBAAyB,SAAQ,YAAY;IACxD;;;;;;;;;;;;;;OAcG;IACG,IAAI,CAAC,OAAO,EAAE;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,8CAA8C;QAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,0DAA0D;QAC1D,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,iFAAiF;QACjF,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,iHAAiH;QACjH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;CA6BlC;AAED;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,YAAY;IAC/C,SAAgB,OAAO,EAAE,sBAAsB,CAAC;IAChD,SAAgB,OAAO,EAAE,sBAAsB,CAAC;IAChD,SAAgB,YAAY,EAAE,2BAA2B,CAAC;IAC1D,SAAgB,OAAO,EAAE,sBAAsB,CAAC;IAChD,SAAgB,SAAS,EAAE,wBAAwB,CAAC;gBAExC,IAAI,EAAE,UAAU;IAS5B;;;;;;;;;;;;;;;;OAgBG;IACG,GAAG,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC;IAK9D;;;;;;;;;;;OAWG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;CAqB1E"}
@@ -24,7 +24,14 @@ export declare class GalaxyPlanetsResource extends BaseResource {
24
24
  pageDelay?: number;
25
25
  }): Promise<Page<GalaxyPlanetListItem>>;
26
26
  /**
27
- * Get planet by UID
27
+ * Get planet by UID.
28
+ *
29
+ * Returns the `Planet` object directly — not wrapped in a `Page`.
30
+ *
31
+ * @returns The `Planet` entity.
32
+ * @example
33
+ * const planet = await client.galaxy.planets.get({ uid: '9:123' });
34
+ * console.log(planet.name); // access properties directly, not planet.data
28
35
  */
29
36
  get(options: GetPlanetOptions): Promise<Planet>;
30
37
  }
@@ -47,10 +54,15 @@ export declare class GalaxySectorsResource extends BaseResource {
47
54
  pageDelay?: number;
48
55
  }): Promise<Page<GalaxySectorListItem>>;
49
56
  /**
50
- * Get sector by name or UID
57
+ * Get sector by name or UID.
58
+ *
59
+ * Returns the `Sector` object directly — not wrapped in a `Page`.
60
+ *
51
61
  * @param options - Sector identifier (use lowercase sector name, e.g., 'seswenna')
62
+ * @returns The `Sector` entity.
52
63
  * @example
53
64
  * const sector = await client.galaxy.sectors.get({ uid: 'seswenna' });
65
+ * console.log(sector.name); // access properties directly, not sector.data
54
66
  */
55
67
  get(options: GetSectorOptions): Promise<Sector>;
56
68
  }
@@ -73,7 +85,14 @@ export declare class GalaxySystemsResource extends BaseResource {
73
85
  pageDelay?: number;
74
86
  }): Promise<Page<GalaxySystemListItem>>;
75
87
  /**
76
- * Get system by UID
88
+ * Get system by UID.
89
+ *
90
+ * Returns the `System` object directly — not wrapped in a `Page`.
91
+ *
92
+ * @returns The `System` entity.
93
+ * @example
94
+ * const system = await client.galaxy.systems.get({ uid: '7:123' });
95
+ * console.log(system.name); // access properties directly, not system.data
77
96
  */
78
97
  get(options: GetSystemOptions): Promise<System>;
79
98
  }
@@ -96,7 +115,14 @@ export declare class GalaxyStationsResource extends BaseResource {
96
115
  pageDelay?: number;
97
116
  }): Promise<Page<GalaxyStationListItem>>;
98
117
  /**
99
- * Get station by UID
118
+ * Get station by UID.
119
+ *
120
+ * Returns the `Station` object directly — not wrapped in a `Page`.
121
+ *
122
+ * @returns The `Station` entity.
123
+ * @example
124
+ * const station = await client.galaxy.stations.get({ uid: '12:123' });
125
+ * console.log(station.name); // access properties directly, not station.data
100
126
  */
101
127
  get(options: GetStationOptions): Promise<Station>;
102
128
  }
@@ -119,7 +145,14 @@ export declare class GalaxyCitiesResource extends BaseResource {
119
145
  pageDelay?: number;
120
146
  }): Promise<Page<GalaxyCityListItem>>;
121
147
  /**
122
- * Get city by UID
148
+ * Get city by UID.
149
+ *
150
+ * Returns the `City` object directly — not wrapped in a `Page`.
151
+ *
152
+ * @returns The `City` entity.
153
+ * @example
154
+ * const city = await client.galaxy.cities.get({ uid: '13:123' });
155
+ * console.log(city.name); // access properties directly, not city.data
123
156
  */
124
157
  get(options: GetCityOptions): Promise<City>;
125
158
  }
@@ -1 +1 @@
1
- {"version":3,"file":"GalaxyResource.d.ts","sourceRoot":"","sources":["../../../src/resources/GalaxyResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EACL,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,MAAM,EACN,MAAM,EACN,MAAM,EACN,OAAO,EACP,IAAI,EACJ,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EACf,MAAM,mBAAmB,CAAC;AAE3B;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD;;;;;;OAMG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAsBvC;;OAEG;IACG,GAAG,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;CAGtD;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD;;;;;;OAMG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAsBvC;;;;;OAKG;IACG,GAAG,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;CAGtD;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD;;;;;;OAMG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAsBvC;;OAEG;IACG,GAAG,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;CAGtD;AAED;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,YAAY;IACtD;;;;;;OAMG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;IAwBxC;;OAEG;IACG,GAAG,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;CAGxD;AAED;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IACpD;;;;;;OAMG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAsBrC;;OAEG;IACG,GAAG,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAGlD;AAED;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C,SAAgB,OAAO,EAAE,qBAAqB,CAAC;IAC/C,SAAgB,OAAO,EAAE,qBAAqB,CAAC;IAC/C,SAAgB,OAAO,EAAE,qBAAqB,CAAC;IAC/C,SAAgB,QAAQ,EAAE,sBAAsB,CAAC;IACjD,SAAgB,MAAM,EAAE,oBAAoB,CAAC;gBAEjC,IAAI,EAAE,UAAU;IAS5B;;;;;;;;OAQG;IACG,qBAAqB,IAAI,OAAO,CAAC,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAsB5F"}
1
+ {"version":3,"file":"GalaxyResource.d.ts","sourceRoot":"","sources":["../../../src/resources/GalaxyResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EACL,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,MAAM,EACN,MAAM,EACN,MAAM,EACN,OAAO,EACP,IAAI,EACJ,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EACf,MAAM,mBAAmB,CAAC;AAE3B;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD;;;;;;OAMG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAsBvC;;;;;;;;;OASG;IACG,GAAG,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;CAGtD;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD;;;;;;OAMG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAsBvC;;;;;;;;;;OAUG;IACG,GAAG,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;CAGtD;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD;;;;;;OAMG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAsBvC;;;;;;;;;OASG;IACG,GAAG,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;CAGtD;AAED;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,YAAY;IACtD;;;;;;OAMG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;IAwBxC;;;;;;;;;OASG;IACG,GAAG,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;CAGxD;AAED;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IACpD;;;;;;OAMG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAsBrC;;;;;;;;;OASG;IACG,GAAG,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAGlD;AAED;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C,SAAgB,OAAO,EAAE,qBAAqB,CAAC;IAC/C,SAAgB,OAAO,EAAE,qBAAqB,CAAC;IAC/C,SAAgB,OAAO,EAAE,qBAAqB,CAAC;IAC/C,SAAgB,QAAQ,EAAE,sBAAsB,CAAC;IACjD,SAAgB,MAAM,EAAE,oBAAoB,CAAC;gBAEjC,IAAI,EAAE,UAAU;IAS5B;;;;;;;;OAQG;IACG,qBAAqB,IAAI,OAAO,CAAC,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAsB5F"}
@@ -41,7 +41,14 @@ export declare class InventoryEntitiesResource extends BaseResource {
41
41
  */
42
42
  list<T extends InventoryEntityType>(options: ListInventoryEntitiesOptions<T>): Promise<Page<InventoryEntityTypeMap[T]>>;
43
43
  /**
44
- * Get specific entity
44
+ * Get a specific inventory entity by type and UID.
45
+ *
46
+ * Returns the `Entity` object directly — not wrapped in a `Page`.
47
+ *
48
+ * @returns The `Entity`.
49
+ * @example
50
+ * const ship = await client.inventory.entities.get({ entityType: 'ships', uid: '8:123' });
51
+ * console.log(ship.name); // access properties directly, not ship.data
45
52
  */
46
53
  get(options: GetEntityOptions): Promise<Entity>;
47
54
  /**
@@ -92,7 +99,14 @@ export declare class InventoryResource extends BaseResource {
92
99
  readonly entities: InventoryEntitiesResource;
93
100
  constructor(http: HttpClient);
94
101
  /**
95
- * Get inventory by UID
102
+ * Get inventory summary by UID.
103
+ *
104
+ * Returns the inventory summary object directly — not wrapped in a `Page`.
105
+ *
106
+ * @returns The inventory summary.
107
+ * @example
108
+ * const overview = await client.inventory.get({ uid: '1:12345' });
109
+ * console.log(overview); // access properties directly, not overview.data
96
110
  */
97
111
  get(options: {
98
112
  uid: string;
@@ -1 +1 @@
1
- {"version":3,"file":"InventoryResource.d.ts","sourceRoot":"","sources":["../../../src/resources/InventoryResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EACL,MAAM,EACN,gBAAgB,EAChB,mBAAmB,EACnB,sBAAsB,EACtB,4BAA4B,EAE7B,MAAM,mBAAmB,CAAC;AAE3B;;;;GAIG;AACH,qBAAa,yBAA0B,SAAQ,YAAY;IACzD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,IAAI,CAAC,CAAC,SAAS,mBAAmB,EACtC,OAAO,EAAE,4BAA4B,CAAC,CAAC,CAAC,GACvC,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC;IA0C3C;;OAEG;IACG,GAAG,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;IAIrD;;;;;;;OAOG;IACG,cAAc,CAAC,OAAO,EAAE;QAC5B,UAAU,EAAE,MAAM,CAAC;QACnB,GAAG,EAAE,MAAM,CAAC;QACZ,QAAQ,EACJ,MAAM,GACN,SAAS,GACT,OAAO,GACP,WAAW,GACX,OAAO,GACP,UAAU,GACV,QAAQ,GACR,cAAc,GACd,iBAAiB,GACjB,gBAAgB,CAAC;QACrB,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,MAAM,CAAC;IAenB;;OAEG;IACG,MAAM,CAAC,OAAO,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAOtF;;OAEG;IACG,SAAS,CAAC,OAAO,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAOzF;;OAEG;IACG,aAAa,CAAC,OAAO,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAGjF;AAED;;;;GAIG;AACH,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,SAAgB,QAAQ,EAAE,yBAAyB,CAAC;gBAExC,IAAI,EAAE,UAAU;IAK5B;;OAEG;IACG,GAAG,CAAC,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAGtE"}
1
+ {"version":3,"file":"InventoryResource.d.ts","sourceRoot":"","sources":["../../../src/resources/InventoryResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EACL,MAAM,EACN,gBAAgB,EAChB,mBAAmB,EACnB,sBAAsB,EACtB,4BAA4B,EAE7B,MAAM,mBAAmB,CAAC;AAE3B;;;;GAIG;AACH,qBAAa,yBAA0B,SAAQ,YAAY;IACzD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,IAAI,CAAC,CAAC,SAAS,mBAAmB,EACtC,OAAO,EAAE,4BAA4B,CAAC,CAAC,CAAC,GACvC,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC;IA0C3C;;;;;;;;;OASG;IACG,GAAG,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;IAIrD;;;;;;;OAOG;IACG,cAAc,CAAC,OAAO,EAAE;QAC5B,UAAU,EAAE,MAAM,CAAC;QACnB,GAAG,EAAE,MAAM,CAAC;QACZ,QAAQ,EACJ,MAAM,GACN,SAAS,GACT,OAAO,GACP,WAAW,GACX,OAAO,GACP,UAAU,GACV,QAAQ,GACR,cAAc,GACd,iBAAiB,GACjB,gBAAgB,CAAC;QACrB,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,MAAM,CAAC;IAenB;;OAEG;IACG,MAAM,CAAC,OAAO,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAOtF;;OAEG;IACG,SAAS,CAAC,OAAO,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAOzF;;OAEG;IACG,aAAa,CAAC,OAAO,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAGjF;AAED;;;;GAIG;AACH,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,SAAgB,QAAQ,EAAE,yBAAyB,CAAC;gBAExC,IAAI,EAAE,UAAU;IAK5B;;;;;;;;;OASG;IACG,GAAG,CAAC,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAGtE"}
@@ -10,7 +10,14 @@ import { Location } from '../types/index.js';
10
10
  */
11
11
  export declare class LocationResource extends BaseResource {
12
12
  /**
13
- * Get entity location
13
+ * Get an entity's current location.
14
+ *
15
+ * Returns the `Location` object directly — not wrapped in a `Page`.
16
+ *
17
+ * @returns The `Location` data.
18
+ * @example
19
+ * const location = await client.location.get({ entityType: 'character', uid: '1:12345' });
20
+ * console.log(location); // access properties directly, not location.data
14
21
  */
15
22
  get(options: {
16
23
  entityType: string;
@@ -1 +1 @@
1
- {"version":3,"file":"LocationResource.d.ts","sourceRoot":"","sources":["../../../src/resources/LocationResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAChD;;OAEG;IACG,GAAG,CAAC,OAAO,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;CAG3E"}
1
+ {"version":3,"file":"LocationResource.d.ts","sourceRoot":"","sources":["../../../src/resources/LocationResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAChD;;;;;;;;;OASG;IACG,GAAG,CAAC,OAAO,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;CAG3E"}
@@ -24,7 +24,14 @@ export declare class MarketVendorsResource extends BaseResource {
24
24
  pageDelay?: number;
25
25
  }): Promise<Page<Vendor>>;
26
26
  /**
27
- * Get vendor by UID
27
+ * Get a specific vendor by UID.
28
+ *
29
+ * Returns the `Vendor` object directly — not wrapped in a `Page`.
30
+ *
31
+ * @returns The `Vendor` entity.
32
+ * @example
33
+ * const vendor = await client.market.vendors.get({ uid: 'vendor-uid' });
34
+ * console.log(vendor.name); // access properties directly, not vendor.data
28
35
  */
29
36
  get(options: GetVendorOptions): Promise<Vendor>;
30
37
  }
@@ -1 +1 @@
1
- {"version":3,"file":"MarketResource.d.ts","sourceRoot":"","sources":["../../../src/resources/MarketResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAE7D;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD;;;;;;OAMG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IA0BzB;;OAEG;IACG,GAAG,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;CAGtD;AAED;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C,SAAgB,OAAO,EAAE,qBAAqB,CAAC;gBAEnC,IAAI,EAAE,UAAU;CAI7B"}
1
+ {"version":3,"file":"MarketResource.d.ts","sourceRoot":"","sources":["../../../src/resources/MarketResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAE7D;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD;;;;;;OAMG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IA0BzB;;;;;;;;;OASG;IACG,GAAG,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;CAGtD;AAED;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,YAAY;IAC9C,SAAgB,OAAO,EAAE,qBAAqB,CAAC;gBAEnC,IAAI,EAAE,UAAU;CAI7B"}
@@ -35,10 +35,15 @@ export declare class GNSResource extends BaseResource {
35
35
  list(options?: ListGNSOptions): Promise<Page<NewsListItem>>;
36
36
  /**
37
37
  * Get a specific GNS news item by numeric ID.
38
+ *
39
+ * Returns the `NewsItem` object directly — not wrapped in a `Page`.
38
40
  * Author and faction are normalized to object references with `value`.
39
41
  * If the API returns an array, the SDK returns the first normalized item.
42
+ *
43
+ * @returns The `NewsItem` entity.
40
44
  * @example
41
45
  * const post = await client.news.gns.get({ id: 49108 });
46
+ * console.log(post.title); // access properties directly, not post.data
42
47
  * console.log(post.author.value);
43
48
  * console.log(post.faction.value);
44
49
  */
@@ -71,10 +76,15 @@ export declare class SimNewsResource extends BaseResource {
71
76
  list(options?: ListSimNewsOptions): Promise<Page<NewsListItem>>;
72
77
  /**
73
78
  * Get a specific Sim News item by numeric ID.
79
+ *
80
+ * Returns the `NewsItem` object directly — not wrapped in a `Page`.
74
81
  * Author and faction are normalized to object references with `value`.
75
82
  * If the API returns an array, the SDK returns the first normalized item.
83
+ *
84
+ * @returns The `NewsItem` entity.
76
85
  * @example
77
86
  * const post = await client.news.simNews.get({ id: 49108 });
87
+ * console.log(post.title); // access properties directly, not post.data
78
88
  * console.log(post.author.value);
79
89
  * console.log(post.faction.value);
80
90
  */
@@ -1 +1 @@
1
- {"version":3,"file":"NewsResource.d.ts","sourceRoot":"","sources":["../../../src/resources/NewsResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,QAAQ,EACR,YAAY,EAIb,MAAM,mBAAmB,CAAC;AAyH3B;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,YAAY;IAC3C;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAmCjE;;;;;;;;OAQG;IACG,GAAG,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC;CAI1D;AAED;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,YAAY;IAC/C;;;;;;;;;;;;;;;;;OAiBG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAiCrE;;;;;;;;OAQG;IACG,GAAG,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC;CAI1D;AAED;;;;GAIG;AACH,qBAAa,YAAa,SAAQ,YAAY;IAC5C,SAAgB,GAAG,EAAE,WAAW,CAAC;IACjC,SAAgB,OAAO,EAAE,eAAe,CAAC;gBAE7B,IAAI,EAAE,UAAU;CAK7B"}
1
+ {"version":3,"file":"NewsResource.d.ts","sourceRoot":"","sources":["../../../src/resources/NewsResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,QAAQ,EACR,YAAY,EAIb,MAAM,mBAAmB,CAAC;AAyH3B;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,YAAY;IAC3C;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAmCjE;;;;;;;;;;;;;OAaG;IACG,GAAG,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC;CAI1D;AAED;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,YAAY;IAC/C;;;;;;;;;;;;;;;;;OAiBG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAiCrE;;;;;;;;;;;;;OAaG;IACG,GAAG,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC;CAI1D;AAED;;;;GAIG;AACH,qBAAa,YAAa,SAAQ,YAAY;IAC5C,SAAgB,GAAG,EAAE,WAAW,CAAC;IACjC,SAAgB,OAAO,EAAE,eAAe,CAAC;gBAE7B,IAAI,EAAE,UAAU;CAK7B"}
@@ -56,7 +56,14 @@ export declare class TypesEntitiesResource extends BaseResource {
56
56
  */
57
57
  list<T extends TypesEntityType>(options: ListTypesEntitiesOptions<T>): Promise<Page<TypesEntityListItem>>;
58
58
  /**
59
- * Get specific entity type information
59
+ * Get specific entity type information by category and UID.
60
+ *
61
+ * Returns the entity type object directly — not wrapped in a `Page`.
62
+ *
63
+ * @returns The entity type detail (e.g. `TypesShipEntity`, `TypesVehicleEntity`, etc.).
64
+ * @example
65
+ * const shipType = await client.types.entities.get({ entityType: 'ships', uid: '8:7' });
66
+ * console.log(shipType.name); // access properties directly, not shipType.data
60
67
  */
61
68
  get<T extends TypesEntityType>(options: GetTypesEntityOptions<T>): Promise<TypesEntityGetResponseMap[T]>;
62
69
  private extractEntityArrayForType;
@@ -1 +1 @@
1
- {"version":3,"file":"TypesResource.d.ts","sourceRoot":"","sources":["../../../src/resources/TypesResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EACL,qBAAqB,EACrB,wBAAwB,EACxB,yBAAyB,EACzB,mBAAmB,EACnB,eAAe,EAChB,MAAM,mBAAmB,CAAC;AAU3B,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IACpD;;;;;;;;;;;OAWG;IACG,IAAI,CAAC,OAAO,EAAE;QAClB,UAAU,EAAE,eAAe,CAAC;QAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;CA0C/B;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD;;;;;;;OAOG;IACG,IAAI,CAAC,CAAC,SAAS,eAAe,EAClC,OAAO,EAAE,wBAAwB,CAAC,CAAC,CAAC,GACnC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAwBrC;;OAEG;IACG,GAAG,CAAC,CAAC,SAAS,eAAe,EACjC,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAChC,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;IAKxC,OAAO,CAAC,yBAAyB;IAuHjC,OAAO,CAAC,kBAAkB;CAY3B;AAED;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAC7C,SAAgB,OAAO,EAAE,oBAAoB,CAAC;IAC9C,SAAgB,QAAQ,EAAE,qBAAqB,CAAC;gBAEpC,IAAI,EAAE,UAAU;IAM5B;;OAEG;IACG,eAAe,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;CAc/C"}
1
+ {"version":3,"file":"TypesResource.d.ts","sourceRoot":"","sources":["../../../src/resources/TypesResource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EACL,qBAAqB,EACrB,wBAAwB,EACxB,yBAAyB,EACzB,mBAAmB,EACnB,eAAe,EAChB,MAAM,mBAAmB,CAAC;AAU3B,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IACpD;;;;;;;;;;;OAWG;IACG,IAAI,CAAC,OAAO,EAAE;QAClB,UAAU,EAAE,eAAe,CAAC;QAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;CA0C/B;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD;;;;;;;OAOG;IACG,IAAI,CAAC,CAAC,SAAS,eAAe,EAClC,OAAO,EAAE,wBAAwB,CAAC,CAAC,CAAC,GACnC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAwBrC;;;;;;;;;OASG;IACG,GAAG,CAAC,CAAC,SAAS,eAAe,EACjC,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAChC,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;IAKxC,OAAO,CAAC,yBAAyB;IAuHjC,OAAO,CAAC,kBAAkB;CAY3B;AAED;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAC7C,SAAgB,OAAO,EAAE,oBAAoB,CAAC;IAC9C,SAAgB,QAAQ,EAAE,qBAAqB,CAAC;gBAEpC,IAAI,EAAE,UAAU;IAM5B;;OAEG;IACG,eAAe,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;CAc/C"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "swcombine-sdk",
3
- "version": "3.2.4",
3
+ "version": "3.2.6",
4
4
  "description": "Comprehensive TypeScript SDK for Star Wars Combine API v2.0",
5
5
  "main": "./dist/cjs/index.js",
6
6
  "module": "./dist/esm/index.js",
@@ -37,10 +37,8 @@
37
37
  "lint": "eslint src --ext .ts",
38
38
  "format": "prettier --write \"src/**/*.ts\"",
39
39
  "format:check": "prettier --check \"src/**/*.ts\"",
40
- "docs:api": "typedoc && tsx scripts/generate-llms-txt.ts",
41
- "docs:api:watch": "typedoc --watch",
42
- "docs:html": "typedoc --options typedoc.html.json",
43
- "docs:llms": "tsx scripts/generate-llms-txt.ts",
40
+ "docs": "typedoc && tsx scripts/generate-mintlify.ts",
41
+ "docs:watch": "typedoc --watch",
44
42
  "get-token": "tsx scripts/get-oauth-token.ts",
45
43
  "get-character-uid": "tsx scripts/get-character-uid.ts",
46
44
  "refresh-token": "tsx scripts/refresh-token.ts",
@@ -68,7 +66,7 @@
68
66
  "bugs": {
69
67
  "url": "https://github.com/jonmarkgo/swcombine-sdk-nodejs/issues"
70
68
  },
71
- "homepage": "https://jonmarkgo.github.io/swcombine-sdk-nodejs/",
69
+ "homepage": "https://swc-sdk.zeltros.dev/",
72
70
  "engines": {
73
71
  "node": ">=18.0.0"
74
72
  },