@leaflow/sdk 0.121.0 → 0.122.0

package/dist/membership/v1/generated/functions.d.ts

@@ -0,0 +1,224 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Membership API
+ * Membership plans and the memberships held by billing accounts.
+ *
+ * A membership is a prepaid subscription sold through Billing. For each paid period it issues the plan's benefits to the billing account. A plan can carry several benefits across services: credit for chosen services, coupons on purchases and metered usage, and usage allowances such as model tokens, and access to features of other services. Benefits are shared by every project paid for by the account.
+ *
+ * ## Authentication
+ *
+ * Plans are public. Memberships require an access token; see the `accessTokenAuth` security scheme. Only the owner of a billing account can read or change its membership; anyone else receives 403 `MEMBERSHIP_ACCOUNT_FORBIDDEN`.
+ *
+ * ## Conventions
+ *
+ * - **One membership per billing account.** A pending or active membership must end before another is bought; change plans with upgrade and downgrade instead.
+ * - **Payment goes through Billing.** Purchases and upgrades return a Billing order. With `checkout.mode` `deferred`, pay the order's invoice through Billing. Benefits are issued once Billing reports the order ready; every order has an invoice, including a zero-total one, which is paid automatically.
+ * - **Cancellation and auto-renewal are managed in Billing** on the membership's `subscription_id`. A cancellation takes effect at the end of the paid period without a refund, and the period's benefits remain until then.
+ * - **An upgrade takes effect immediately** for the full difference between the two plans' period prices, whatever remains of the period. The difference in credit is issued in full and the new plan's discount applies from payment. Renewals are charged at the new plan's price.
+ * - **A downgrade takes effect at the end of the paid period.** The current period keeps its benefits and nothing is refunded.
+ * - **Amounts are decimal strings** in the billing account's currency. There is no currency conversion: a plan without a price or credit in the account's currency cannot be bought with it.
+ * OpenAPI spec version: 1.0.0
+ */
+import type { ErrorResponse, GetPlanParams, ListMembershipPeriodsParams, ListMembershipsParams, ListPlansParams, Membership, MembershipCreate, MembershipDowngrade, MembershipList, MembershipPurchase, MembershipUpgrade, PeriodList, Plan, PlanList } from "./models.js";
+export type HTTPStatusCode1xx = 100 | 101 | 102 | 103;
+export type HTTPStatusCode2xx = 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207;
+export type HTTPStatusCode3xx = 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308;
+export type HTTPStatusCode4xx = 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 419 | 420 | 421 | 422 | 423 | 424 | 426 | 428 | 429 | 431 | 451;
+export type HTTPStatusCode5xx = 500 | 501 | 502 | 503 | 504 | 505 | 507 | 511;
+export type HTTPStatusCodes = HTTPStatusCode1xx | HTTPStatusCode2xx | HTTPStatusCode3xx | HTTPStatusCode4xx | HTTPStatusCode5xx;
+export type listPlansResponse200 = {
+    data: PlanList;
+    status: 200;
+};
+export type listPlansResponseDefault = {
+    data: ErrorResponse;
+    status: Exclude<HTTPStatusCodes, 200>;
+};
+export type listPlansResponseSuccess = listPlansResponse200 & {
+    headers: Headers;
+};
+export type listPlansResponseError = listPlansResponseDefault & {
+    headers: Headers;
+};
+export type listPlansResponse = listPlansResponseSuccess | listPlansResponseError;
+export declare const getListPlansUrl: (params?: ListPlansParams) => string;
+/**
+ * Lists the plans on sale, in ascending rank, with their prices and benefits. No authentication is required.
+ * @summary List plans
+ */
+export declare const listPlans: (params?: ListPlansParams, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<listPlansResponse>;
+export type getPlanResponse200 = {
+    data: Plan;
+    status: 200;
+};
+export type getPlanResponseDefault = {
+    data: ErrorResponse;
+    status: Exclude<HTTPStatusCodes, 200>;
+};
+export type getPlanResponseSuccess = getPlanResponse200 & {
+    headers: Headers;
+};
+export type getPlanResponseError = getPlanResponseDefault & {
+    headers: Headers;
+};
+export type getPlanResponse = getPlanResponseSuccess | getPlanResponseError;
+export declare const getGetPlanUrl: (planId: string, params?: GetPlanParams) => string;
+/**
+ * Returns a plan on sale with its prices and benefits. No authentication is required.
+ * @summary Get a plan
+ */
+export declare const getPlan: (planId: string, params?: GetPlanParams, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<getPlanResponse>;
+export type listMembershipsResponse200 = {
+    data: MembershipList;
+    status: 200;
+};
+export type listMembershipsResponseDefault = {
+    data: ErrorResponse;
+    status: Exclude<HTTPStatusCodes, 200>;
+};
+export type listMembershipsResponseSuccess = listMembershipsResponse200 & {
+    headers: Headers;
+};
+export type listMembershipsResponseError = listMembershipsResponseDefault & {
+    headers: Headers;
+};
+export type listMembershipsResponse = listMembershipsResponseSuccess | listMembershipsResponseError;
+export declare const getListMembershipsUrl: (params: ListMembershipsParams) => string;
+/**
+ * Lists the memberships of a billing account you own, newest first, including ended ones.
+ * @summary List memberships
+ */
+export declare const listMemberships: (params: ListMembershipsParams, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<listMembershipsResponse>;
+export type createMembershipResponse201 = {
+    data: MembershipPurchase;
+    status: 201;
+};
+export type createMembershipResponseDefault = {
+    data: ErrorResponse;
+    status: Exclude<HTTPStatusCodes, 201>;
+};
+export type createMembershipResponseSuccess = createMembershipResponse201 & {
+    headers: Headers;
+};
+export type createMembershipResponseError = createMembershipResponseDefault & {
+    headers: Headers;
+};
+export type createMembershipResponse = createMembershipResponseSuccess | createMembershipResponseError;
+export declare const getCreateMembershipUrl: () => string;
+/**
+ * Places a Billing order for the plan's price on a billing account you own, and returns the pending membership with the order.
+ * The membership becomes active, and its first period's benefits are issued, once Billing reports the order ready.
+ *
+ * Fails with 409 `MEMBERSHIP_EXISTS` when the account already has a pending or active membership, and with 422 `MEMBERSHIP_PLAN_UNAVAILABLE` when the plan is not on sale or has no price or credit in the account's currency. Billing refusals, such as `BILLING_INSUFFICIENT_FUNDS`, are returned as Billing reports them.
+ * @summary Buy a membership
+ */
+export declare const createMembership: (membershipCreate: MembershipCreate, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<createMembershipResponse>;
+export type getMembershipResponse200 = {
+    data: Membership;
+    status: 200;
+};
+export type getMembershipResponseDefault = {
+    data: ErrorResponse;
+    status: Exclude<HTTPStatusCodes, 200>;
+};
+export type getMembershipResponseSuccess = getMembershipResponse200 & {
+    headers: Headers;
+};
+export type getMembershipResponseError = getMembershipResponseDefault & {
+    headers: Headers;
+};
+export type getMembershipResponse = getMembershipResponseSuccess | getMembershipResponseError;
+export declare const getGetMembershipUrl: (membershipId: string) => string;
+/**
+ * @summary Get a membership
+ */
+export declare const getMembership: (membershipId: string, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<getMembershipResponse>;
+export type listMembershipPeriodsResponse200 = {
+    data: PeriodList;
+    status: 200;
+};
+export type listMembershipPeriodsResponseDefault = {
+    data: ErrorResponse;
+    status: Exclude<HTTPStatusCodes, 200>;
+};
+export type listMembershipPeriodsResponseSuccess = listMembershipPeriodsResponse200 & {
+    headers: Headers;
+};
+export type listMembershipPeriodsResponseError = listMembershipPeriodsResponseDefault & {
+    headers: Headers;
+};
+export type listMembershipPeriodsResponse = listMembershipPeriodsResponseSuccess | listMembershipPeriodsResponseError;
+export declare const getListMembershipPeriodsUrl: (membershipId: string, params?: ListMembershipPeriodsParams) => string;
+/**
+ * Lists the paid periods of a membership, newest first, each with the benefits issued for it.
+ * @summary List membership periods
+ */
+export declare const listMembershipPeriods: (membershipId: string, params?: ListMembershipPeriodsParams, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<listMembershipPeriodsResponse>;
+export type upgradeMembershipResponse201 = {
+    data: MembershipPurchase;
+    status: 201;
+};
+export type upgradeMembershipResponseDefault = {
+    data: ErrorResponse;
+    status: Exclude<HTTPStatusCodes, 201>;
+};
+export type upgradeMembershipResponseSuccess = upgradeMembershipResponse201 & {
+    headers: Headers;
+};
+export type upgradeMembershipResponseError = upgradeMembershipResponseDefault & {
+    headers: Headers;
+};
+export type upgradeMembershipResponse = upgradeMembershipResponseSuccess | upgradeMembershipResponseError;
+export declare const getUpgradeMembershipUrl: (membershipId: string) => string;
+/**
+ * Places a Billing order for the full difference between the current and the chosen plan's period prices. Once Billing reports it ready, the membership moves to the chosen plan for the rest of the period: the difference in credit is issued and the new plan's discount and allowances apply. Renewals are charged at the chosen plan's price.
+ *
+ * Fails with 409 `MEMBERSHIP_NOT_ACTIVE` unless the membership is active, and with 422 `MEMBERSHIP_UPGRADE_UNAVAILABLE` when the chosen plan does not rank above the current one or no upgrade is priced in the account's currency. A pending upgrade or a scheduled downgrade must finish or be canceled first (409 `MEMBERSHIP_CHANGE_PENDING`).
+ * @summary Upgrade a membership
+ */
+export declare const upgradeMembership: (membershipId: string, membershipUpgrade: MembershipUpgrade, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<upgradeMembershipResponse>;
+export type scheduleMembershipDowngradeResponse200 = {
+    data: Membership;
+    status: 200;
+};
+export type scheduleMembershipDowngradeResponseDefault = {
+    data: ErrorResponse;
+    status: Exclude<HTTPStatusCodes, 200>;
+};
+export type scheduleMembershipDowngradeResponseSuccess = scheduleMembershipDowngradeResponse200 & {
+    headers: Headers;
+};
+export type scheduleMembershipDowngradeResponseError = scheduleMembershipDowngradeResponseDefault & {
+    headers: Headers;
+};
+export type scheduleMembershipDowngradeResponse = scheduleMembershipDowngradeResponseSuccess | scheduleMembershipDowngradeResponseError;
+export declare const getScheduleMembershipDowngradeUrl: (membershipId: string) => string;
+/**
+ * Schedules a move to a lower-ranked plan at the end of the paid period. Nothing is charged or refunded and the current period keeps its benefits. The membership's `scheduled_plan` shows the pending move.
+ *
+ * Fails with 409 `MEMBERSHIP_NOT_ACTIVE` unless the membership is active, 409 `MEMBERSHIP_CHANGE_PENDING` while another change is pending, and 422 `MEMBERSHIP_DOWNGRADE_INVALID` when the chosen plan does not rank below the current one or has no price in the account's currency for the membership's billing interval.
+ * @summary Schedule a downgrade
+ */
+export declare const scheduleMembershipDowngrade: (membershipId: string, membershipDowngrade: MembershipDowngrade, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<scheduleMembershipDowngradeResponse>;
+export type cancelMembershipDowngradeResponse200 = {
+    data: Membership;
+    status: 200;
+};
+export type cancelMembershipDowngradeResponseDefault = {
+    data: ErrorResponse;
+    status: Exclude<HTTPStatusCodes, 200>;
+};
+export type cancelMembershipDowngradeResponseSuccess = cancelMembershipDowngradeResponse200 & {
+    headers: Headers;
+};
+export type cancelMembershipDowngradeResponseError = cancelMembershipDowngradeResponseDefault & {
+    headers: Headers;
+};
+export type cancelMembershipDowngradeResponse = cancelMembershipDowngradeResponseSuccess | cancelMembershipDowngradeResponseError;
+export declare const getCancelMembershipDowngradeUrl: (membershipId: string) => string;
+/**
+ * Keeps the current plan at renewal. Fails with 409 `MEMBERSHIP_CHANGE_PENDING` when no downgrade is scheduled.
+ * @summary Cancel a scheduled downgrade
+ */
+export declare const cancelMembershipDowngrade: (membershipId: string, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<cancelMembershipDowngradeResponse>;

package/dist/membership/v1/generated/functions.js

@@ -0,0 +1,237 @@
+export const getListPlansUrl = (params) => {
+    const normalizedParams = new URLSearchParams();
+    Object.entries(params || {}).forEach(([key, value]) => {
+        if (value !== undefined) {
+            normalizedParams.append(key, value === null ? "null" : String(value));
+        }
+    });
+    const stringifiedParams = normalizedParams.toString();
+    return stringifiedParams.length > 0
+        ? `https://membership.leaflow.cloud/api/v1/plans?${stringifiedParams}`
+        : `https://membership.leaflow.cloud/api/v1/plans`;
+};
+/**
+ * Lists the plans on sale, in ascending rank, with their prices and benefits. No authentication is required.
+ * @summary List plans
+ */
+export const listPlans = async (params, options, fetchFn) => {
+    const res = await (fetchFn ?? fetch)(getListPlansUrl(params), {
+        ...options,
+        method: "GET",
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};
+export const getGetPlanUrl = (planId, params) => {
+    const normalizedParams = new URLSearchParams();
+    Object.entries(params || {}).forEach(([key, value]) => {
+        if (value !== undefined) {
+            normalizedParams.append(key, value === null ? "null" : String(value));
+        }
+    });
+    const stringifiedParams = normalizedParams.toString();
+    return stringifiedParams.length > 0
+        ? `https://membership.leaflow.cloud/api/v1/plans/${encodeURIComponent(String(planId))}?${stringifiedParams}`
+        : `https://membership.leaflow.cloud/api/v1/plans/${encodeURIComponent(String(planId))}`;
+};
+/**
+ * Returns a plan on sale with its prices and benefits. No authentication is required.
+ * @summary Get a plan
+ */
+export const getPlan = async (planId, params, options, fetchFn) => {
+    const res = await (fetchFn ?? fetch)(getGetPlanUrl(planId, params), {
+        ...options,
+        method: "GET",
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};
+export const getListMembershipsUrl = (params) => {
+    const normalizedParams = new URLSearchParams();
+    Object.entries(params || {}).forEach(([key, value]) => {
+        if (value !== undefined) {
+            normalizedParams.append(key, value === null ? "null" : String(value));
+        }
+    });
+    const stringifiedParams = normalizedParams.toString();
+    return stringifiedParams.length > 0
+        ? `https://membership.leaflow.cloud/api/v1/memberships?${stringifiedParams}`
+        : `https://membership.leaflow.cloud/api/v1/memberships`;
+};
+/**
+ * Lists the memberships of a billing account you own, newest first, including ended ones.
+ * @summary List memberships
+ */
+export const listMemberships = async (params, options, fetchFn) => {
+    const res = await (fetchFn ?? fetch)(getListMembershipsUrl(params), {
+        ...options,
+        method: "GET",
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};
+export const getCreateMembershipUrl = () => {
+    return `https://membership.leaflow.cloud/api/v1/memberships`;
+};
+/**
+ * Places a Billing order for the plan's price on a billing account you own, and returns the pending membership with the order.
+ * The membership becomes active, and its first period's benefits are issued, once Billing reports the order ready.
+ *
+ * Fails with 409 `MEMBERSHIP_EXISTS` when the account already has a pending or active membership, and with 422 `MEMBERSHIP_PLAN_UNAVAILABLE` when the plan is not on sale or has no price or credit in the account's currency. Billing refusals, such as `BILLING_INSUFFICIENT_FUNDS`, are returned as Billing reports them.
+ * @summary Buy a membership
+ */
+export const createMembership = async (membershipCreate, options, fetchFn) => {
+    const getHeaders = (h) => {
+        if (!h)
+            return {};
+        if (h instanceof Headers)
+            return Object.fromEntries(h.entries());
+        if (Symbol.iterator in h) {
+            return Object.fromEntries(Array.from(h, (entry) => Array.from(entry)));
+        }
+        const headers = {};
+        for (const [name, value] of Object.entries(h)) {
+            if (value !== undefined)
+                headers[name] = value;
+        }
+        return headers;
+    };
+    const res = await (fetchFn ?? fetch)(getCreateMembershipUrl(), {
+        ...options,
+        method: "POST",
+        headers: { "Content-Type": "application/json", ...getHeaders(options?.headers) },
+        body: JSON.stringify(membershipCreate),
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};
+export const getGetMembershipUrl = (membershipId) => {
+    return `https://membership.leaflow.cloud/api/v1/memberships/${encodeURIComponent(String(membershipId))}`;
+};
+/**
+ * @summary Get a membership
+ */
+export const getMembership = async (membershipId, options, fetchFn) => {
+    const res = await (fetchFn ?? fetch)(getGetMembershipUrl(membershipId), {
+        ...options,
+        method: "GET",
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};
+export const getListMembershipPeriodsUrl = (membershipId, params) => {
+    const normalizedParams = new URLSearchParams();
+    Object.entries(params || {}).forEach(([key, value]) => {
+        if (value !== undefined) {
+            normalizedParams.append(key, value === null ? "null" : String(value));
+        }
+    });
+    const stringifiedParams = normalizedParams.toString();
+    return stringifiedParams.length > 0
+        ? `https://membership.leaflow.cloud/api/v1/memberships/${encodeURIComponent(String(membershipId))}/periods?${stringifiedParams}`
+        : `https://membership.leaflow.cloud/api/v1/memberships/${encodeURIComponent(String(membershipId))}/periods`;
+};
+/**
+ * Lists the paid periods of a membership, newest first, each with the benefits issued for it.
+ * @summary List membership periods
+ */
+export const listMembershipPeriods = async (membershipId, params, options, fetchFn) => {
+    const res = await (fetchFn ?? fetch)(getListMembershipPeriodsUrl(membershipId, params), {
+        ...options,
+        method: "GET",
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};
+export const getUpgradeMembershipUrl = (membershipId) => {
+    return `https://membership.leaflow.cloud/api/v1/memberships/${encodeURIComponent(String(membershipId))}/upgrade`;
+};
+/**
+ * Places a Billing order for the full difference between the current and the chosen plan's period prices. Once Billing reports it ready, the membership moves to the chosen plan for the rest of the period: the difference in credit is issued and the new plan's discount and allowances apply. Renewals are charged at the chosen plan's price.
+ *
+ * Fails with 409 `MEMBERSHIP_NOT_ACTIVE` unless the membership is active, and with 422 `MEMBERSHIP_UPGRADE_UNAVAILABLE` when the chosen plan does not rank above the current one or no upgrade is priced in the account's currency. A pending upgrade or a scheduled downgrade must finish or be canceled first (409 `MEMBERSHIP_CHANGE_PENDING`).
+ * @summary Upgrade a membership
+ */
+export const upgradeMembership = async (membershipId, membershipUpgrade, options, fetchFn) => {
+    const getHeaders = (h) => {
+        if (!h)
+            return {};
+        if (h instanceof Headers)
+            return Object.fromEntries(h.entries());
+        if (Symbol.iterator in h) {
+            return Object.fromEntries(Array.from(h, (entry) => Array.from(entry)));
+        }
+        const headers = {};
+        for (const [name, value] of Object.entries(h)) {
+            if (value !== undefined)
+                headers[name] = value;
+        }
+        return headers;
+    };
+    const res = await (fetchFn ?? fetch)(getUpgradeMembershipUrl(membershipId), {
+        ...options,
+        method: "POST",
+        headers: { "Content-Type": "application/json", ...getHeaders(options?.headers) },
+        body: JSON.stringify(membershipUpgrade),
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};
+export const getScheduleMembershipDowngradeUrl = (membershipId) => {
+    return `https://membership.leaflow.cloud/api/v1/memberships/${encodeURIComponent(String(membershipId))}/downgrade`;
+};
+/**
+ * Schedules a move to a lower-ranked plan at the end of the paid period. Nothing is charged or refunded and the current period keeps its benefits. The membership's `scheduled_plan` shows the pending move.
+ *
+ * Fails with 409 `MEMBERSHIP_NOT_ACTIVE` unless the membership is active, 409 `MEMBERSHIP_CHANGE_PENDING` while another change is pending, and 422 `MEMBERSHIP_DOWNGRADE_INVALID` when the chosen plan does not rank below the current one or has no price in the account's currency for the membership's billing interval.
+ * @summary Schedule a downgrade
+ */
+export const scheduleMembershipDowngrade = async (membershipId, membershipDowngrade, options, fetchFn) => {
+    const getHeaders = (h) => {
+        if (!h)
+            return {};
+        if (h instanceof Headers)
+            return Object.fromEntries(h.entries());
+        if (Symbol.iterator in h) {
+            return Object.fromEntries(Array.from(h, (entry) => Array.from(entry)));
+        }
+        const headers = {};
+        for (const [name, value] of Object.entries(h)) {
+            if (value !== undefined)
+                headers[name] = value;
+        }
+        return headers;
+    };
+    const res = await (fetchFn ?? fetch)(getScheduleMembershipDowngradeUrl(membershipId), {
+        ...options,
+        method: "POST",
+        headers: { "Content-Type": "application/json", ...getHeaders(options?.headers) },
+        body: JSON.stringify(membershipDowngrade),
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};
+export const getCancelMembershipDowngradeUrl = (membershipId) => {
+    return `https://membership.leaflow.cloud/api/v1/memberships/${encodeURIComponent(String(membershipId))}/downgrade`;
+};
+/**
+ * Keeps the current plan at renewal. Fails with 409 `MEMBERSHIP_CHANGE_PENDING` when no downgrade is scheduled.
+ * @summary Cancel a scheduled downgrade
+ */
+export const cancelMembershipDowngrade = async (membershipId, options, fetchFn) => {
+    const res = await (fetchFn ?? fetch)(getCancelMembershipDowngradeUrl(membershipId), {
+        ...options,
+        method: "DELETE",
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};