@ophelio/sdk 0.5.0 → 0.6.0

package/dist/index.d.cts

@@ -1219,6 +1219,16 @@ interface components {
       update_time: string;
     };
     ListPlansResponse: {
+      /**
+       * @description Opaque token for the next page; empty string on the last page.
+       * @example
+       */
+      next_page_token: string;
+      /**
+       * @description Total number of results across all pages.
+       * @example 42
+       */
+      total_size: number;
       plans: components["schemas"]["Plan"][];
     };
     ErrorDetail: {
@@ -1267,7 +1277,17 @@ interface components {
       create_time: string; /** Format: date-time */
       update_time: string;
     };
-    ListBillingOptionsResponse: {
+    ListPlanBillingOptionsResponse: {
+      /**
+       * @description Opaque token for the next page; empty string on the last page.
+       * @example
+       */
+      next_page_token: string;
+      /**
+       * @description Total number of results across all pages.
+       * @example 42
+       */
+      total_size: number;
       billing_options: components["schemas"]["BillingOption"][];
     };
     CreateBillingOptionForPlanDto: {
@@ -1297,6 +1317,16 @@ interface components {
       update_time: string;
     };
     ListPlanLinksResponse: {
+      /**
+       * @description Opaque token for the next page; empty string on the last page.
+       * @example
+       */
+      next_page_token: string;
+      /**
+       * @description Total number of results across all pages.
+       * @example 42
+       */
+      total_size: number;
       plan_links: components["schemas"]["PlanLinkView"][];
     };
     CreatePlanLinkDto: {
@@ -1347,6 +1377,16 @@ interface components {
       entitlement: components["schemas"]["PlanEntitlementDefinition"] | null;
     };
     ListPlanEntitlementsResponse: {
+      /**
+       * @description Opaque token for the next page; empty string on the last page.
+       * @example
+       */
+      next_page_token: string;
+      /**
+       * @description Total number of results across all pages.
+       * @example 42
+       */
+      total_size: number;
       entitlements: components["schemas"]["PlanEntitlement"][];
     };
     CreatePlanEntitlementDto: {
@@ -1376,12 +1416,35 @@ interface components {
       pricing_group: components["schemas"]["MappingPricingGroup"] | null;
     };
     ListPlanPricingGroupMappingsResponse: {
+      /**
+       * @description Opaque token for the next page; empty string on the last page.
+       * @example
+       */
+      next_page_token: string;
+      /**
+       * @description Total number of results across all pages.
+       * @example 42
+       */
+      total_size: number;
       pricing_group_mappings: components["schemas"]["PlanPricingGroupMapping"][];
     };
     CreatePlanPricingGroupMappingDto: {
       /** Format: uuid */member_role_id: string; /** Format: uuid */
       pricing_group_id: string;
     };
+    ListBillingOptionsResponse: {
+      /**
+       * @description Opaque token for the next page; empty string on the last page.
+       * @example
+       */
+      next_page_token: string;
+      /**
+       * @description Total number of results across all pages.
+       * @example 42
+       */
+      total_size: number;
+      billing_options: components["schemas"]["BillingOption"][];
+    };
     UpdateBillingOptionDto: {
       display_name?: string;
       description?: string | null; /** @enum {string} */
@@ -1399,6 +1462,16 @@ interface components {
       sales_channel: components["schemas"]["SalesChannelSummary"] | null;
     };
     ListBillingOptionSalesChannelsResponse: {
+      /**
+       * @description Opaque token for the next page; empty string on the last page.
+       * @example
+       */
+      next_page_token: string;
+      /**
+       * @description Total number of results across all pages.
+       * @example 42
+       */
+      total_size: number;
       sales_channels: components["schemas"]["BillingOptionSalesChannel"][];
     };
     CreateBillingOptionSalesChannelDto: {
@@ -1414,6 +1487,16 @@ interface components {
       update_time: string;
     };
     ListSalesChannelsResponse: {
+      /**
+       * @description Opaque token for the next page; empty string on the last page.
+       * @example
+       */
+      next_page_token: string;
+      /**
+       * @description Total number of results across all pages.
+       * @example 42
+       */
+      total_size: number;
       sales_channels: components["schemas"]["SalesChannel"][];
     };
     CreateSalesChannelDto: {
@@ -1493,6 +1576,16 @@ interface components {
       update_time: string;
     };
     ListEntitlementsResponse: {
+      /**
+       * @description Opaque token for the next page; empty string on the last page.
+       * @example
+       */
+      next_page_token: string;
+      /**
+       * @description Total number of results across all pages.
+       * @example 42
+       */
+      total_size: number;
       entitlements: components["schemas"]["Entitlement"][];
     };
     RedeemEntitlementDto: {
@@ -1625,6 +1718,16 @@ interface components {
       membership: components["schemas"]["MemberMembershipSummary"] | null;
     };
     ListMemberEntitlementsResponse: {
+      /**
+       * @description Opaque token for the next page; empty string on the last page.
+       * @example
+       */
+      next_page_token: string;
+      /**
+       * @description Total number of results across all pages.
+       * @example 42
+       */
+      total_size: number;
       entitlements: components["schemas"]["MemberEntitlement"][];
     };
     UpdateMemberDto: {
@@ -1710,6 +1813,16 @@ interface components {
       update_time: string;
     };
     ListMemberRolesResponse: {
+      /**
+       * @description Opaque token for the next page; empty string on the last page.
+       * @example
+       */
+      next_page_token: string;
+      /**
+       * @description Total number of results across all pages.
+       * @example 42
+       */
+      total_size: number;
       member_roles: components["schemas"]["MemberRole"][];
     };
     CreateMemberRoleDto: {
@@ -1736,6 +1849,16 @@ interface components {
       update_time: string;
     };
     ListWebhookSubscriptionsResponse: {
+      /**
+       * @description Opaque token for the next page; empty string on the last page.
+       * @example
+       */
+      next_page_token: string;
+      /**
+       * @description Total number of results across all pages.
+       * @example 42
+       */
+      total_size: number;
       webhook_subscriptions: components["schemas"]["WebhookSubscription"][];
     };
     WebhookDelivery: {
@@ -1784,6 +1907,16 @@ interface components {
       update_time: string;
     };
     ListPricingGroupsResponse: {
+      /**
+       * @description Opaque token for the next page; empty string on the last page.
+       * @example
+       */
+      next_page_token: string;
+      /**
+       * @description Total number of results across all pages.
+       * @example 42
+       */
+      total_size: number;
       pricing_groups: components["schemas"]["PricingGroup"][];
     };
     CreatePricingGroupDto: {
@@ -1974,6 +2107,16 @@ interface components {
       memberships: components["schemas"]["Membership"][];
     };
     ListMembershipMembersResponse: {
+      /**
+       * @description Opaque token for the next page; empty string on the last page.
+       * @example
+       */
+      next_page_token: string;
+      /**
+       * @description Total number of results across all pages.
+       * @example 42
+       */
+      total_size: number;
       members: components["schemas"]["Member"][];
     };
     AddMemberDto: {
@@ -2477,7 +2620,10 @@ interface operations {
   };
   PlansController_list: {
     parameters: {
-      query?: never;
+      query?: {
+        page_size?: number;
+        page_token?: string;
+      };
       header?: never;
       path?: never;
       cookie?: never;
@@ -2604,7 +2750,10 @@ interface operations {
   };
   PlansController_listBillingOptions: {
     parameters: {
-      query?: never;
+      query?: {
+        page_size?: number;
+        page_token?: string;
+      };
       header?: never;
       path?: never;
       cookie?: never;
@@ -2616,7 +2765,7 @@ interface operations {
           [name: string]: unknown;
         };
         content: {
-          "application/json": components["schemas"]["ListBillingOptionsResponse"];
+          "application/json": components["schemas"]["ListPlanBillingOptionsResponse"];
         };
       };
       404: {
@@ -2662,7 +2811,10 @@ interface operations {
   };
   PlansController_listPlanLinks: {
     parameters: {
-      query?: never;
+      query?: {
+        page_size?: number;
+        page_token?: string;
+      };
       header?: never;
       path?: never;
       cookie?: never;
@@ -2720,7 +2872,10 @@ interface operations {
   };
   PlansController_listEntitlements: {
     parameters: {
-      query?: never;
+      query?: {
+        page_size?: number;
+        page_token?: string;
+      };
       header?: never;
       path?: never;
       cookie?: never;
@@ -2778,7 +2933,10 @@ interface operations {
   };
   PlansController_listPricingGroupMappings: {
     parameters: {
-      query?: never;
+      query?: {
+        page_size?: number;
+        page_token?: string;
+      };
       header?: never;
       path?: never;
       cookie?: never;
@@ -2836,7 +2994,10 @@ interface operations {
   };
   BillingOptionsController_list: {
     parameters: {
-      query?: never;
+      query?: {
+        page_size?: number;
+        page_token?: string;
+      };
       header?: never;
       path?: never;
       cookie?: never;
@@ -2940,7 +3101,10 @@ interface operations {
   };
   BillingOptionsController_listSalesChannels: {
     parameters: {
-      query?: never;
+      query?: {
+        page_size?: number;
+        page_token?: string;
+      };
       header?: never;
       path?: never;
       cookie?: never;
@@ -3025,7 +3189,10 @@ interface operations {
   };
   SalesChannelsController_list: {
     parameters: {
-      query?: never;
+      query?: {
+        page_size?: number;
+        page_token?: string;
+      };
       header?: never;
       path?: never;
       cookie?: never;
@@ -3469,7 +3636,10 @@ interface operations {
   };
   EntitlementsController_list: {
     parameters: {
-      query?: never;
+      query?: {
+        page_size?: number;
+        page_token?: string;
+      };
       header?: never;
       path?: never;
       cookie?: never;
@@ -3801,6 +3971,8 @@ interface operations {
     parameters: {
       query?: {
         /** @description Registered target codes the request is being made at, sent comma-separated (`?targets=venue_a,coffee_shop`). Codes are matched exactly; an unregistered code is refused. Omit for no target context; send it empty to name no targets. */targets?: string[];
+        page_size?: number;
+        page_token?: string;
         type?: "discount" | "early_access" | "free_entry" | "guest_pass";
       };
       header?: never;
@@ -4106,7 +4278,10 @@ interface operations {
   };
   MemberRolesController_list: {
     parameters: {
-      query?: never;
+      query?: {
+        page_size?: number;
+        page_token?: string;
+      };
       header?: never;
       path?: never;
       cookie?: never;
@@ -4233,7 +4408,10 @@ interface operations {
   };
   WebhookSubscriptionsController_list: {
     parameters: {
-      query?: never;
+      query?: {
+        page_size?: number;
+        page_token?: string;
+      };
       header?: never;
       path?: never;
       cookie?: never;
@@ -4390,7 +4568,10 @@ interface operations {
   };
   PricingGroupsController_list: {
     parameters: {
-      query?: never;
+      query?: {
+        page_size?: number;
+        page_token?: string;
+      };
       header?: never;
       path?: never;
       cookie?: never;
@@ -4965,7 +5146,10 @@ interface operations {
   };
   MembershipsController_listMembers: {
     parameters: {
-      query?: never;
+      query?: {
+        page_size?: number;
+        page_token?: string;
+      };
       header?: never;
       path?: never;
       cookie?: never;
@@ -5774,11 +5958,22 @@ declare class BillingOptionSalesChannelsResource extends APIResource {
 //#endregion
 //#region src/resources/billing-options.d.ts
 declare class BillingOptionsResource extends APIResource {
-  list(options?: RequestOptions): Promise<BillingOption[]>;
+  /**
+   * 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.
+   */
+  list(params?: PageParams, options?: RequestOptions): Promise<Page<BillingOption>>;
   get(id: string, options?: RequestOptions): Promise<BillingOption>;
   update(id: string, params: UpdateBillingOptionParams, options?: RequestOptions): Promise<BillingOption>;
   delete(id: string, options?: RequestOptions): Promise<void>;
-  listSalesChannels(id: string, options?: RequestOptions): Promise<BillingOptionSalesChannel[]>;
+  /**
+   * 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.
+   */
+  listSalesChannels(id: string, params?: PageParams, options?: RequestOptions): Promise<Page<BillingOptionSalesChannel>>;
   createSalesChannelLink(id: string, params: CreateBillingOptionSalesChannelParams, options?: RequestOptions): Promise<BillingOptionSalesChannel>;
 }
 //#endregion
@@ -5867,7 +6062,7 @@ declare class EntitlementsResource extends APIResource {
    * is refused rather than silently returning the original row.
    */
   recordUsage(params: RecordUsageParams, options?: IdempotentRequestOptions): Promise<EntitlementUsage[]>;
-  list(options?: RequestOptions): Promise<Entitlement[]>;
+  list(params?: PageParams, options?: RequestOptions): Promise<Page<Entitlement>>;
   get(id: string, options?: RequestOptions): Promise<Entitlement>;
   create(params: CreateEntitlementParams, options?: RequestOptions): Promise<Entitlement>;
   update(id: string, params: UpdateEntitlementParams, options?: RequestOptions): Promise<Entitlement>;
@@ -5876,7 +6071,7 @@ declare class EntitlementsResource extends APIResource {
 //#endregion
 //#region src/resources/member-roles.d.ts
 declare class MemberRolesResource extends APIResource {
-  list(options?: RequestOptions): Promise<MemberRole[]>;
+  list(params?: PageParams, options?: RequestOptions): Promise<Page<MemberRole>>;
   get(id: string, options?: RequestOptions): Promise<MemberRole>;
   create(params: CreateMemberRoleParams, options?: RequestOptions): Promise<MemberRole>;
   update(id: string, params: UpdateMemberRoleParams, options?: RequestOptions): Promise<MemberRole>;
@@ -5888,9 +6083,26 @@ declare class MembersResource 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?: {
     since?: string;
+    targets?: string[];
   }, options?: RequestOptions): Promise<MemberSyncResponse>;
   get(id: string, options?: RequestOptions): Promise<Member>;
   /**
@@ -5907,11 +6119,16 @@ declare class MembersResource 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.
    */
-  listEntitlements(id: string, params?: {
+  listEntitlements(id: string, params?: PageParams & {
     type?: EntitlementType;
     targets?: string[];
-  }, options?: RequestOptions): Promise<MemberEntitlement[]>;
+  }, options?: RequestOptions): Promise<Page<MemberEntitlement>>;
   /**
    * Updates a member's details. Accepts `name`, `date_of_birth` and `role`
    * (a member-role code). To reassign the primary member use `setPrimary`;
@@ -5957,7 +6174,12 @@ declare class MembershipsResource extends APIResource {
    * transaction once and does not advance dunning twice.
    */
   createTransaction(id: string, params: CreateTransactionParams, options?: IdempotentRequestOptions): Promise<Transaction>;
-  listMembers(id: string, options?: RequestOptions): Promise<Member[]>;
+  /**
+   * 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.
+   */
+  listMembers(id: string, params?: PageParams, options?: RequestOptions): Promise<Page<Member>>;
   /**
    * Add a member to an existing membership, up to the plan's max party size.
    * `role` is a member-role code; an optional `email` links the member to a
@@ -6026,24 +6248,24 @@ declare class PlanPricingGroupMappingsResource extends APIResource {
 //#endregion
 //#region src/resources/plans.d.ts
 declare class PlansResource extends APIResource {
-  list(options?: RequestOptions): Promise<Plan[]>;
+  list(params?: PageParams, options?: RequestOptions): Promise<Page<Plan>>;
   get(id: string, options?: RequestOptions): Promise<Plan>;
-  listBillingOptions(id: string, options?: RequestOptions): Promise<BillingOption[]>;
-  listEntitlements(id: string, options?: RequestOptions): Promise<PlanEntitlement[]>;
+  listBillingOptions(id: string, params?: PageParams, options?: RequestOptions): Promise<Page<BillingOption>>;
+  listEntitlements(id: string, params?: PageParams, options?: RequestOptions): Promise<Page<PlanEntitlement>>;
   create(params: CreatePlanParams, options?: RequestOptions): Promise<Plan>;
   update(id: string, params: UpdatePlanParams, options?: RequestOptions): Promise<Plan>;
   delete(id: string, options?: RequestOptions): Promise<void>;
   createBillingOption(id: string, params: CreateBillingOptionParams, options?: RequestOptions): Promise<BillingOption>;
-  listPlanLinks(id: string, options?: RequestOptions): Promise<PlanLinkView[]>;
+  listPlanLinks(id: string, params?: PageParams, options?: RequestOptions): Promise<Page<PlanLinkView>>;
   createPlanLink(id: string, params: CreatePlanLinkParams, options?: RequestOptions): Promise<PlanLink>;
   createEntitlement(id: string, params: CreatePlanEntitlementParams, options?: RequestOptions): Promise<PlanEntitlement>;
-  listPricingGroupMappings(id: string, options?: RequestOptions): Promise<PlanPricingGroupMapping[]>;
+  listPricingGroupMappings(id: string, params?: PageParams, options?: RequestOptions): Promise<Page<PlanPricingGroupMapping>>;
   createPricingGroupMapping(id: string, params: CreatePlanPricingGroupMappingParams, options?: RequestOptions): Promise<PlanPricingGroupMapping>;
 }
 //#endregion
 //#region src/resources/pricing-groups.d.ts
 declare class PricingGroupsResource extends APIResource {
-  list(options?: RequestOptions): Promise<PricingGroup[]>;
+  list(params?: PageParams, options?: RequestOptions): Promise<Page<PricingGroup>>;
   get(id: string, options?: RequestOptions): Promise<PricingGroup>;
   create(params: CreatePricingGroupParams, options?: RequestOptions): Promise<PricingGroup>;
   update(id: string, params: UpdatePricingGroupParams, options?: RequestOptions): Promise<PricingGroup>;
@@ -6052,7 +6274,7 @@ declare class PricingGroupsResource extends APIResource {
 //#endregion
 //#region src/resources/sales-channels.d.ts
 declare class SalesChannelsResource extends APIResource {
-  list(options?: RequestOptions): Promise<SalesChannel[]>;
+  list(params?: PageParams, options?: RequestOptions): Promise<Page<SalesChannel>>;
   get(id: string, options?: RequestOptions): Promise<SalesChannel>;
   create(params: CreateSalesChannelParams, options?: RequestOptions): Promise<SalesChannel>;
   update(id: string, params: UpdateSalesChannelParams, options?: RequestOptions): Promise<SalesChannel>;
@@ -6097,7 +6319,7 @@ declare class TargetCodesResource extends APIResource {
 //#endregion
 //#region src/resources/webhook-subscriptions.d.ts
 declare class WebhookSubscriptionsResource extends APIResource {
-  list(options?: RequestOptions): Promise<WebhookSubscription[]>;
+  list(params?: PageParams, options?: RequestOptions): Promise<Page<WebhookSubscription>>;
   get(id: string, options?: RequestOptions): Promise<WebhookSubscription>;
   listDeliveries(id: string, params?: PageParams, options?: RequestOptions): Promise<Page<WebhookDelivery>>;
   /** The HMAC signing secret is only returned on creation — store it then. */