@ophelio/sdk 0.5.0 → 0.6.0

package/dist/index.mjs

@@ -292,13 +292,25 @@ var BillingOptionSalesChannelsResource = class extends APIResource {
 //#endregion
 //#region src/resources/billing-options.ts
 var BillingOptionsResource = class extends APIResource {
-	async list(options) {
-		return (await this.transport.request({
+	/**
+	* Every billing option in the project, across all plans — plans multiplied
+	* by their options, so this is the largest of the configuration lists.
+	* Ordered by plan, then display name. Use `collect` or `paginate` to walk it,
+	* or read `total_size` off the first page for a count without loading rows.
+	*/
+	async list(params, options) {
+		const response = await this.transport.request({
 			method: "GET",
 			path: "/api/v1/billing-options",
+			query: pageQuery(params),
 			retryable: true,
 			options
-		})).billing_options;
+		});
+		return {
+			items: response.billing_options,
+			next_page_token: response.next_page_token,
+			total_size: response.total_size
+		};
 	}
 	get(id, options) {
 		return this.transport.request({
@@ -325,13 +337,24 @@ var BillingOptionsResource = class extends APIResource {
 			options
 		});
 	}
-	async listSalesChannels(id, options) {
-		return (await this.transport.request({
+	/**
+	* The sales channels a billing option is restricted to, in the order they
+	* were linked. No links at all means the billing option is available
+	* everywhere.
+	*/
+	async listSalesChannels(id, params, options) {
+		const response = await this.transport.request({
 			method: "GET",
 			path: `/api/v1/billing-options/${encodeURIComponent(id)}/sales-channels`,
+			query: pageQuery(params),
 			retryable: true,
 			options
-		})).sales_channels;
+		});
+		return {
+			items: response.sales_channels,
+			next_page_token: response.next_page_token,
+			total_size: response.total_size
+		};
 	}
 	createSalesChannelLink(id, params, options) {
 		return this.transport.request({
@@ -591,13 +614,19 @@ var EntitlementsResource = class extends APIResource {
 			options: requestOptions
 		})).usage;
 	}
-	async list(options) {
-		return (await this.transport.request({
+	async list(params, options) {
+		const response = await this.transport.request({
 			method: "GET",
 			path: "/api/v1/entitlements",
+			query: pageQuery(params),
 			retryable: true,
 			options
-		})).entitlements;
+		});
+		return {
+			items: response.entitlements,
+			next_page_token: response.next_page_token,
+			total_size: response.total_size
+		};
 	}
 	get(id, options) {
 		return this.transport.request({
@@ -637,13 +666,19 @@ var EntitlementsResource = class extends APIResource {
 //#endregion
 //#region src/resources/member-roles.ts
 var MemberRolesResource = class extends APIResource {
-	async list(options) {
-		return (await this.transport.request({
+	async list(params, options) {
+		const response = await this.transport.request({
 			method: "GET",
 			path: "/api/v1/member-roles",
+			query: pageQuery(params),
 			retryable: true,
 			options
-		})).member_roles;
+		});
+		return {
+			items: response.member_roles,
+			next_page_token: response.next_page_token,
+			total_size: response.total_size
+		};
 	}
 	get(id, options) {
 		return this.transport.request({
@@ -686,12 +721,31 @@ var MembersResource = class extends APIResource {
 	/**
 	* Active-member list for offline gate caching. Pass the previous
 	* response's `generated_at` as `since` to fetch incrementally.
+	*
+	* `targets` names the venue, zone, shop or gate this roster is for, and
+	* settles what the gate can grant while it is offline: each member's
+	* entitlements are stored as they stand at the moment of the sync and are
+	* read back during an outage without being checked again. Omit it for the
+	* whole roster. Codes are matched exactly, so send them back verbatim from
+	* `targetCodes.list()` — an unregistered one is refused with a 400.
+	*
+	* Two things work differently here than on `admit.check` and
+	* `members.listEntitlements`, both on purpose. An empty `targets` is
+	* refused with a 400. It is not read as naming no targets, so it never
+	* returns only the benefits valid everywhere. And a project that requires
+	* every read to say where it is still answers a sync that omits `targets`.
+	* The roster is what a gate falls back on when it cannot reach us, so a
+	* quietly shortened or unfetchable copy would only show up during the
+	* outage it was kept for.
 	*/
 	sync(params = {}, options) {
 		return this.transport.request({
 			method: "GET",
 			path: "/api/v1/members/sync",
-			query: { since: params.since },
+			query: {
+				since: params.since,
+				targets: params.targets
+			},
 			retryable: true,
 			options
 		});
@@ -718,18 +772,29 @@ var MembersResource = class extends APIResource {
 	* Each entitlement carries `valid_on` and `valid_at` when something
 	* restricts it by date or by target; both list only what it matched, never
 	* what it failed.
+	*
+	* `page_size` / `page_token` window the already-filtered result, so they
+	* compose with `type` and `targets` rather than replacing them. A page token
+	* is bound to the filters it was issued under: change `type` or `targets`
+	* and the token is refused rather than returning misaligned rows.
 	*/
 	async listEntitlements(id, params = {}, options) {
-		return (await this.transport.request({
+		const response = await this.transport.request({
 			method: "GET",
 			path: `/api/v1/members/${encodeURIComponent(id)}/entitlements`,
 			query: {
+				...pageQuery(params),
 				type: params.type,
 				targets: params.targets
 			},
 			retryable: true,
 			options
-		})).entitlements;
+		});
+		return {
+			items: response.entitlements,
+			next_page_token: response.next_page_token,
+			total_size: response.total_size
+		};
 	}
 	/**
 	* Updates a member's details. Accepts `name`, `date_of_birth` and `role`
@@ -882,13 +947,24 @@ var MembershipsResource = class extends APIResource {
 			options: requestOptions
 		});
 	}
-	async listMembers(id, options) {
-		return (await this.transport.request({
+	/**
+	* The cardholders on a membership, primary first, then in the order they
+	* were added. Bounded by the plan's `max_party_size`, so the default page
+	* size covers a membership in one request.
+	*/
+	async listMembers(id, params, options) {
+		const response = await this.transport.request({
 			method: "GET",
 			path: `/api/v1/memberships/${encodeURIComponent(id)}/members`,
+			query: pageQuery(params),
 			retryable: true,
 			options
-		})).members;
+		});
+		return {
+			items: response.members,
+			next_page_token: response.next_page_token,
+			total_size: response.total_size
+		};
 	}
 	/**
 	* Add a member to an existing membership, up to the plan's max party size.
@@ -1105,13 +1181,19 @@ var PlanPricingGroupMappingsResource = class extends APIResource {
 //#endregion
 //#region src/resources/plans.ts
 var PlansResource = class extends APIResource {
-	async list(options) {
-		return (await this.transport.request({
+	async list(params, options) {
+		const response = await this.transport.request({
 			method: "GET",
 			path: "/api/v1/plans",
+			query: pageQuery(params),
 			retryable: true,
 			options
-		})).plans;
+		});
+		return {
+			items: response.plans,
+			next_page_token: response.next_page_token,
+			total_size: response.total_size
+		};
 	}
 	get(id, options) {
 		return this.transport.request({
@@ -1121,21 +1203,33 @@ var PlansResource = class extends APIResource {
 			options
 		});
 	}
-	async listBillingOptions(id, options) {
-		return (await this.transport.request({
+	async listBillingOptions(id, params, options) {
+		const response = await this.transport.request({
 			method: "GET",
 			path: `/api/v1/plans/${encodeURIComponent(id)}/billing-options`,
+			query: pageQuery(params),
 			retryable: true,
 			options
-		})).billing_options;
+		});
+		return {
+			items: response.billing_options,
+			next_page_token: response.next_page_token,
+			total_size: response.total_size
+		};
 	}
-	async listEntitlements(id, options) {
-		return (await this.transport.request({
+	async listEntitlements(id, params, options) {
+		const response = await this.transport.request({
 			method: "GET",
 			path: `/api/v1/plans/${encodeURIComponent(id)}/entitlements`,
+			query: pageQuery(params),
 			retryable: true,
 			options
-		})).entitlements;
+		});
+		return {
+			items: response.entitlements,
+			next_page_token: response.next_page_token,
+			total_size: response.total_size
+		};
 	}
 	create(params, options) {
 		return this.transport.request({
@@ -1172,13 +1266,19 @@ var PlansResource = class extends APIResource {
 			options
 		});
 	}
-	async listPlanLinks(id, options) {
-		return (await this.transport.request({
+	async listPlanLinks(id, params, options) {
+		const response = await this.transport.request({
 			method: "GET",
 			path: `/api/v1/plans/${encodeURIComponent(id)}/plan-links`,
+			query: pageQuery(params),
 			retryable: true,
 			options
-		})).plan_links;
+		});
+		return {
+			items: response.plan_links,
+			next_page_token: response.next_page_token,
+			total_size: response.total_size
+		};
 	}
 	createPlanLink(id, params, options) {
 		return this.transport.request({
@@ -1198,13 +1298,19 @@ var PlansResource = class extends APIResource {
 			options
 		});
 	}
-	async listPricingGroupMappings(id, options) {
-		return (await this.transport.request({
+	async listPricingGroupMappings(id, params, options) {
+		const response = await this.transport.request({
 			method: "GET",
 			path: `/api/v1/plans/${encodeURIComponent(id)}/pricing-group-mappings`,
+			query: pageQuery(params),
 			retryable: true,
 			options
-		})).pricing_group_mappings;
+		});
+		return {
+			items: response.pricing_group_mappings,
+			next_page_token: response.next_page_token,
+			total_size: response.total_size
+		};
 	}
 	createPricingGroupMapping(id, params, options) {
 		return this.transport.request({
@@ -1219,13 +1325,19 @@ var PlansResource = class extends APIResource {
 //#endregion
 //#region src/resources/pricing-groups.ts
 var PricingGroupsResource = class extends APIResource {
-	async list(options) {
-		return (await this.transport.request({
+	async list(params, options) {
+		const response = await this.transport.request({
 			method: "GET",
 			path: "/api/v1/pricing-groups",
+			query: pageQuery(params),
 			retryable: true,
 			options
-		})).pricing_groups;
+		});
+		return {
+			items: response.pricing_groups,
+			next_page_token: response.next_page_token,
+			total_size: response.total_size
+		};
 	}
 	get(id, options) {
 		return this.transport.request({
@@ -1265,13 +1377,19 @@ var PricingGroupsResource = class extends APIResource {
 //#endregion
 //#region src/resources/sales-channels.ts
 var SalesChannelsResource = class extends APIResource {
-	async list(options) {
-		return (await this.transport.request({
+	async list(params, options) {
+		const response = await this.transport.request({
 			method: "GET",
 			path: "/api/v1/sales-channels",
+			query: pageQuery(params),
 			retryable: true,
 			options
-		})).sales_channels;
+		});
+		return {
+			items: response.sales_channels,
+			next_page_token: response.next_page_token,
+			total_size: response.total_size
+		};
 	}
 	get(id, options) {
 		return this.transport.request({
@@ -1390,13 +1508,19 @@ var TargetCodesResource = class extends APIResource {
 //#endregion
 //#region src/resources/webhook-subscriptions.ts
 var WebhookSubscriptionsResource = class extends APIResource {
-	async list(options) {
-		return (await this.transport.request({
+	async list(params, options) {
+		const response = await this.transport.request({
 			method: "GET",
 			path: "/api/v1/webhook-subscriptions",
+			query: pageQuery(params),
 			retryable: true,
 			options
-		})).webhook_subscriptions;
+		});
+		return {
+			items: response.webhook_subscriptions,
+			next_page_token: response.next_page_token,
+			total_size: response.total_size
+		};
 	}
 	get(id, options) {
 		return this.transport.request({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ophelio/sdk",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Official JavaScript / TypeScript SDK for the Ophel.io membership & entitlement API.",
   "license": "MIT",
   "author": "Ophel.io",
@@ -47,6 +47,6 @@
     "publint": "^0.3.21",
     "tsdown": "^0.22.0",
     "typescript": "^6.0.3",
-    "vitest": "^4.0.18"
+    "vitest": "^5.0.0"
   }
 }