@widgetic/api-sdk 1.0.24 → 1.0.25

package/dist/esm/apis/ShopifyApi.d.ts

@@ -0,0 +1,127 @@
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { ApproveShopifySeat200Response, CreateShopifyBuilderSession200Response, CreateShopifyBuilderSessionRequest, DeclineShopifySeat200Response, GetShopifySeatQuote200Response, GetShopifyTenant200Response, ListShopifySeats200Response, RemoveShopifySeat200Response, SyncShopifyBilling200Response } from '../models/index';
+export interface ApproveShopifySeatRequest {
+    id: string;
+    body?: object;
+}
+export interface CreateShopifyBuilderSessionOperationRequest {
+    createShopifyBuilderSessionRequest?: CreateShopifyBuilderSessionRequest;
+}
+export interface DeclineShopifySeatRequest {
+    id: string;
+    body?: object;
+}
+export interface GetShopifySeatQuoteRequest {
+    seats?: number;
+    frequency?: GetShopifySeatQuoteFrequencyEnum;
+}
+export interface RemoveShopifySeatRequest {
+    id: string;
+}
+export interface SyncShopifyBillingRequest {
+    body?: object;
+}
+/**
+ *
+ */
+export declare class ShopifyApi extends runtime.BaseAPI {
+    /**
+     * Lets a person who asked to join use Widgetic for the store. The person becomes a team member of the store under their own account (nobody signs up; the account is made for them) with the same features, credits and storage as any member of a Teams store. The credits are this period\'s, pro-rated from today, the way a member who joins a team on widgetic.com gets them.  When the store\'s plan has no free seat the person is approved and waits (`outcome` of `awaiting_plan`): the store is not charged for anything, and they are seated as soon as a plan with room is recorded (the merchant chooses one on Shopify\'s plan page). `GET /shopify/billing/quote` says which plan that is. A person suspended because the plan shrank is not queued: there is `409` until a seat is free.  Safe to repeat. If the person was seated but their credits and features could not be set up, the answer is `503` with `error.code` of `SHOPIFY_SEAT_RIGHTS_PENDING`; approve again.  Only the store\'s account owner may approve, and Shopify is asked to confirm it every time: the recorded answer is not good enough for a change. Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * Approve a person for the store
+     */
+    approveShopifySeatRaw(requestParameters: ApproveShopifySeatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApproveShopifySeat200Response>>;
+    /**
+     * Lets a person who asked to join use Widgetic for the store. The person becomes a team member of the store under their own account (nobody signs up; the account is made for them) with the same features, credits and storage as any member of a Teams store. The credits are this period\'s, pro-rated from today, the way a member who joins a team on widgetic.com gets them.  When the store\'s plan has no free seat the person is approved and waits (`outcome` of `awaiting_plan`): the store is not charged for anything, and they are seated as soon as a plan with room is recorded (the merchant chooses one on Shopify\'s plan page). `GET /shopify/billing/quote` says which plan that is. A person suspended because the plan shrank is not queued: there is `409` until a seat is free.  Safe to repeat. If the person was seated but their credits and features could not be set up, the answer is `503` with `error.code` of `SHOPIFY_SEAT_RIGHTS_PENDING`; approve again.  Only the store\'s account owner may approve, and Shopify is asked to confirm it every time: the recorded answer is not good enough for a change. Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * Approve a person for the store
+     */
+    approveShopifySeat(requestParameters: ApproveShopifySeatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApproveShopifySeat200Response>;
+    /**
+     * Lets a person who is using the Shopify app (the store\'s owner, or a team member the owner approved) open the Widgetic builder already signed in, without creating an account. The account signed in is the one the verified person acts as: the store\'s owner account for the owner, the person\'s own member account for a team member. Nothing in the request chooses it. Returns a short-lived signed credential (`handoffToken`) for the site\'s sign-in landing page: open `<site>/auth/oauth-complete/shopify#os=<handoffToken>` (in the URL fragment, never the query string) and the site exchanges it for a session and continues to the builder.  The response is a credential: it expires after `expiresInSeconds`, is sent with `Cache-Control: no-store`, and must not be logged or stored.  Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`). Any other credential receives `403`, and so does a person who has no working seat in the store yet (`error.code` of `SEAT_REQUIRED`). An account the Shopify app did not create for this store (for instance a store whose owner is an ordinary person\'s account) also receives `403`, because signing in as a real person\'s account would expose that person\'s other organizations.
+     * Sign the person using the app in to the Widgetic builder
+     */
+    createShopifyBuilderSessionRaw(requestParameters: CreateShopifyBuilderSessionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShopifyBuilderSession200Response>>;
+    /**
+     * Lets a person who is using the Shopify app (the store\'s owner, or a team member the owner approved) open the Widgetic builder already signed in, without creating an account. The account signed in is the one the verified person acts as: the store\'s owner account for the owner, the person\'s own member account for a team member. Nothing in the request chooses it. Returns a short-lived signed credential (`handoffToken`) for the site\'s sign-in landing page: open `<site>/auth/oauth-complete/shopify#os=<handoffToken>` (in the URL fragment, never the query string) and the site exchanges it for a session and continues to the builder.  The response is a credential: it expires after `expiresInSeconds`, is sent with `Cache-Control: no-store`, and must not be logged or stored.  Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`). Any other credential receives `403`, and so does a person who has no working seat in the store yet (`error.code` of `SEAT_REQUIRED`). An account the Shopify app did not create for this store (for instance a store whose owner is an ordinary person\'s account) also receives `403`, because signing in as a real person\'s account would expose that person\'s other organizations.
+     * Sign the person using the app in to the Widgetic builder
+     */
+    createShopifyBuilderSession(requestParameters?: CreateShopifyBuilderSessionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShopifyBuilderSession200Response>;
+    /**
+     * Turns down a person who asked to join, or who was approved and waits for a plan with room. They are told the store owner did not approve them, and can be approved later. A person who already has a seat is removed (`DELETE /shopify/seats/{id}`), not declined.  Safe to repeat. Only the store\'s account owner may decline, and Shopify is asked to confirm it every time. Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * Decline a person who asked to join
+     */
+    declineShopifySeatRaw(requestParameters: DeclineShopifySeatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeclineShopifySeat200Response>>;
+    /**
+     * Turns down a person who asked to join, or who was approved and waits for a plan with room. They are told the store owner did not approve them, and can be approved later. A person who already has a seat is removed (`DELETE /shopify/seats/{id}`), not declined.  Safe to repeat. Only the store\'s account owner may decline, and Shopify is asked to confirm it every time. Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * Decline a person who asked to join
+     */
+    declineShopifySeat(requestParameters: DeclineShopifySeatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeclineShopifySeat200Response>;
+    /**
+     * Tells the store\'s account owner, before they add people, which plan would seat everybody, roughly what Shopify will charge today, and the credits each person would get. Nothing is charged and Shopify is not asked: the plan is the one on record, and every figure is an estimate (`isEstimate` is always true). Shopify shows the exact charge on its plan page, which is where the plan is changed (`planPageUrl`).  The daily rate and the credits are worked out by the same code that prices a seat added to a team on widgetic.com, so the two never disagree. A store on a paid plan that moves to a bigger one pays the difference in price for the rest of the period it is in; a store with no plan, in its trial, or that cancelled pays the new plan\'s full price and its period starts now.  Without `seats`, the quote is for the people in seats, the people already approved and waiting, and one more: what approving the next person needs.  Only the store\'s account owner may read it (`403` and `error.code` of `ACCOUNT_OWNER_REQUIRED` otherwise). Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * Estimate what seating more people would cost
+     */
+    getShopifySeatQuoteRaw(requestParameters: GetShopifySeatQuoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetShopifySeatQuote200Response>>;
+    /**
+     * Tells the store\'s account owner, before they add people, which plan would seat everybody, roughly what Shopify will charge today, and the credits each person would get. Nothing is charged and Shopify is not asked: the plan is the one on record, and every figure is an estimate (`isEstimate` is always true). Shopify shows the exact charge on its plan page, which is where the plan is changed (`planPageUrl`).  The daily rate and the credits are worked out by the same code that prices a seat added to a team on widgetic.com, so the two never disagree. A store on a paid plan that moves to a bigger one pays the difference in price for the rest of the period it is in; a store with no plan, in its trial, or that cancelled pays the new plan\'s full price and its period starts now.  Without `seats`, the quote is for the people in seats, the people already approved and waiting, and one more: what approving the next person needs.  Only the store\'s account owner may read it (`403` and `error.code` of `ACCOUNT_OWNER_REQUIRED` otherwise). Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * Estimate what seating more people would cost
+     */
+    getShopifySeatQuote(requestParameters?: GetShopifySeatQuoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetShopifySeatQuote200Response>;
+    /**
+     * Resolves the calling Shopify store to its Widgetic organization and reports the store\'s plan. The first call for a store provisions it: an organization and a system-created owner, with no sign-up and no free period: the store has no plan (`plan.hasChosenPlan` is false) until it picks one on Shopify\'s plan page, and the only trial is the 7-day trial on the Solo plan. `isNewInstall` is true only on that call, so the app can welcome a new install once.  Shopify sends no subscription webhooks, so when the store\'s plan was last read from Shopify more than five minutes ago it is read again first (a slow Shopify never delays the answer by more than a few seconds).  `seat` describes the caller\'s own place in the store. The first person to open a store holds its owner seat until the store\'s account owner opens the app, who then takes it; everybody else asks to join and waits for the account owner to approve them (`canUseWidgetic` is false and `message` says why). A person who cannot use Widgetic yet can still call this endpoint, so the app can tell them so; every other endpoint refuses them with `403` and `error.code` of `SEAT_REQUIRED`.  Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`). Any other credential receives `403`, because there is no store to describe.
+     * Get the store behind a Shopify session
+     */
+    getShopifyTenantRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetShopifyTenant200Response>>;
+    /**
+     * Resolves the calling Shopify store to its Widgetic organization and reports the store\'s plan. The first call for a store provisions it: an organization and a system-created owner, with no sign-up and no free period: the store has no plan (`plan.hasChosenPlan` is false) until it picks one on Shopify\'s plan page, and the only trial is the 7-day trial on the Solo plan. `isNewInstall` is true only on that call, so the app can welcome a new install once.  Shopify sends no subscription webhooks, so when the store\'s plan was last read from Shopify more than five minutes ago it is read again first (a slow Shopify never delays the answer by more than a few seconds).  `seat` describes the caller\'s own place in the store. The first person to open a store holds its owner seat until the store\'s account owner opens the app, who then takes it; everybody else asks to join and waits for the account owner to approve them (`canUseWidgetic` is false and `message` says why). A person who cannot use Widgetic yet can still call this endpoint, so the app can tell them so; every other endpoint refuses them with `403` and `error.code` of `SEAT_REQUIRED`.  Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`). Any other credential receives `403`, because there is no store to describe.
+     * Get the store behind a Shopify session
+     */
+    getShopifyTenant(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetShopifyTenant200Response>;
+    /**
+     * The store\'s account owner sees everyone who has opened the app for the store: the people waiting to be approved, the people approved who wait for a plan with room, the team, and the people who are out. Each comes with what the owner can do with them (`canApprove`, `canDecline`, `canRemove`), so the app shows the buttons that will work, and the totals (`seatsInUse`, `seatsFree`).  The store\'s owner seat is listed first; it is the store\'s own and nothing can be done to it. A person suspended because the plan shrank has no seat in use and can be seated again once there is room.  Only the store\'s account owner may read it (`403` and `error.code` of `ACCOUNT_OWNER_REQUIRED` otherwise). Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * List the people who use Widgetic for the store
+     */
+    listShopifySeatsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListShopifySeats200Response>>;
+    /**
+     * The store\'s account owner sees everyone who has opened the app for the store: the people waiting to be approved, the people approved who wait for a plan with room, the team, and the people who are out. Each comes with what the owner can do with them (`canApprove`, `canDecline`, `canRemove`), so the app shows the buttons that will work, and the totals (`seatsInUse`, `seatsFree`).  The store\'s owner seat is listed first; it is the store\'s own and nothing can be done to it. A person suspended because the plan shrank has no seat in use and can be seated again once there is room.  Only the store\'s account owner may read it (`403` and `error.code` of `ACCOUNT_OWNER_REQUIRED` otherwise). Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * List the people who use Widgetic for the store
+     */
+    listShopifySeats(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListShopifySeats200Response>;
+    /**
+     * Takes a person\'s seat away. They stop being able to use Widgetic for the store at once, and what they made there (compositions, widgets, canvases, A/B tests, translations and projects) stays with the store: it is handed to the store\'s owner account in the same step, so nothing embedded on the storefront goes dark with the person. Their credits and Teams features are taken back; their uploads stay theirs. They can be approved again later, and the seat is free for somebody else straight away.  The seat\'s price does not change by itself: the merchant changes the plan on Shopify\'s plan page.  Safe to repeat. Only the store\'s account owner may remove, and Shopify is asked to confirm it every time. Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * Remove a person from the store
+     */
+    removeShopifySeatRaw(requestParameters: RemoveShopifySeatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RemoveShopifySeat200Response>>;
+    /**
+     * Takes a person\'s seat away. They stop being able to use Widgetic for the store at once, and what they made there (compositions, widgets, canvases, A/B tests, translations and projects) stays with the store: it is handed to the store\'s owner account in the same step, so nothing embedded on the storefront goes dark with the person. Their credits and Teams features are taken back; their uploads stay theirs. They can be approved again later, and the seat is free for somebody else straight away.  The seat\'s price does not change by itself: the merchant changes the plan on Shopify\'s plan page.  Safe to repeat. Only the store\'s account owner may remove, and Shopify is asked to confirm it every time. Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * Remove a person from the store
+     */
+    removeShopifySeat(requestParameters: RemoveShopifySeatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RemoveShopifySeat200Response>;
+    /**
+     * Shopify App Pricing sends the app no subscription webhooks, so a plan the merchant just chose, changed or cancelled on Shopify\'s plan page is only known once it is read from Shopify. The app calls this when the merchant returns from that page (and again a moment later if the change has not shown up yet). The store\'s plan, credits and seats are brought in line with what Shopify reports, and the store is described exactly as `GET /shopify/tenant` does.  Nothing in the request chooses a store or a plan: the store comes from the verified session, and the plan from Shopify. A read newer than ten seconds is not repeated. When Shopify cannot be reached right now the answer is still `200` with the plan as it was recorded and `sync.status` of `unavailable`, so the app can try again.  Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`). Any other credential receives `403`.
+     * Re-read the store\'s plan from Shopify
+     */
+    syncShopifyBillingRaw(requestParameters: SyncShopifyBillingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SyncShopifyBilling200Response>>;
+    /**
+     * Shopify App Pricing sends the app no subscription webhooks, so a plan the merchant just chose, changed or cancelled on Shopify\'s plan page is only known once it is read from Shopify. The app calls this when the merchant returns from that page (and again a moment later if the change has not shown up yet). The store\'s plan, credits and seats are brought in line with what Shopify reports, and the store is described exactly as `GET /shopify/tenant` does.  Nothing in the request chooses a store or a plan: the store comes from the verified session, and the plan from Shopify. A read newer than ten seconds is not repeated. When Shopify cannot be reached right now the answer is still `200` with the plan as it was recorded and `sync.status` of `unavailable`, so the app can try again.  Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`). Any other credential receives `403`.
+     * Re-read the store\'s plan from Shopify
+     */
+    syncShopifyBilling(requestParameters?: SyncShopifyBillingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SyncShopifyBilling200Response>;
+}
+/**
+ * @export
+ */
+export declare const GetShopifySeatQuoteFrequencyEnum: {
+    readonly Monthly: "monthly";
+    readonly Yearly: "yearly";
+};
+export type GetShopifySeatQuoteFrequencyEnum = typeof GetShopifySeatQuoteFrequencyEnum[keyof typeof GetShopifySeatQuoteFrequencyEnum];

package/dist/esm/apis/ShopifyApi.js

@@ -0,0 +1,331 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Widgetic API Gateway
+ * API documentation for the Widgetic API Gateway
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime.js';
+import { ApproveShopifySeat200ResponseFromJSON, CreateShopifyBuilderSession200ResponseFromJSON, CreateShopifyBuilderSessionRequestToJSON, DeclineShopifySeat200ResponseFromJSON, GetShopifySeatQuote200ResponseFromJSON, GetShopifyTenant200ResponseFromJSON, ListShopifySeats200ResponseFromJSON, RemoveShopifySeat200ResponseFromJSON, SyncShopifyBilling200ResponseFromJSON, } from '../models/index.js';
+/**
+ *
+ */
+export class ShopifyApi extends runtime.BaseAPI {
+    /**
+     * Lets a person who asked to join use Widgetic for the store. The person becomes a team member of the store under their own account (nobody signs up; the account is made for them) with the same features, credits and storage as any member of a Teams store. The credits are this period\'s, pro-rated from today, the way a member who joins a team on widgetic.com gets them.  When the store\'s plan has no free seat the person is approved and waits (`outcome` of `awaiting_plan`): the store is not charged for anything, and they are seated as soon as a plan with room is recorded (the merchant chooses one on Shopify\'s plan page). `GET /shopify/billing/quote` says which plan that is. A person suspended because the plan shrank is not queued: there is `409` until a seat is free.  Safe to repeat. If the person was seated but their credits and features could not be set up, the answer is `503` with `error.code` of `SHOPIFY_SEAT_RIGHTS_PENDING`; approve again.  Only the store\'s account owner may approve, and Shopify is asked to confirm it every time: the recorded answer is not good enough for a change. Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * Approve a person for the store
+     */
+    approveShopifySeatRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling approveShopifySeat().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("apiKeyAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/shopify/seats/{id}/approve`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters['body'],
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ApproveShopifySeat200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Lets a person who asked to join use Widgetic for the store. The person becomes a team member of the store under their own account (nobody signs up; the account is made for them) with the same features, credits and storage as any member of a Teams store. The credits are this period\'s, pro-rated from today, the way a member who joins a team on widgetic.com gets them.  When the store\'s plan has no free seat the person is approved and waits (`outcome` of `awaiting_plan`): the store is not charged for anything, and they are seated as soon as a plan with room is recorded (the merchant chooses one on Shopify\'s plan page). `GET /shopify/billing/quote` says which plan that is. A person suspended because the plan shrank is not queued: there is `409` until a seat is free.  Safe to repeat. If the person was seated but their credits and features could not be set up, the answer is `503` with `error.code` of `SHOPIFY_SEAT_RIGHTS_PENDING`; approve again.  Only the store\'s account owner may approve, and Shopify is asked to confirm it every time: the recorded answer is not good enough for a change. Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * Approve a person for the store
+     */
+    approveShopifySeat(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.approveShopifySeatRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Lets a person who is using the Shopify app (the store\'s owner, or a team member the owner approved) open the Widgetic builder already signed in, without creating an account. The account signed in is the one the verified person acts as: the store\'s owner account for the owner, the person\'s own member account for a team member. Nothing in the request chooses it. Returns a short-lived signed credential (`handoffToken`) for the site\'s sign-in landing page: open `<site>/auth/oauth-complete/shopify#os=<handoffToken>` (in the URL fragment, never the query string) and the site exchanges it for a session and continues to the builder.  The response is a credential: it expires after `expiresInSeconds`, is sent with `Cache-Control: no-store`, and must not be logged or stored.  Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`). Any other credential receives `403`, and so does a person who has no working seat in the store yet (`error.code` of `SEAT_REQUIRED`). An account the Shopify app did not create for this store (for instance a store whose owner is an ordinary person\'s account) also receives `403`, because signing in as a real person\'s account would expose that person\'s other organizations.
+     * Sign the person using the app in to the Widgetic builder
+     */
+    createShopifyBuilderSessionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("apiKeyAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/shopify/builder-session`,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateShopifyBuilderSessionRequestToJSON(requestParameters['createShopifyBuilderSessionRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CreateShopifyBuilderSession200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Lets a person who is using the Shopify app (the store\'s owner, or a team member the owner approved) open the Widgetic builder already signed in, without creating an account. The account signed in is the one the verified person acts as: the store\'s owner account for the owner, the person\'s own member account for a team member. Nothing in the request chooses it. Returns a short-lived signed credential (`handoffToken`) for the site\'s sign-in landing page: open `<site>/auth/oauth-complete/shopify#os=<handoffToken>` (in the URL fragment, never the query string) and the site exchanges it for a session and continues to the builder.  The response is a credential: it expires after `expiresInSeconds`, is sent with `Cache-Control: no-store`, and must not be logged or stored.  Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`). Any other credential receives `403`, and so does a person who has no working seat in the store yet (`error.code` of `SEAT_REQUIRED`). An account the Shopify app did not create for this store (for instance a store whose owner is an ordinary person\'s account) also receives `403`, because signing in as a real person\'s account would expose that person\'s other organizations.
+     * Sign the person using the app in to the Widgetic builder
+     */
+    createShopifyBuilderSession() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.createShopifyBuilderSessionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Turns down a person who asked to join, or who was approved and waits for a plan with room. They are told the store owner did not approve them, and can be approved later. A person who already has a seat is removed (`DELETE /shopify/seats/{id}`), not declined.  Safe to repeat. Only the store\'s account owner may decline, and Shopify is asked to confirm it every time. Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * Decline a person who asked to join
+     */
+    declineShopifySeatRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling declineShopifySeat().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("apiKeyAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/shopify/seats/{id}/decline`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters['body'],
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DeclineShopifySeat200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Turns down a person who asked to join, or who was approved and waits for a plan with room. They are told the store owner did not approve them, and can be approved later. A person who already has a seat is removed (`DELETE /shopify/seats/{id}`), not declined.  Safe to repeat. Only the store\'s account owner may decline, and Shopify is asked to confirm it every time. Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * Decline a person who asked to join
+     */
+    declineShopifySeat(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.declineShopifySeatRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Tells the store\'s account owner, before they add people, which plan would seat everybody, roughly what Shopify will charge today, and the credits each person would get. Nothing is charged and Shopify is not asked: the plan is the one on record, and every figure is an estimate (`isEstimate` is always true). Shopify shows the exact charge on its plan page, which is where the plan is changed (`planPageUrl`).  The daily rate and the credits are worked out by the same code that prices a seat added to a team on widgetic.com, so the two never disagree. A store on a paid plan that moves to a bigger one pays the difference in price for the rest of the period it is in; a store with no plan, in its trial, or that cancelled pays the new plan\'s full price and its period starts now.  Without `seats`, the quote is for the people in seats, the people already approved and waiting, and one more: what approving the next person needs.  Only the store\'s account owner may read it (`403` and `error.code` of `ACCOUNT_OWNER_REQUIRED` otherwise). Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * Estimate what seating more people would cost
+     */
+    getShopifySeatQuoteRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['seats'] != null) {
+                queryParameters['seats'] = requestParameters['seats'];
+            }
+            if (requestParameters['frequency'] != null) {
+                queryParameters['frequency'] = requestParameters['frequency'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("apiKeyAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/shopify/billing/quote`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetShopifySeatQuote200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Tells the store\'s account owner, before they add people, which plan would seat everybody, roughly what Shopify will charge today, and the credits each person would get. Nothing is charged and Shopify is not asked: the plan is the one on record, and every figure is an estimate (`isEstimate` is always true). Shopify shows the exact charge on its plan page, which is where the plan is changed (`planPageUrl`).  The daily rate and the credits are worked out by the same code that prices a seat added to a team on widgetic.com, so the two never disagree. A store on a paid plan that moves to a bigger one pays the difference in price for the rest of the period it is in; a store with no plan, in its trial, or that cancelled pays the new plan\'s full price and its period starts now.  Without `seats`, the quote is for the people in seats, the people already approved and waiting, and one more: what approving the next person needs.  Only the store\'s account owner may read it (`403` and `error.code` of `ACCOUNT_OWNER_REQUIRED` otherwise). Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * Estimate what seating more people would cost
+     */
+    getShopifySeatQuote() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getShopifySeatQuoteRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Resolves the calling Shopify store to its Widgetic organization and reports the store\'s plan. The first call for a store provisions it: an organization and a system-created owner, with no sign-up and no free period: the store has no plan (`plan.hasChosenPlan` is false) until it picks one on Shopify\'s plan page, and the only trial is the 7-day trial on the Solo plan. `isNewInstall` is true only on that call, so the app can welcome a new install once.  Shopify sends no subscription webhooks, so when the store\'s plan was last read from Shopify more than five minutes ago it is read again first (a slow Shopify never delays the answer by more than a few seconds).  `seat` describes the caller\'s own place in the store. The first person to open a store holds its owner seat until the store\'s account owner opens the app, who then takes it; everybody else asks to join and waits for the account owner to approve them (`canUseWidgetic` is false and `message` says why). A person who cannot use Widgetic yet can still call this endpoint, so the app can tell them so; every other endpoint refuses them with `403` and `error.code` of `SEAT_REQUIRED`.  Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`). Any other credential receives `403`, because there is no store to describe.
+     * Get the store behind a Shopify session
+     */
+    getShopifyTenantRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("apiKeyAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/shopify/tenant`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetShopifyTenant200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Resolves the calling Shopify store to its Widgetic organization and reports the store\'s plan. The first call for a store provisions it: an organization and a system-created owner, with no sign-up and no free period: the store has no plan (`plan.hasChosenPlan` is false) until it picks one on Shopify\'s plan page, and the only trial is the 7-day trial on the Solo plan. `isNewInstall` is true only on that call, so the app can welcome a new install once.  Shopify sends no subscription webhooks, so when the store\'s plan was last read from Shopify more than five minutes ago it is read again first (a slow Shopify never delays the answer by more than a few seconds).  `seat` describes the caller\'s own place in the store. The first person to open a store holds its owner seat until the store\'s account owner opens the app, who then takes it; everybody else asks to join and waits for the account owner to approve them (`canUseWidgetic` is false and `message` says why). A person who cannot use Widgetic yet can still call this endpoint, so the app can tell them so; every other endpoint refuses them with `403` and `error.code` of `SEAT_REQUIRED`.  Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`). Any other credential receives `403`, because there is no store to describe.
+     * Get the store behind a Shopify session
+     */
+    getShopifyTenant(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getShopifyTenantRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * The store\'s account owner sees everyone who has opened the app for the store: the people waiting to be approved, the people approved who wait for a plan with room, the team, and the people who are out. Each comes with what the owner can do with them (`canApprove`, `canDecline`, `canRemove`), so the app shows the buttons that will work, and the totals (`seatsInUse`, `seatsFree`).  The store\'s owner seat is listed first; it is the store\'s own and nothing can be done to it. A person suspended because the plan shrank has no seat in use and can be seated again once there is room.  Only the store\'s account owner may read it (`403` and `error.code` of `ACCOUNT_OWNER_REQUIRED` otherwise). Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * List the people who use Widgetic for the store
+     */
+    listShopifySeatsRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("apiKeyAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/shopify/seats`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ListShopifySeats200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * The store\'s account owner sees everyone who has opened the app for the store: the people waiting to be approved, the people approved who wait for a plan with room, the team, and the people who are out. Each comes with what the owner can do with them (`canApprove`, `canDecline`, `canRemove`), so the app shows the buttons that will work, and the totals (`seatsInUse`, `seatsFree`).  The store\'s owner seat is listed first; it is the store\'s own and nothing can be done to it. A person suspended because the plan shrank has no seat in use and can be seated again once there is room.  Only the store\'s account owner may read it (`403` and `error.code` of `ACCOUNT_OWNER_REQUIRED` otherwise). Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * List the people who use Widgetic for the store
+     */
+    listShopifySeats(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listShopifySeatsRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Takes a person\'s seat away. They stop being able to use Widgetic for the store at once, and what they made there (compositions, widgets, canvases, A/B tests, translations and projects) stays with the store: it is handed to the store\'s owner account in the same step, so nothing embedded on the storefront goes dark with the person. Their credits and Teams features are taken back; their uploads stay theirs. They can be approved again later, and the seat is free for somebody else straight away.  The seat\'s price does not change by itself: the merchant changes the plan on Shopify\'s plan page.  Safe to repeat. Only the store\'s account owner may remove, and Shopify is asked to confirm it every time. Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * Remove a person from the store
+     */
+    removeShopifySeatRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling removeShopifySeat().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("apiKeyAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/shopify/seats/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => RemoveShopifySeat200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Takes a person\'s seat away. They stop being able to use Widgetic for the store at once, and what they made there (compositions, widgets, canvases, A/B tests, translations and projects) stays with the store: it is handed to the store\'s owner account in the same step, so nothing embedded on the storefront goes dark with the person. Their credits and Teams features are taken back; their uploads stay theirs. They can be approved again later, and the seat is free for somebody else straight away.  The seat\'s price does not change by itself: the merchant changes the plan on Shopify\'s plan page.  Safe to repeat. Only the store\'s account owner may remove, and Shopify is asked to confirm it every time. Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`).
+     * Remove a person from the store
+     */
+    removeShopifySeat(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.removeShopifySeatRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Shopify App Pricing sends the app no subscription webhooks, so a plan the merchant just chose, changed or cancelled on Shopify\'s plan page is only known once it is read from Shopify. The app calls this when the merchant returns from that page (and again a moment later if the change has not shown up yet). The store\'s plan, credits and seats are brought in line with what Shopify reports, and the store is described exactly as `GET /shopify/tenant` does.  Nothing in the request chooses a store or a plan: the store comes from the verified session, and the plan from Shopify. A read newer than ten seconds is not repeated. When Shopify cannot be reached right now the answer is still `200` with the plan as it was recorded and `sync.status` of `unavailable`, so the app can try again.  Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`). Any other credential receives `403`.
+     * Re-read the store\'s plan from Shopify
+     */
+    syncShopifyBillingRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("apiKeyAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/shopify/billing/sync`,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters['body'],
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => SyncShopifyBilling200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Shopify App Pricing sends the app no subscription webhooks, so a plan the merchant just chose, changed or cancelled on Shopify\'s plan page is only known once it is read from Shopify. The app calls this when the merchant returns from that page (and again a moment later if the change has not shown up yet). The store\'s plan, credits and seats are brought in line with what Shopify reports, and the store is described exactly as `GET /shopify/tenant` does.  Nothing in the request chooses a store or a plan: the store comes from the verified session, and the plan from Shopify. A read newer than ten seconds is not repeated. When Shopify cannot be reached right now the answer is still `200` with the plan as it was recorded and `sync.status` of `unavailable`, so the app can try again.  Requires a Shopify session token (`Authorization: Bearer <App Bridge idToken>`). Any other credential receives `403`.
+     * Re-read the store\'s plan from Shopify
+     */
+    syncShopifyBilling() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.syncShopifyBillingRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+/**
+ * @export
+ */
+export const GetShopifySeatQuoteFrequencyEnum = {
+    Monthly: 'monthly',
+    Yearly: 'yearly'
+};

package/dist/esm/apis/SubscriptionsApi.d.ts

@@ -10,11 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { ApiV1SubscriptionsIdRefundPreviewPost200Response, ApiV1SubscriptionsIdRefundPreviewPostRequest, GetBillingReports200ResponseInner, MoveSubscriptionSurfaceRequest, NewSubscription, ProcessRefund200Response, RefundRequest, Subscription, UpdateSubscription } from '../models/index';
-export interface ApiV1SubscriptionsIdRefundPreviewPostOperationRequest {
-    id: string;
-    apiV1SubscriptionsIdRefundPreviewPostRequest?: ApiV1SubscriptionsIdRefundPreviewPostRequest;
-}
+import type { GetBillingReports200ResponseInner, MoveSubscriptionSurfaceRequest, NewSubscription, ProcessRefund200Response, RefundRequest, Subscription, SubscriptionsIdRefundPreviewPost200Response, SubscriptionsIdRefundPreviewPostRequest, UpdateSubscription } from '../models/index';
 export interface CreateSubscriptionRequest {
     newSubscription: NewSubscription;
 }
@@ -47,6 +43,10 @@ export interface ProcessRefundRequest {
     id: string;
     refundRequest?: RefundRequest;
 }
+export interface SubscriptionsIdRefundPreviewPostOperationRequest {
+    id: string;
+    subscriptionsIdRefundPreviewPostRequest?: SubscriptionsIdRefundPreviewPostRequest;
+}
 export interface UpdateSubscriptionRequest {
     id: string;
     updateSubscription: UpdateSubscription;
@@ -55,16 +55,6 @@ export interface UpdateSubscriptionRequest {
  *
  */
 export declare class SubscriptionsApi extends runtime.BaseAPI {
-    /**
-     * Resolves the subscription\'s latest paid charge exactly as the refund endpoint does and returns the derived amount, the plan\'s credit rate and — for an organization subscription — the per-member clawback the refund would make, before any money moves. Writes nothing: no Stripe refund, no audit row, no idempotency entry. Every guard refusal the refund endpoint can raise is raised here identically, so a client can drive its confirm dialog off a successful preview.
-     * Preview this subscription\'s refund without issuing it (dry run)
-     */
-    apiV1SubscriptionsIdRefundPreviewPostRaw(requestParameters: ApiV1SubscriptionsIdRefundPreviewPostOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiV1SubscriptionsIdRefundPreviewPost200Response>>;
-    /**
-     * Resolves the subscription\'s latest paid charge exactly as the refund endpoint does and returns the derived amount, the plan\'s credit rate and — for an organization subscription — the per-member clawback the refund would make, before any money moves. Writes nothing: no Stripe refund, no audit row, no idempotency entry. Every guard refusal the refund endpoint can raise is raised here identically, so a client can drive its confirm dialog off a successful preview.
-     * Preview this subscription\'s refund without issuing it (dry run)
-     */
-    apiV1SubscriptionsIdRefundPreviewPost(requestParameters: ApiV1SubscriptionsIdRefundPreviewPostOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiV1SubscriptionsIdRefundPreviewPost200Response>;
     /**
      * Creates a new subscription. Admin only.
      * Create subscription
@@ -116,12 +106,12 @@ export declare class SubscriptionsApi extends runtime.BaseAPI {
      */
     getSubscriptionById(requestParameters: GetSubscriptionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Subscription>;
     /**
-     * Retrieves all subscriptions for a specific user.
+     * Retrieves all subscriptions for a specific user. Administrators only. An account reads its own plan and billing state through `GET /billing/users/{userId}/subscription`.
      * Get user subscriptions
      */
     getSubscriptionsByUserIdRaw(requestParameters: GetSubscriptionsByUserIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Subscription>>>;
     /**
-     * Retrieves all subscriptions for a specific user.
+     * Retrieves all subscriptions for a specific user. Administrators only. An account reads its own plan and billing state through `GET /billing/users/{userId}/subscription`.
      * Get user subscriptions
      */
     getSubscriptionsByUserId(requestParameters: GetSubscriptionsByUserIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Subscription>>;
@@ -145,6 +135,16 @@ export declare class SubscriptionsApi extends runtime.BaseAPI {
      * Process refund
      */
     processRefund(requestParameters: ProcessRefundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProcessRefund200Response>;
+    /**
+     * Resolves the subscription\'s latest paid charge exactly as the refund endpoint does and returns the derived amount, the plan\'s credit rate and — for an organization subscription — the per-member clawback the refund would make, before any money moves. Writes nothing: no Stripe refund, no audit row, no idempotency entry. Every guard refusal the refund endpoint can raise is raised here identically, so a client can drive its confirm dialog off a successful preview.
+     * Preview this subscription\'s refund without issuing it (dry run)
+     */
+    subscriptionsIdRefundPreviewPostRaw(requestParameters: SubscriptionsIdRefundPreviewPostOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionsIdRefundPreviewPost200Response>>;
+    /**
+     * Resolves the subscription\'s latest paid charge exactly as the refund endpoint does and returns the derived amount, the plan\'s credit rate and — for an organization subscription — the per-member clawback the refund would make, before any money moves. Writes nothing: no Stripe refund, no audit row, no idempotency entry. Every guard refusal the refund endpoint can raise is raised here identically, so a client can drive its confirm dialog off a successful preview.
+     * Preview this subscription\'s refund without issuing it (dry run)
+     */
+    subscriptionsIdRefundPreviewPost(requestParameters: SubscriptionsIdRefundPreviewPostOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionsIdRefundPreviewPost200Response>;
     /**
      * Updates an existing subscription. Admin only.
      * Update subscription