@ophelio/sdk 0.2.1 → 0.2.2
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.
- package/README.md +17 -17
- package/dist/index.cjs +54 -0
- package/dist/index.d.cts +283 -101
- package/dist/index.d.mts +283 -101
- package/dist/index.mjs +54 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -153,23 +153,23 @@ collection is written to while you iterate. Paginated methods are marked
|
|
|
153
153
|
|
|
154
154
|
Everything reachable with an API key is covered:
|
|
155
155
|
|
|
156
|
-
| Namespace | Methods
|
|
157
|
-
| ---------------------------- |
|
|
158
|
-
| `admit` | `check({ card })`
|
|
159
|
-
| `members` | `sync({ since? })`, `get(id)`, `listEntitlements(id, { type? })`, `reissueCard(id, { note? })`
|
|
160
|
-
| `memberships` | `list(params?)`, `get(id)`, `create(...)`, `update(id, ...)`, `cancel(id, ...)`, `uncancel(id)`, `renew(id, ...)`, `upgrade(id, ...)`, `downgrade(id, ...)`, `listMembers(id)`, `listScheduledChanges(id, params?)`, `cancelScheduledChange(id, changeId)`, `listTransactions(id, params?)`, `listTermTransactions(id, termId, params?)`, `createTransaction(id, ...)` |
|
|
161
|
-
| `customers` | `list(params?)`, `get(id)`, `create(...)`, `update(id, ...)`, `delete(id)`, `listMemberships(id, params?)`
|
|
162
|
-
| `entitlements` | `redeem(...)`, `recordUsage(...)`, `list()`, `get(id)`, `create(...)`, `update(id, ...)`, `delete(id)`
|
|
163
|
-
| `plans` | `list()`, `get(id)`, `create(...)`, `update(id, ...)`, `delete(id)`, `listBillingOptions(id)`, `createBillingOption(id, ...)`, `listEntitlements(id)`, `createEntitlement(id, ...)`, `listPlanLinks(id)`, `createPlanLink(id, ...)`, `listPricingGroupMappings(id)`, `createPricingGroupMapping(id, ...)`
|
|
164
|
-
| `billingOptions` | `list()`, `get(id)`, `update(id, ...)`, `delete(id)`, `listSalesChannels(id)`, `createSalesChannelLink(id, ...)`
|
|
165
|
-
| `memberRoles` | `list()`, `get(id)`, `create(...)`, `update(id, ...)`, `delete(id)`
|
|
166
|
-
| `pricingGroups` | `list()`, `get(id)`, `create(...)`, `update(id, ...)`, `delete(id)`
|
|
167
|
-
| `salesChannels` | `list()`, `get(id)`, `create(...)`, `update(id, ...)`, `delete(id)`
|
|
168
|
-
| `planEntitlements` | `get(id)`, `update(id, ...)`, `delete(id)`
|
|
169
|
-
| `planLinks` | `delete(id)`
|
|
170
|
-
| `planPricingGroupMappings` | `delete(id)`
|
|
171
|
-
| `billingOptionSalesChannels` | `delete(id)`
|
|
172
|
-
| `webhookSubscriptions` | `list()`, `get(id)`, `create(...)`, `update(id, ...)`, `delete(id)`, `listDeliveries(id, params?)`
|
|
156
|
+
| Namespace | Methods |
|
|
157
|
+
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
158
|
+
| `admit` | `check({ card })` |
|
|
159
|
+
| `members` | `sync({ since? })`, `get(id)`, `listEntitlements(id, { type? })`, `update(id, ...)`, `remove(id)`, `setPrimary(id)`, `reissueCard(id, { note? })` |
|
|
160
|
+
| `memberships` | `list(params?)`, `get(id)`, `create(...)`, `update(id, ...)`, `cancel(id, ...)`, `uncancel(id)`, `renew(id, ...)`, `upgrade(id, ...)`, `downgrade(id, ...)`, `listMembers(id)`, `addMember(id, ...)`, `listScheduledChanges(id, params?)`, `cancelScheduledChange(id, changeId)`, `listTransactions(id, params?)`, `listTermTransactions(id, termId, params?)`, `createTransaction(id, ...)` |
|
|
161
|
+
| `customers` | `list(params?)`, `get(id)`, `create(...)`, `update(id, ...)`, `delete(id)`, `listMemberships(id, params?)` |
|
|
162
|
+
| `entitlements` | `redeem(...)`, `recordUsage(...)`, `list()`, `get(id)`, `create(...)`, `update(id, ...)`, `delete(id)` |
|
|
163
|
+
| `plans` | `list()`, `get(id)`, `create(...)`, `update(id, ...)`, `delete(id)`, `listBillingOptions(id)`, `createBillingOption(id, ...)`, `listEntitlements(id)`, `createEntitlement(id, ...)`, `listPlanLinks(id)`, `createPlanLink(id, ...)`, `listPricingGroupMappings(id)`, `createPricingGroupMapping(id, ...)` |
|
|
164
|
+
| `billingOptions` | `list()`, `get(id)`, `update(id, ...)`, `delete(id)`, `listSalesChannels(id)`, `createSalesChannelLink(id, ...)` |
|
|
165
|
+
| `memberRoles` | `list()`, `get(id)`, `create(...)`, `update(id, ...)`, `delete(id)` |
|
|
166
|
+
| `pricingGroups` | `list()`, `get(id)`, `create(...)`, `update(id, ...)`, `delete(id)` |
|
|
167
|
+
| `salesChannels` | `list()`, `get(id)`, `create(...)`, `update(id, ...)`, `delete(id)` |
|
|
168
|
+
| `planEntitlements` | `get(id)`, `update(id, ...)`, `delete(id)` |
|
|
169
|
+
| `planLinks` | `delete(id)` |
|
|
170
|
+
| `planPricingGroupMappings` | `delete(id)` |
|
|
171
|
+
| `billingOptionSalesChannels` | `delete(id)` |
|
|
172
|
+
| `webhookSubscriptions` | `list()`, `get(id)`, `create(...)`, `update(id, ...)`, `delete(id)`, `listDeliveries(id, params?)` |
|
|
173
173
|
|
|
174
174
|
Every method accepts a trailing `options` argument: `{ signal?, headers? }`
|
|
175
175
|
(plus `idempotencyKey?` on the idempotency-keyed mutations: `memberships.create`
|
package/dist/index.cjs
CHANGED
|
@@ -535,6 +535,44 @@ var MembersResource = class extends APIResource {
|
|
|
535
535
|
options
|
|
536
536
|
})).entitlements;
|
|
537
537
|
}
|
|
538
|
+
/**
|
|
539
|
+
* Updates a member's details. Accepts `name`, `date_of_birth` and `role`
|
|
540
|
+
* (a member-role code). To reassign the primary member use `setPrimary`;
|
|
541
|
+
* to rotate a card use `reissueCard`.
|
|
542
|
+
*/
|
|
543
|
+
update(id, params, options) {
|
|
544
|
+
return this.transport.request({
|
|
545
|
+
method: "PATCH",
|
|
546
|
+
path: `/api/v1/members/${encodeURIComponent(id)}`,
|
|
547
|
+
body: params,
|
|
548
|
+
retryable: false,
|
|
549
|
+
options
|
|
550
|
+
});
|
|
551
|
+
}
|
|
552
|
+
/**
|
|
553
|
+
* Remove a member from its membership. Rejected if it is the last member
|
|
554
|
+
* or the sole primary — reassign the primary first with `setPrimary`.
|
|
555
|
+
*/
|
|
556
|
+
remove(id, options) {
|
|
557
|
+
return this.transport.request({
|
|
558
|
+
method: "DELETE",
|
|
559
|
+
path: `/api/v1/members/${encodeURIComponent(id)}`,
|
|
560
|
+
retryable: false,
|
|
561
|
+
options
|
|
562
|
+
});
|
|
563
|
+
}
|
|
564
|
+
/**
|
|
565
|
+
* Make this member the primary of its membership, demoting the current
|
|
566
|
+
* primary atomically. A no-op if it is already primary.
|
|
567
|
+
*/
|
|
568
|
+
setPrimary(id, options) {
|
|
569
|
+
return this.transport.request({
|
|
570
|
+
method: "POST",
|
|
571
|
+
path: `/api/v1/members/${encodeURIComponent(id)}/set-primary`,
|
|
572
|
+
retryable: false,
|
|
573
|
+
options
|
|
574
|
+
});
|
|
575
|
+
}
|
|
538
576
|
/** Issue a fresh card id, invalidating the old card at the gate. */
|
|
539
577
|
reissueCard(id, params = {}, options) {
|
|
540
578
|
return this.transport.request({
|
|
@@ -657,6 +695,20 @@ var MembershipsResource = class extends APIResource {
|
|
|
657
695
|
})).members;
|
|
658
696
|
}
|
|
659
697
|
/**
|
|
698
|
+
* Add a member to an existing membership, up to the plan's max party size.
|
|
699
|
+
* `role` is a member-role code; an optional `email` links the member to a
|
|
700
|
+
* customer record. Rejected on cancelled or expired memberships.
|
|
701
|
+
*/
|
|
702
|
+
addMember(id, params, options) {
|
|
703
|
+
return this.transport.request({
|
|
704
|
+
method: "POST",
|
|
705
|
+
path: `/api/v1/memberships/${encodeURIComponent(id)}/members`,
|
|
706
|
+
body: params,
|
|
707
|
+
retryable: false,
|
|
708
|
+
options
|
|
709
|
+
});
|
|
710
|
+
}
|
|
711
|
+
/**
|
|
660
712
|
* Open the next term. Rejected (409) while cancelled or cancellation-pending.
|
|
661
713
|
* Idempotent: the Idempotency-Key is generated once per call (and reused
|
|
662
714
|
* across the SDK's internal retries), so a retried renewal returns the
|
|
@@ -1218,7 +1270,9 @@ const WEBHOOK_EVENT_CODES = [
|
|
|
1218
1270
|
"membership.downgraded",
|
|
1219
1271
|
"scheduled_change.failed",
|
|
1220
1272
|
"entitlement.used",
|
|
1273
|
+
"member.added",
|
|
1221
1274
|
"member.card_issued",
|
|
1275
|
+
"member.updated",
|
|
1222
1276
|
"member.removed",
|
|
1223
1277
|
"plan.updated"
|
|
1224
1278
|
];
|