yungle-client 0.3.0 → 0.3.1

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import type { Collection, CollectionFile, CollectionSummary, Contact, ContactInput, DownloadEvent, DownloadLinks, ImportInput, ImportStatus, Submission, UploadRequest, UploadRequestInput, FileInput, Folder, Guest, Me, PulledWebhookEvent, RecipientStatus, Transfer, TransferFile, TransferSummary, UploadTargets, WebhookDelivery, WebhookEndpoint, WebhookEventType } from './types.js';
+import type { Collection, CollectionFile, CollectionSummary, Contact, ContactInput, DownloadEvent, DownloadLinks, ImportInput, ImportStatus, Submission, UploadRequest, UploadRequestInput, FileInput, Folder, Guest, Me, Referral, PulledWebhookEvent, RecipientStatus, Transfer, TransferFile, TransferSummary, UploadTargets, WebhookDelivery, WebhookEndpoint, WebhookEventType } from './types.js';
 import { type RenewOutcome as Renewal } from './upload-token.js';
 import { type UploadFileOptions } from './upload.js';
 export { chunkSize, uploadFile, UploadError, type UploadFileOptions } from './upload.js';
@@ -106,6 +106,8 @@ export declare class YungleClient {
         uploadUrl: string;
     }>;
     me(): Promise<Me>;
+    /** Your invite code and link, and the free months it has earned. */
+    getReferral(): Promise<Referral>;
     /**
      * One page of transfers, newest first — 100 by default, up to 500. Pass the
      * returned `nextCursor` back as `cursor` for the next page; it is null on the

package/dist/index.mjs

@@ -220,7 +220,7 @@ function pageQuery(page, extra = {}) {
   const q = params.toString();
   return q ? `?${q}` : "";
 }
-var CLIENT_VERSION = true ? "0.3.0" : "dev";
+var CLIENT_VERSION = true ? "0.3.1" : "dev";
 var YungleClient = class {
   baseUrl;
   apiKey;
@@ -260,6 +260,10 @@ var YungleClient = class {
   me() {
     return this.request("GET", "/me");
   }
+  /** Your invite code and link, and the free months it has earned. */
+  getReferral() {
+    return this.request("GET", "/me/referral");
+  }
   // ── Transfers ─────────────────────────────────────────────────────────────
   /**
    * One page of transfers, newest first — 100 by default, up to 500. Pass the

package/dist/types.d.ts

@@ -40,6 +40,23 @@ export interface KeyInfo {
     /** Whether this credential may make Yungle email anyone. Absent on older servers. */
     canEmail?: boolean;
 }
+/** Your invite code and what it has earned (`GET /me/referral`). */
+export interface Referral {
+    /** Your invite code. A friend can type it in Settings › Plan. */
+    code: string;
+    /** Your invite link: the same code, as a page that signs them up. */
+    url: string;
+    /** Free months earned so far. */
+    earnedMonths: number;
+    /** Free months still available to earn. */
+    remainingMonths: number;
+    /** The most free months one person can earn, ever. */
+    cap: number;
+    /** True once `earnedMonths` reached `cap`. The link still gives friends their month. */
+    capped: boolean;
+    /** Friends in their free month, or inside the 14 days after their first payment. */
+    pending: number;
+}
 export interface Me {
     workspace: Workspace;
     plan: PlanInfo;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yungle-client",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "type": "module",
   "exports": {
     ".": {