@ophelio/sdk 0.2.2 → 0.3.0

package/README.md

@@ -158,7 +158,7 @@ Everything reachable with an API key is covered:
 | `admit`                      | `check({ card })`                                                                                                                                                                                                                                                                                                                                                                            |
 | `members`                    | `sync({ since? })`, `get(id)`, `listEntitlements(id, { type? })`, `update(id, ...)`, `remove(id)`, `setPrimary(id)`, `reissueCard(id, { note? })`                                                                                                                                                                                                                                            |
 | `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, ...)` |
-| `customers`                  | `list(params?)`, `get(id)`, `create(...)`, `update(id, ...)`, `delete(id)`, `listMemberships(id, params?)`                                                                                                                                                                                                                                                                                   |
+| `customers`                  | `list(params?)`, `get(id, params?)`, `create(...)`, `update(id, ...)`, `delete(id)`, `listMemberships(id, params?)` — `list`/`get` accept `view: 'full'` to include `membership_summary`                                                                                                                                                                                                     |
 | `entitlements`               | `redeem(...)`, `recordUsage(...)`, `list()`, `get(id)`, `create(...)`, `update(id, ...)`, `delete(id)`                                                                                                                                                                                                                                                                                       |
 | `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, ...)`                                                                                    |
 | `billingOptions`             | `list()`, `get(id)`, `update(id, ...)`, `delete(id)`, `listSalesChannels(id)`, `createSalesChannelLink(id, ...)`                                                                                                                                                                                                                                                                             |

package/dist/index.cjs

@@ -316,11 +316,17 @@ var BillingOptionsResource = class extends APIResource {
 //#endregion
 //#region src/resources/customers.ts
 var CustomersResource = class extends APIResource {
+	/**
+	* Pass `view: 'full'` to include `membership_summary` on every customer.
+	*/
 	async list(params, options) {
 		const response = await this.transport.request({
 			method: "GET",
 			path: "/api/v1/customers",
-			query: pageQuery(params),
+			query: {
+				...pageQuery(params),
+				...params?.view ? { view: params.view } : {}
+			},
 			retryable: true,
 			options
 		});
@@ -330,10 +336,14 @@ var CustomersResource = class extends APIResource {
 			total_size: response.total_size
 		};
 	}
-	get(id, options) {
+	/**
+	* Pass `view: 'full'` to include `membership_summary`.
+	*/
+	get(id, params = {}, options) {
 		return this.transport.request({
 			method: "GET",
 			path: `/api/v1/customers/${encodeURIComponent(id)}`,
+			query: params.view ? { view: params.view } : void 0,
 			retryable: true,
 			options
 		});

package/dist/index.d.cts

@@ -997,8 +997,10 @@ interface components {
       id: string;
       entity_type: string;
       entity_id: string; /** @enum {string} */
-      action: "create" | "update" | "delete";
-      changes: Record<string, never>;
+      action: "create" | "delete" | "update";
+      changes: {
+        [key: string]: unknown;
+      };
       actor_id: string | null; /** Format: date-time */
       create_time: string;
     };
@@ -1032,12 +1034,12 @@ interface components {
     };
     UpdateProjectSettingsDto: {
       card_id_prefix?: string | null; /** @enum {string|null} */
-      card_id_character_set?: "digits" | "letters" | "alphanumeric_safe" | null;
+      card_id_character_set?: "alphanumeric_safe" | "digits" | "letters" | null;
       card_id_length?: number | null;
       regenerate_card_id_on_term_open?: boolean | null;
       timezone?: string | null;
       default_currency?: string | null; /** @enum {string|null} */
-      display_locale?: "en-GB" | "en-US" | "fr-FR" | "de-DE" | "es-ES" | "it-IT" | "nl-NL" | null;
+      display_locale?: "de-DE" | "en-GB" | "en-US" | "es-ES" | "fr-FR" | "it-IT" | "nl-NL" | null;
     };
     CreateOrganizationDto: {
       slug: string;
@@ -1077,7 +1079,7 @@ interface components {
       description: string;
       max_party_size: number;
       grace_period_duration: number; /** @enum {string} */
-      grace_period_unit: "day" | "week" | "month" | "year"; /** @enum {string} */
+      grace_period_unit: "day" | "month" | "week" | "year"; /** @enum {string} */
       status: "active" | "archived"; /** Format: date-time */
       create_time: string; /** Format: date-time */
       update_time: string;
@@ -1102,7 +1104,7 @@ interface components {
       display_name: string;
       max_party_size: number;
       grace_period_duration: number; /** @enum {string} */
-      grace_period_unit: "day" | "week" | "month" | "year"; /** @enum {string} */
+      grace_period_unit: "day" | "month" | "week" | "year"; /** @enum {string} */
       status: "active" | "archived";
     };
     UpdatePlanDto: {
@@ -1111,14 +1113,14 @@ interface components {
       description: string;
       max_party_size: number;
       grace_period_duration: number; /** @enum {string} */
-      grace_period_unit: "day" | "week" | "month" | "year"; /** @enum {string} */
+      grace_period_unit: "day" | "month" | "week" | "year"; /** @enum {string} */
       status: "active" | "archived";
     };
     BillingOption: {
       id: string;
       plan_id: string;
       unit_amount: number; /** @enum {string} */
-      frequency_unit: "day" | "week" | "month" | "year";
+      frequency_unit: "day" | "month" | "week" | "year";
       frequency_interval: number;
       is_recurring: boolean;
       display_name: string;
@@ -1136,7 +1138,7 @@ interface components {
     };
     CreateBillingOptionForPlanDto: {
       unit_amount: number; /** @enum {string} */
-      frequency_unit: "day" | "week" | "month" | "year";
+      frequency_unit: "day" | "month" | "week" | "year";
       frequency_interval: number;
       is_recurring: boolean;
       display_name: string;
@@ -1154,7 +1156,7 @@ interface components {
     };
     PlanLinkView: {
       id: string; /** @enum {string} */
-      type: "upgrade" | "downgrade";
+      type: "downgrade" | "upgrade";
       plan: components["schemas"]["PlanLinkTargetPlan"];
       require_interval_match: boolean; /** Format: date-time */
       create_time: string; /** Format: date-time */
@@ -1165,7 +1167,7 @@ interface components {
     };
     CreatePlanLinkDto: {
       /** Format: uuid */target_plan_id: string; /** @enum {string} */
-      type: "upgrade" | "downgrade";
+      type: "downgrade" | "upgrade";
       require_interval_match: boolean;
     };
     PlanLink: {
@@ -1178,7 +1180,7 @@ interface components {
     };
     PlanEntitlementDefinition: {
       code: string; /** @enum {string} */
-      type: "free_entry" | "guest_pass" | "discount" | "early_access";
+      type: "discount" | "early_access" | "free_entry" | "guest_pass";
       display_name: string;
     };
     PlanEntitlement: {
@@ -1187,7 +1189,7 @@ interface components {
       entitlement_id: string;
       discount_percentage: number | null;
       quota_limit: number | null; /** @enum {string} */
-      quota_period: "day" | "week" | "month" | "year";
+      quota_period: "day" | "month" | "week" | "year";
       requires_member_present: boolean;
       early_access_days: number | null;
       active_during_grace: boolean; /** Format: date-time */
@@ -1202,7 +1204,7 @@ interface components {
       /** Format: uuid */entitlement_id: string;
       discount_percentage: number;
       quota_limit: number; /** @enum {string} */
-      quota_period: "day" | "week" | "month" | "year";
+      quota_period: "day" | "month" | "week" | "year";
       requires_member_present: boolean;
       early_access_days: number;
       active_during_grace: boolean;
@@ -1280,7 +1282,7 @@ interface components {
     UpdatePlanEntitlementDto: {
       discount_percentage: number;
       quota_limit: number; /** @enum {string} */
-      quota_period: "day" | "week" | "month" | "year";
+      quota_period: "day" | "month" | "week" | "year";
       requires_member_present: boolean;
       early_access_days: number;
       active_during_grace: boolean;
@@ -1289,7 +1291,7 @@ interface components {
       id: string;
       code: string;
       display_name: string; /** @enum {string} */
-      type: "free_entry" | "guest_pass" | "discount" | "early_access";
+      type: "discount" | "early_access" | "free_entry" | "guest_pass";
       target: string | null;
       description: string | null; /** Format: date-time */
       create_time: string; /** Format: date-time */
@@ -1313,7 +1315,9 @@ interface components {
       entitlement_code: string;
       members: string[];
       used_time?: string;
-      context: Record<string, never>;
+      context: {
+        [key: string]: unknown;
+      };
     };
     EntitlementUsage: {
       id: string;
@@ -1321,7 +1325,9 @@ interface components {
       member_id: string;
       plan_entitlement_id: string; /** Format: date-time */
       used_time: string;
-      context: Record<string, never> | null;
+      context: {
+        [key: string]: unknown;
+      } | null;
       idempotency_key: string; /** Format: date-time */
       create_time: string;
     };
@@ -1331,7 +1337,7 @@ interface components {
     CreateEntitlementDto: {
       code: string;
       display_name: string; /** @enum {string} */
-      type: "free_entry" | "guest_pass" | "discount" | "early_access";
+      type: "discount" | "early_access" | "free_entry" | "guest_pass";
       target: string;
       description: string;
     };
@@ -1381,13 +1387,13 @@ interface components {
     };
     MemberEntitlement: {
       code: string; /** @enum {string} */
-      type: "free_entry" | "guest_pass" | "discount" | "early_access";
+      type: "discount" | "early_access" | "free_entry" | "guest_pass";
       target: string | null;
       display_name: string;
       plan_entitlement_id: string;
       discount_percentage: number | null;
       quota_limit: number | null; /** @enum {string} */
-      quota_period: "day" | "week" | "month" | "year";
+      quota_period: "day" | "month" | "week" | "year";
       requires_member_present: boolean;
       early_access_days: number | null;
       active_during_grace: boolean;
@@ -1419,10 +1425,10 @@ interface components {
         reason: string;
       })[];
       admitted: boolean; /** @enum {string|null} */
-      deny_reason: "membership_cancelled" | "membership_expired" | "membership_incomplete" | "payment_overdue" | "card_not_found" | "member_removed" | null;
+      deny_reason: "card_not_found" | "member_removed" | "membership_cancelled" | "membership_expired" | "membership_incomplete" | "payment_overdue" | null;
       member: components["schemas"]["AdmitMember"] | null;
       membership_id: string | null; /** @enum {string|null} */
-      membership_status: "cancelled" | "incomplete" | "active" | "expired" | "past_due" | "grace_period" | null;
+      membership_status: "active" | "cancelled" | "expired" | "grace_period" | "incomplete" | "past_due" | null;
       plan: string | null;
       pricing_group: string | null;
       entitlements: components["schemas"]["MemberEntitlement"][];
@@ -1470,8 +1476,10 @@ interface components {
       id: string;
       subscription_id: string;
       event_type: string;
-      payload: Record<string, never>; /** @enum {string} */
-      status: "failed" | "pending" | "delivered" | "exhausted";
+      payload: {
+        [key: string]: unknown;
+      }; /** @enum {string} */
+      status: "delivered" | "exhausted" | "failed" | "pending";
       attempts: number; /** Format: date-time */
       last_attempt_time: string | null; /** Format: date-time */
       next_retry_time: string | null;
@@ -1538,7 +1546,7 @@ interface components {
       display_name: string;
       unit_amount: number;
       currency: string; /** @enum {string} */
-      frequency_unit: "day" | "week" | "month" | "year";
+      frequency_unit: "day" | "month" | "week" | "year";
       frequency_interval: number;
     };
     MembershipTerm: {
@@ -1561,7 +1569,7 @@ interface components {
       customer_id: string | null; /** Format: date-time */
       start_time: string; /** Format: date-time */
       end_time: string | null; /** @enum {string} */
-      status: "cancelled" | "incomplete" | "active" | "expired" | "past_due" | "grace_period"; /** Format: date-time */
+      status: "active" | "cancelled" | "expired" | "grace_period" | "incomplete" | "past_due"; /** Format: date-time */
       grace_until: string | null;
       auto_renew: boolean;
       current_term_id: string | null; /** Format: date-time */
@@ -1625,7 +1633,7 @@ interface components {
     CancelMembershipDto: {
       cancellation_reason?: string;
       effective_time?: string; /** @enum {string} */
-      effective_type?: "immediate" | "end_of_term" | "at";
+      effective_type?: "at" | "end_of_term" | "immediate";
     };
     RenewMembershipDto: {
       transaction?: components["schemas"]["CreateMembershipTransactionDto"];
@@ -1640,13 +1648,13 @@ interface components {
     };
     PlanChangeDto: {
       /** Format: uuid */new_billing_option_id: string; /** @enum {string} */
-      effective_type?: "immediate" | "end_of_term";
+      effective_type?: "end_of_term" | "immediate";
       members?: components["schemas"]["PlanChangeMemberDto"][];
       note?: string;
     };
     MembershipScheduledChangeMemberResponseDto: {
       id: string; /** @enum {string} */
-      operation: "update" | "add" | "remove";
+      operation: "add" | "remove" | "update";
       member_id: string | null;
       name: string | null;
       role_id: string | null;
@@ -1655,16 +1663,16 @@ interface components {
     };
     MembershipScheduledChangeResponseDto: {
       id: string; /** @enum {string} */
-      type: "upgrade" | "downgrade"; /** Format: date-time */
+      type: "downgrade" | "upgrade"; /** Format: date-time */
       effective_time: string; /** @enum {string} */
-      status: "failed" | "cancelled" | "pending" | "applied" | "superseded";
+      status: "applied" | "cancelled" | "failed" | "pending" | "superseded";
       new_billing_option_id: string;
       applied_term_id: string | null;
       failure_reason: string | null;
       superseded_by_id: string | null;
       note: string | null;
       created_by: string | null; /** @enum {string} */
-      source: "system" | "admin_ui" | "customer_self_service" | "api";
+      source: "admin_ui" | "api" | "customer_self_service" | "system";
       members: components["schemas"]["MembershipScheduledChangeMemberResponseDto"][]; /** Format: date-time */
       create_time: string; /** Format: date-time */
       apply_time: string | null;
@@ -1691,8 +1699,8 @@ interface components {
       id: string;
       membership_id: string;
       membership_term_id: string; /** @enum {string} */
-      type: "payment" | "refund" | "credit" | "chargeback" | "adjustment"; /** @enum {string} */
-      status: "failed" | "succeeded" | "refunded";
+      type: "adjustment" | "chargeback" | "credit" | "payment" | "refund"; /** @enum {string} */
+      status: "failed" | "refunded" | "succeeded";
       amount_cents: number;
       currency: string;
       payment_method_ref: string | null;
@@ -1718,8 +1726,8 @@ interface components {
       transactions: components["schemas"]["Transaction"][];
     };
     CreateTransactionDto: {
-      /** @enum {string} */type: "payment" | "refund" | "credit" | "chargeback" | "adjustment"; /** @enum {string} */
-      status: "succeeded" | "failed" | "refunded";
+      /** @enum {string} */type: "adjustment" | "chargeback" | "credit" | "payment" | "refund"; /** @enum {string} */
+      status: "failed" | "refunded" | "succeeded";
       amount_cents: number;
       currency?: string; /** Format: uuid */
       membership_term_id?: string;
@@ -1730,12 +1738,17 @@ interface components {
       failure_reason?: string;
       processed_time?: string;
     };
+    CustomerMembershipSummary: {
+      /** @description Memberships linked to the customer, as buyer or through a member row. */total_count: number; /** @description Linked memberships whose status is active or grace_period. */
+      active_count: number;
+    };
     Customer: {
       id: string;
       name: string;
       email: string; /** Format: date-time */
       create_time: string; /** Format: date-time */
       update_time: string;
+      membership_summary?: components["schemas"]["CustomerMembershipSummary"];
     };
     ListCustomersResponse: {
       /**
@@ -3222,7 +3235,7 @@ interface operations {
   MembersController_listEntitlements: {
     parameters: {
       query?: {
-        type?: "free_entry" | "guest_pass" | "discount" | "early_access";
+        type?: "discount" | "early_access" | "free_entry" | "guest_pass";
       };
       header?: never;
       path?: never;
@@ -4107,7 +4120,7 @@ interface operations {
       query?: {
         page_size?: number;
         page_token?: string;
-        status?: ("pending" | "applied" | "cancelled" | "superseded" | "failed" | "all")[];
+        status?: ("all" | "applied" | "cancelled" | "failed" | "pending" | "superseded")[];
       };
       header?: never;
       path?: never;
@@ -4255,7 +4268,8 @@ interface operations {
     parameters: {
       query?: {
         page_size?: number;
-        page_token?: string;
+        page_token?: string; /** @description Response detail level; `full` populates `membership_summary`. */
+        view?: "basic" | "full";
       };
       header?: never;
       path?: never;
@@ -4306,7 +4320,9 @@ interface operations {
   };
   CustomersController_get: {
     parameters: {
-      query?: never;
+      query?: {
+        /** @description Response detail level; `full` populates `membership_summary`. */view?: "basic" | "full";
+      };
       header?: never;
       path?: never;
       cookie?: never;
@@ -4561,6 +4577,7 @@ type BillingOption = Schemas['BillingOption'];
 type Membership = Schemas['Membership'];
 type MembershipTerm = Schemas['MembershipTerm'];
 type Customer = Schemas['Customer'];
+type CustomerMembershipSummary = Schemas['CustomerMembershipSummary'];
 type Member = Schemas['Member'];
 type SyncMember = Schemas['SyncMember'];
 type MemberEntitlement = Schemas['MemberEntitlement'];
@@ -4582,6 +4599,7 @@ type ScheduledChange = Schemas['MembershipScheduledChangeResponseDto'];
 type PlanChangeResult = Schemas['PlanChangeResponseDto'];
 type MemberSyncResponse = Schemas['MemberSyncResponse'];
 type RedeemEntitlementResponse = Schemas['RedeemEntitlementResponseDto'];
+type CustomerView = 'basic' | 'full';
 interface PageParams {
   /** Rows per page. Server default 50; capped at 250. */
   page_size?: number;
@@ -4661,8 +4679,18 @@ declare class BillingOptionsResource extends APIResource {
 //#endregion
 //#region src/resources/customers.d.ts
 declare class CustomersResource extends APIResource {
-  list(params?: PageParams, options?: RequestOptions): Promise<Page<Customer>>;
-  get(id: string, options?: RequestOptions): Promise<Customer>;
+  /**
+   * Pass `view: 'full'` to include `membership_summary` on every customer.
+   */
+  list(params?: PageParams & {
+    view?: CustomerView;
+  }, options?: RequestOptions): Promise<Page<Customer>>;
+  /**
+   * Pass `view: 'full'` to include `membership_summary`.
+   */
+  get(id: string, params?: {
+    view?: CustomerView;
+  }, options?: RequestOptions): Promise<Customer>;
   create(params: CreateCustomerParams, options?: RequestOptions): Promise<Customer>;
   update(id: string, params: UpdateCustomerParams, options?: RequestOptions): Promise<Customer>;
   delete(id: string, options?: RequestOptions): Promise<void>;
@@ -4997,4 +5025,4 @@ declare function paginate<T>(fetchPage: (params: PageParams) => Promise<Page<T>>
  */
 declare function collect<T>(fetchPage: (params: PageParams) => Promise<Page<T>>, params?: PageParams): Promise<T[]>;
 //#endregion
-export { AddMemberParams, AdmitResult, AlreadyExistsError, BillingOption, BillingOptionSalesChannel, CancelMembershipParams, CreateBillingOptionParams, CreateBillingOptionSalesChannelParams, CreateCustomerParams, CreateEntitlementParams, CreateMemberRoleParams, CreateMembershipParams, CreatePlanEntitlementParams, CreatePlanLinkParams, CreatePlanParams, CreatePlanPricingGroupMappingParams, CreatePricingGroupParams, CreateSalesChannelParams, CreateTransactionParams, CreateWebhookSubscriptionParams, Customer, DEFAULT_BASE_URL, Entitlement, EntitlementType, EntitlementUsage, type IdempotentRequestOptions, InternalError, InvalidArgumentError, Member, MemberEntitlement, MemberRole, MemberSyncResponse, Membership, MembershipTerm, NotFoundError, Ophelio, OphelioConnectionError, OphelioError, type OphelioOptions, OphelioTimeoutError, type OphelioWebhookEvent, Page, PageParams, PermissionDeniedError, Plan, PlanChangeParams, PlanChangeResult, PlanEntitlement, PlanLink, PlanLinkView, PlanPricingGroupMapping, PricingGroup, RecordUsageParams, RedeemEntitlementParams, RedeemEntitlementResponse, ReissueCardParams, RenewMembershipParams, type RequestOptions, ResourceExhaustedError, SalesChannel, ScheduledChange, SyncMember, Transaction, UnauthenticatedError, UnavailableError, UnimplementedError, UpdateBillingOptionParams, UpdateCustomerParams, UpdateEntitlementParams, UpdateMemberParams, UpdateMemberRoleParams, UpdateMembershipParams, UpdatePlanEntitlementParams, UpdatePlanParams, UpdatePricingGroupParams, UpdateSalesChannelParams, UpdateWebhookSubscriptionParams, WEBHOOK_EVENT_CODES, WebhookDelivery, type WebhookEventCode, WebhookSignatureVerificationError, WebhookSubscription, collect, type components, constructEvent, type operations, paginate, type paths, verifyWebhookSignature };
+export { AddMemberParams, AdmitResult, AlreadyExistsError, BillingOption, BillingOptionSalesChannel, CancelMembershipParams, CreateBillingOptionParams, CreateBillingOptionSalesChannelParams, CreateCustomerParams, CreateEntitlementParams, CreateMemberRoleParams, CreateMembershipParams, CreatePlanEntitlementParams, CreatePlanLinkParams, CreatePlanParams, CreatePlanPricingGroupMappingParams, CreatePricingGroupParams, CreateSalesChannelParams, CreateTransactionParams, CreateWebhookSubscriptionParams, Customer, CustomerMembershipSummary, CustomerView, DEFAULT_BASE_URL, Entitlement, EntitlementType, EntitlementUsage, type IdempotentRequestOptions, InternalError, InvalidArgumentError, Member, MemberEntitlement, MemberRole, MemberSyncResponse, Membership, MembershipTerm, NotFoundError, Ophelio, OphelioConnectionError, OphelioError, type OphelioOptions, OphelioTimeoutError, type OphelioWebhookEvent, Page, PageParams, PermissionDeniedError, Plan, PlanChangeParams, PlanChangeResult, PlanEntitlement, PlanLink, PlanLinkView, PlanPricingGroupMapping, PricingGroup, RecordUsageParams, RedeemEntitlementParams, RedeemEntitlementResponse, ReissueCardParams, RenewMembershipParams, type RequestOptions, ResourceExhaustedError, SalesChannel, ScheduledChange, SyncMember, Transaction, UnauthenticatedError, UnavailableError, UnimplementedError, UpdateBillingOptionParams, UpdateCustomerParams, UpdateEntitlementParams, UpdateMemberParams, UpdateMemberRoleParams, UpdateMembershipParams, UpdatePlanEntitlementParams, UpdatePlanParams, UpdatePricingGroupParams, UpdateSalesChannelParams, UpdateWebhookSubscriptionParams, WEBHOOK_EVENT_CODES, WebhookDelivery, type WebhookEventCode, WebhookSignatureVerificationError, WebhookSubscription, collect, type components, constructEvent, type operations, paginate, type paths, verifyWebhookSignature };

package/dist/index.d.mts

@@ -997,8 +997,10 @@ interface components {
       id: string;
       entity_type: string;
       entity_id: string; /** @enum {string} */
-      action: "create" | "update" | "delete";
-      changes: Record<string, never>;
+      action: "create" | "delete" | "update";
+      changes: {
+        [key: string]: unknown;
+      };
       actor_id: string | null; /** Format: date-time */
       create_time: string;
     };
@@ -1032,12 +1034,12 @@ interface components {
     };
     UpdateProjectSettingsDto: {
       card_id_prefix?: string | null; /** @enum {string|null} */
-      card_id_character_set?: "digits" | "letters" | "alphanumeric_safe" | null;
+      card_id_character_set?: "alphanumeric_safe" | "digits" | "letters" | null;
       card_id_length?: number | null;
       regenerate_card_id_on_term_open?: boolean | null;
       timezone?: string | null;
       default_currency?: string | null; /** @enum {string|null} */
-      display_locale?: "en-GB" | "en-US" | "fr-FR" | "de-DE" | "es-ES" | "it-IT" | "nl-NL" | null;
+      display_locale?: "de-DE" | "en-GB" | "en-US" | "es-ES" | "fr-FR" | "it-IT" | "nl-NL" | null;
     };
     CreateOrganizationDto: {
       slug: string;
@@ -1077,7 +1079,7 @@ interface components {
       description: string;
       max_party_size: number;
       grace_period_duration: number; /** @enum {string} */
-      grace_period_unit: "day" | "week" | "month" | "year"; /** @enum {string} */
+      grace_period_unit: "day" | "month" | "week" | "year"; /** @enum {string} */
       status: "active" | "archived"; /** Format: date-time */
       create_time: string; /** Format: date-time */
       update_time: string;
@@ -1102,7 +1104,7 @@ interface components {
       display_name: string;
       max_party_size: number;
       grace_period_duration: number; /** @enum {string} */
-      grace_period_unit: "day" | "week" | "month" | "year"; /** @enum {string} */
+      grace_period_unit: "day" | "month" | "week" | "year"; /** @enum {string} */
       status: "active" | "archived";
     };
     UpdatePlanDto: {
@@ -1111,14 +1113,14 @@ interface components {
       description: string;
       max_party_size: number;
       grace_period_duration: number; /** @enum {string} */
-      grace_period_unit: "day" | "week" | "month" | "year"; /** @enum {string} */
+      grace_period_unit: "day" | "month" | "week" | "year"; /** @enum {string} */
       status: "active" | "archived";
     };
     BillingOption: {
       id: string;
       plan_id: string;
       unit_amount: number; /** @enum {string} */
-      frequency_unit: "day" | "week" | "month" | "year";
+      frequency_unit: "day" | "month" | "week" | "year";
       frequency_interval: number;
       is_recurring: boolean;
       display_name: string;
@@ -1136,7 +1138,7 @@ interface components {
     };
     CreateBillingOptionForPlanDto: {
       unit_amount: number; /** @enum {string} */
-      frequency_unit: "day" | "week" | "month" | "year";
+      frequency_unit: "day" | "month" | "week" | "year";
       frequency_interval: number;
       is_recurring: boolean;
       display_name: string;
@@ -1154,7 +1156,7 @@ interface components {
     };
     PlanLinkView: {
       id: string; /** @enum {string} */
-      type: "upgrade" | "downgrade";
+      type: "downgrade" | "upgrade";
       plan: components["schemas"]["PlanLinkTargetPlan"];
       require_interval_match: boolean; /** Format: date-time */
       create_time: string; /** Format: date-time */
@@ -1165,7 +1167,7 @@ interface components {
     };
     CreatePlanLinkDto: {
       /** Format: uuid */target_plan_id: string; /** @enum {string} */
-      type: "upgrade" | "downgrade";
+      type: "downgrade" | "upgrade";
       require_interval_match: boolean;
     };
     PlanLink: {
@@ -1178,7 +1180,7 @@ interface components {
     };
     PlanEntitlementDefinition: {
       code: string; /** @enum {string} */
-      type: "free_entry" | "guest_pass" | "discount" | "early_access";
+      type: "discount" | "early_access" | "free_entry" | "guest_pass";
       display_name: string;
     };
     PlanEntitlement: {
@@ -1187,7 +1189,7 @@ interface components {
       entitlement_id: string;
       discount_percentage: number | null;
       quota_limit: number | null; /** @enum {string} */
-      quota_period: "day" | "week" | "month" | "year";
+      quota_period: "day" | "month" | "week" | "year";
       requires_member_present: boolean;
       early_access_days: number | null;
       active_during_grace: boolean; /** Format: date-time */
@@ -1202,7 +1204,7 @@ interface components {
       /** Format: uuid */entitlement_id: string;
       discount_percentage: number;
       quota_limit: number; /** @enum {string} */
-      quota_period: "day" | "week" | "month" | "year";
+      quota_period: "day" | "month" | "week" | "year";
       requires_member_present: boolean;
       early_access_days: number;
       active_during_grace: boolean;
@@ -1280,7 +1282,7 @@ interface components {
     UpdatePlanEntitlementDto: {
       discount_percentage: number;
       quota_limit: number; /** @enum {string} */
-      quota_period: "day" | "week" | "month" | "year";
+      quota_period: "day" | "month" | "week" | "year";
       requires_member_present: boolean;
       early_access_days: number;
       active_during_grace: boolean;
@@ -1289,7 +1291,7 @@ interface components {
       id: string;
       code: string;
       display_name: string; /** @enum {string} */
-      type: "free_entry" | "guest_pass" | "discount" | "early_access";
+      type: "discount" | "early_access" | "free_entry" | "guest_pass";
       target: string | null;
       description: string | null; /** Format: date-time */
       create_time: string; /** Format: date-time */
@@ -1313,7 +1315,9 @@ interface components {
       entitlement_code: string;
       members: string[];
       used_time?: string;
-      context: Record<string, never>;
+      context: {
+        [key: string]: unknown;
+      };
     };
     EntitlementUsage: {
       id: string;
@@ -1321,7 +1325,9 @@ interface components {
       member_id: string;
       plan_entitlement_id: string; /** Format: date-time */
       used_time: string;
-      context: Record<string, never> | null;
+      context: {
+        [key: string]: unknown;
+      } | null;
       idempotency_key: string; /** Format: date-time */
       create_time: string;
     };
@@ -1331,7 +1337,7 @@ interface components {
     CreateEntitlementDto: {
       code: string;
       display_name: string; /** @enum {string} */
-      type: "free_entry" | "guest_pass" | "discount" | "early_access";
+      type: "discount" | "early_access" | "free_entry" | "guest_pass";
       target: string;
       description: string;
     };
@@ -1381,13 +1387,13 @@ interface components {
     };
     MemberEntitlement: {
       code: string; /** @enum {string} */
-      type: "free_entry" | "guest_pass" | "discount" | "early_access";
+      type: "discount" | "early_access" | "free_entry" | "guest_pass";
       target: string | null;
       display_name: string;
       plan_entitlement_id: string;
       discount_percentage: number | null;
       quota_limit: number | null; /** @enum {string} */
-      quota_period: "day" | "week" | "month" | "year";
+      quota_period: "day" | "month" | "week" | "year";
       requires_member_present: boolean;
       early_access_days: number | null;
       active_during_grace: boolean;
@@ -1419,10 +1425,10 @@ interface components {
         reason: string;
       })[];
       admitted: boolean; /** @enum {string|null} */
-      deny_reason: "membership_cancelled" | "membership_expired" | "membership_incomplete" | "payment_overdue" | "card_not_found" | "member_removed" | null;
+      deny_reason: "card_not_found" | "member_removed" | "membership_cancelled" | "membership_expired" | "membership_incomplete" | "payment_overdue" | null;
       member: components["schemas"]["AdmitMember"] | null;
       membership_id: string | null; /** @enum {string|null} */
-      membership_status: "cancelled" | "incomplete" | "active" | "expired" | "past_due" | "grace_period" | null;
+      membership_status: "active" | "cancelled" | "expired" | "grace_period" | "incomplete" | "past_due" | null;
       plan: string | null;
       pricing_group: string | null;
       entitlements: components["schemas"]["MemberEntitlement"][];
@@ -1470,8 +1476,10 @@ interface components {
       id: string;
       subscription_id: string;
       event_type: string;
-      payload: Record<string, never>; /** @enum {string} */
-      status: "failed" | "pending" | "delivered" | "exhausted";
+      payload: {
+        [key: string]: unknown;
+      }; /** @enum {string} */
+      status: "delivered" | "exhausted" | "failed" | "pending";
       attempts: number; /** Format: date-time */
       last_attempt_time: string | null; /** Format: date-time */
       next_retry_time: string | null;
@@ -1538,7 +1546,7 @@ interface components {
       display_name: string;
       unit_amount: number;
       currency: string; /** @enum {string} */
-      frequency_unit: "day" | "week" | "month" | "year";
+      frequency_unit: "day" | "month" | "week" | "year";
       frequency_interval: number;
     };
     MembershipTerm: {
@@ -1561,7 +1569,7 @@ interface components {
       customer_id: string | null; /** Format: date-time */
       start_time: string; /** Format: date-time */
       end_time: string | null; /** @enum {string} */
-      status: "cancelled" | "incomplete" | "active" | "expired" | "past_due" | "grace_period"; /** Format: date-time */
+      status: "active" | "cancelled" | "expired" | "grace_period" | "incomplete" | "past_due"; /** Format: date-time */
       grace_until: string | null;
       auto_renew: boolean;
       current_term_id: string | null; /** Format: date-time */
@@ -1625,7 +1633,7 @@ interface components {
     CancelMembershipDto: {
       cancellation_reason?: string;
       effective_time?: string; /** @enum {string} */
-      effective_type?: "immediate" | "end_of_term" | "at";
+      effective_type?: "at" | "end_of_term" | "immediate";
     };
     RenewMembershipDto: {
       transaction?: components["schemas"]["CreateMembershipTransactionDto"];
@@ -1640,13 +1648,13 @@ interface components {
     };
     PlanChangeDto: {
       /** Format: uuid */new_billing_option_id: string; /** @enum {string} */
-      effective_type?: "immediate" | "end_of_term";
+      effective_type?: "end_of_term" | "immediate";
       members?: components["schemas"]["PlanChangeMemberDto"][];
       note?: string;
     };
     MembershipScheduledChangeMemberResponseDto: {
       id: string; /** @enum {string} */
-      operation: "update" | "add" | "remove";
+      operation: "add" | "remove" | "update";
       member_id: string | null;
       name: string | null;
       role_id: string | null;
@@ -1655,16 +1663,16 @@ interface components {
     };
     MembershipScheduledChangeResponseDto: {
       id: string; /** @enum {string} */
-      type: "upgrade" | "downgrade"; /** Format: date-time */
+      type: "downgrade" | "upgrade"; /** Format: date-time */
       effective_time: string; /** @enum {string} */
-      status: "failed" | "cancelled" | "pending" | "applied" | "superseded";
+      status: "applied" | "cancelled" | "failed" | "pending" | "superseded";
       new_billing_option_id: string;
       applied_term_id: string | null;
       failure_reason: string | null;
       superseded_by_id: string | null;
       note: string | null;
       created_by: string | null; /** @enum {string} */
-      source: "system" | "admin_ui" | "customer_self_service" | "api";
+      source: "admin_ui" | "api" | "customer_self_service" | "system";
       members: components["schemas"]["MembershipScheduledChangeMemberResponseDto"][]; /** Format: date-time */
       create_time: string; /** Format: date-time */
       apply_time: string | null;
@@ -1691,8 +1699,8 @@ interface components {
       id: string;
       membership_id: string;
       membership_term_id: string; /** @enum {string} */
-      type: "payment" | "refund" | "credit" | "chargeback" | "adjustment"; /** @enum {string} */
-      status: "failed" | "succeeded" | "refunded";
+      type: "adjustment" | "chargeback" | "credit" | "payment" | "refund"; /** @enum {string} */
+      status: "failed" | "refunded" | "succeeded";
       amount_cents: number;
       currency: string;
       payment_method_ref: string | null;
@@ -1718,8 +1726,8 @@ interface components {
       transactions: components["schemas"]["Transaction"][];
     };
     CreateTransactionDto: {
-      /** @enum {string} */type: "payment" | "refund" | "credit" | "chargeback" | "adjustment"; /** @enum {string} */
-      status: "succeeded" | "failed" | "refunded";
+      /** @enum {string} */type: "adjustment" | "chargeback" | "credit" | "payment" | "refund"; /** @enum {string} */
+      status: "failed" | "refunded" | "succeeded";
       amount_cents: number;
       currency?: string; /** Format: uuid */
       membership_term_id?: string;
@@ -1730,12 +1738,17 @@ interface components {
       failure_reason?: string;
       processed_time?: string;
     };
+    CustomerMembershipSummary: {
+      /** @description Memberships linked to the customer, as buyer or through a member row. */total_count: number; /** @description Linked memberships whose status is active or grace_period. */
+      active_count: number;
+    };
     Customer: {
       id: string;
       name: string;
       email: string; /** Format: date-time */
       create_time: string; /** Format: date-time */
       update_time: string;
+      membership_summary?: components["schemas"]["CustomerMembershipSummary"];
     };
     ListCustomersResponse: {
       /**
@@ -3222,7 +3235,7 @@ interface operations {
   MembersController_listEntitlements: {
     parameters: {
       query?: {
-        type?: "free_entry" | "guest_pass" | "discount" | "early_access";
+        type?: "discount" | "early_access" | "free_entry" | "guest_pass";
       };
       header?: never;
       path?: never;
@@ -4107,7 +4120,7 @@ interface operations {
       query?: {
         page_size?: number;
         page_token?: string;
-        status?: ("pending" | "applied" | "cancelled" | "superseded" | "failed" | "all")[];
+        status?: ("all" | "applied" | "cancelled" | "failed" | "pending" | "superseded")[];
       };
       header?: never;
       path?: never;
@@ -4255,7 +4268,8 @@ interface operations {
     parameters: {
       query?: {
         page_size?: number;
-        page_token?: string;
+        page_token?: string; /** @description Response detail level; `full` populates `membership_summary`. */
+        view?: "basic" | "full";
       };
       header?: never;
       path?: never;
@@ -4306,7 +4320,9 @@ interface operations {
   };
   CustomersController_get: {
     parameters: {
-      query?: never;
+      query?: {
+        /** @description Response detail level; `full` populates `membership_summary`. */view?: "basic" | "full";
+      };
       header?: never;
       path?: never;
       cookie?: never;
@@ -4561,6 +4577,7 @@ type BillingOption = Schemas['BillingOption'];
 type Membership = Schemas['Membership'];
 type MembershipTerm = Schemas['MembershipTerm'];
 type Customer = Schemas['Customer'];
+type CustomerMembershipSummary = Schemas['CustomerMembershipSummary'];
 type Member = Schemas['Member'];
 type SyncMember = Schemas['SyncMember'];
 type MemberEntitlement = Schemas['MemberEntitlement'];
@@ -4582,6 +4599,7 @@ type ScheduledChange = Schemas['MembershipScheduledChangeResponseDto'];
 type PlanChangeResult = Schemas['PlanChangeResponseDto'];
 type MemberSyncResponse = Schemas['MemberSyncResponse'];
 type RedeemEntitlementResponse = Schemas['RedeemEntitlementResponseDto'];
+type CustomerView = 'basic' | 'full';
 interface PageParams {
   /** Rows per page. Server default 50; capped at 250. */
   page_size?: number;
@@ -4661,8 +4679,18 @@ declare class BillingOptionsResource extends APIResource {
 //#endregion
 //#region src/resources/customers.d.ts
 declare class CustomersResource extends APIResource {
-  list(params?: PageParams, options?: RequestOptions): Promise<Page<Customer>>;
-  get(id: string, options?: RequestOptions): Promise<Customer>;
+  /**
+   * Pass `view: 'full'` to include `membership_summary` on every customer.
+   */
+  list(params?: PageParams & {
+    view?: CustomerView;
+  }, options?: RequestOptions): Promise<Page<Customer>>;
+  /**
+   * Pass `view: 'full'` to include `membership_summary`.
+   */
+  get(id: string, params?: {
+    view?: CustomerView;
+  }, options?: RequestOptions): Promise<Customer>;
   create(params: CreateCustomerParams, options?: RequestOptions): Promise<Customer>;
   update(id: string, params: UpdateCustomerParams, options?: RequestOptions): Promise<Customer>;
   delete(id: string, options?: RequestOptions): Promise<void>;
@@ -4997,4 +5025,4 @@ declare function paginate<T>(fetchPage: (params: PageParams) => Promise<Page<T>>
  */
 declare function collect<T>(fetchPage: (params: PageParams) => Promise<Page<T>>, params?: PageParams): Promise<T[]>;
 //#endregion
-export { AddMemberParams, AdmitResult, AlreadyExistsError, BillingOption, BillingOptionSalesChannel, CancelMembershipParams, CreateBillingOptionParams, CreateBillingOptionSalesChannelParams, CreateCustomerParams, CreateEntitlementParams, CreateMemberRoleParams, CreateMembershipParams, CreatePlanEntitlementParams, CreatePlanLinkParams, CreatePlanParams, CreatePlanPricingGroupMappingParams, CreatePricingGroupParams, CreateSalesChannelParams, CreateTransactionParams, CreateWebhookSubscriptionParams, Customer, DEFAULT_BASE_URL, Entitlement, EntitlementType, EntitlementUsage, type IdempotentRequestOptions, InternalError, InvalidArgumentError, Member, MemberEntitlement, MemberRole, MemberSyncResponse, Membership, MembershipTerm, NotFoundError, Ophelio, OphelioConnectionError, OphelioError, type OphelioOptions, OphelioTimeoutError, type OphelioWebhookEvent, Page, PageParams, PermissionDeniedError, Plan, PlanChangeParams, PlanChangeResult, PlanEntitlement, PlanLink, PlanLinkView, PlanPricingGroupMapping, PricingGroup, RecordUsageParams, RedeemEntitlementParams, RedeemEntitlementResponse, ReissueCardParams, RenewMembershipParams, type RequestOptions, ResourceExhaustedError, SalesChannel, ScheduledChange, SyncMember, Transaction, UnauthenticatedError, UnavailableError, UnimplementedError, UpdateBillingOptionParams, UpdateCustomerParams, UpdateEntitlementParams, UpdateMemberParams, UpdateMemberRoleParams, UpdateMembershipParams, UpdatePlanEntitlementParams, UpdatePlanParams, UpdatePricingGroupParams, UpdateSalesChannelParams, UpdateWebhookSubscriptionParams, WEBHOOK_EVENT_CODES, WebhookDelivery, type WebhookEventCode, WebhookSignatureVerificationError, WebhookSubscription, collect, type components, constructEvent, type operations, paginate, type paths, verifyWebhookSignature };
+export { AddMemberParams, AdmitResult, AlreadyExistsError, BillingOption, BillingOptionSalesChannel, CancelMembershipParams, CreateBillingOptionParams, CreateBillingOptionSalesChannelParams, CreateCustomerParams, CreateEntitlementParams, CreateMemberRoleParams, CreateMembershipParams, CreatePlanEntitlementParams, CreatePlanLinkParams, CreatePlanParams, CreatePlanPricingGroupMappingParams, CreatePricingGroupParams, CreateSalesChannelParams, CreateTransactionParams, CreateWebhookSubscriptionParams, Customer, CustomerMembershipSummary, CustomerView, DEFAULT_BASE_URL, Entitlement, EntitlementType, EntitlementUsage, type IdempotentRequestOptions, InternalError, InvalidArgumentError, Member, MemberEntitlement, MemberRole, MemberSyncResponse, Membership, MembershipTerm, NotFoundError, Ophelio, OphelioConnectionError, OphelioError, type OphelioOptions, OphelioTimeoutError, type OphelioWebhookEvent, Page, PageParams, PermissionDeniedError, Plan, PlanChangeParams, PlanChangeResult, PlanEntitlement, PlanLink, PlanLinkView, PlanPricingGroupMapping, PricingGroup, RecordUsageParams, RedeemEntitlementParams, RedeemEntitlementResponse, ReissueCardParams, RenewMembershipParams, type RequestOptions, ResourceExhaustedError, SalesChannel, ScheduledChange, SyncMember, Transaction, UnauthenticatedError, UnavailableError, UnimplementedError, UpdateBillingOptionParams, UpdateCustomerParams, UpdateEntitlementParams, UpdateMemberParams, UpdateMemberRoleParams, UpdateMembershipParams, UpdatePlanEntitlementParams, UpdatePlanParams, UpdatePricingGroupParams, UpdateSalesChannelParams, UpdateWebhookSubscriptionParams, WEBHOOK_EVENT_CODES, WebhookDelivery, type WebhookEventCode, WebhookSignatureVerificationError, WebhookSubscription, collect, type components, constructEvent, type operations, paginate, type paths, verifyWebhookSignature };

package/dist/index.mjs

@@ -315,11 +315,17 @@ var BillingOptionsResource = class extends APIResource {
 //#endregion
 //#region src/resources/customers.ts
 var CustomersResource = class extends APIResource {
+	/**
+	* Pass `view: 'full'` to include `membership_summary` on every customer.
+	*/
 	async list(params, options) {
 		const response = await this.transport.request({
 			method: "GET",
 			path: "/api/v1/customers",
-			query: pageQuery(params),
+			query: {
+				...pageQuery(params),
+				...params?.view ? { view: params.view } : {}
+			},
 			retryable: true,
 			options
 		});
@@ -329,10 +335,14 @@ var CustomersResource = class extends APIResource {
 			total_size: response.total_size
 		};
 	}
-	get(id, options) {
+	/**
+	* Pass `view: 'full'` to include `membership_summary`.
+	*/
+	get(id, params = {}, options) {
 		return this.transport.request({
 			method: "GET",
 			path: `/api/v1/customers/${encodeURIComponent(id)}`,
+			query: params.view ? { view: params.view } : void 0,
 			retryable: true,
 			options
 		});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ophelio/sdk",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "Official JavaScript / TypeScript SDK for the Ophel.io membership & entitlement API.",
   "license": "MIT",
   "author": "Ophel.io",