@leaflow/sdk 0.0.0-dev.43.g1ad4bd0 → 0.0.0-dev.433.g7e48b8f

package/dist/account/v1/generated/models.d.ts

@@ -0,0 +1,618 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Account API
+ * Everything that comes before a project is chosen: registration, the account itself, the projects the caller belongs to, and entry into one of them.
+ *
+ * ## Authentication
+ *
+ * Every request carries `Authorization: Bearer <access token>`, obtained by signing in at auth.leaflow.net. The endpoints that need no token say so.
+ *
+ * ## Entering a project
+ *
+ * 1. `QUERY /account/v1/projects` searches the projects the caller belongs to. The first call registers the account, taking the name and email address from the sign-in claims.
+ * 2. `POST /account/v1/projects/{projectId}/scoped-tokens` returns a scoped token for the project chosen.
+ * 3. Every other service is called with that scoped token.
+ *
+ * A scoped token cannot be renewed. Repeat step 2 for a new one, and sign in again at auth.leaflow.net once the access token itself has expired.
+ *
+ * ## Project slugs
+ *
+ * Every project carries a `slug`, the label naming it in its address. Until a custom slug is chosen the slug is the project's `id`, and the address under the `id` keeps working after a custom slug is chosen. `GET /account/v1/projects/by-slug/{slug}` finds the project named by either label.
+ *
+ * Looking up slugs and claiming custom slugs are rate limited per account. A request over the limit fails with 429, and `meta.retry_after_seconds` on the error states how many seconds to wait before retrying.
+ * OpenAPI spec version: 1.0.0
+ */
+export interface FieldViolation {
+    /** The path to the rejected field in the request body, such as `items[2].price_id`. */
+    field: string;
+    /** Why the field was rejected, such as `REQUIRED` or `OUT_OF_RANGE`. */
+    reason?: string;
+}
+/**
+ * Values that belong to `reason`, one set per reason. Clients use them to fill in
+ * localized text and never parse `message` to obtain them. Keys are documented per
+ * reason; a key that has appeared once keeps appearing.
+ */
+export type ErrorStatusMetadata = {
+    [key: string]: string;
+};
+export interface ErrorStatus {
+    /** The HTTP status code of the response. */
+    code: number;
+    /** The canonical name of the status, such as `INVALID_ARGUMENT` or `UNAVAILABLE`. */
+    status: string;
+    /**
+     * A description of the failure for developers. It is always English and is not meant
+     * to be shown to end users as is.
+     */
+    message: string;
+    /**
+     * A stable machine-readable code identifying the failure. Clients branch on this value
+     * and render their own text; it does not change once published.
+     */
+    reason?: string;
+    /**
+     * Values that belong to `reason`, one set per reason. Clients use them to fill in
+     * localized text and never parse `message` to obtain them. Keys are documented per
+     * reason; a key that has appeared once keeps appearing.
+     */
+    metadata?: ErrorStatusMetadata;
+    /**
+     * Request fields rejected by the request's constraints. Present on validation
+     * failures; one request may violate several fields.
+     */
+    field_violations?: FieldViolation[];
+    /**
+     * How long the client should wait before retrying, as a duration string such as
+     * `30s`. Present only when waiting can succeed.
+     */
+    retry_delay?: string;
+    /**
+     * The identifier of the request in the service's logs. Quote it when reporting a
+     * failure.
+     */
+    request_id?: string;
+}
+/**
+ * A failed request. The envelope follows the Google REST error format: `code` is the HTTP
+ * status, `status` is its canonical name, and `reason` is the stable machine-readable code
+ * that identifies the failure.
+ */
+export interface Error {
+    error: ErrorStatus;
+}
+/**
+ * VERIFIED_ONLY requires identity verification to have completed; a submission under review does not qualify
+ */
+export type SettingsResourceProjectCreationMode = (typeof SettingsResourceProjectCreationMode)[keyof typeof SettingsResourceProjectCreationMode];
+export declare const SettingsResourceProjectCreationMode: {
+    readonly OPEN: "OPEN";
+    readonly VERIFIED_ONLY: "VERIFIED_ONLY";
+    readonly CLOSED: "CLOSED";
+};
+/**
+ * INVITE_ONLY accepts only an email address holding a project invitation
+ */
+export type SettingsResourceRegistrationMode = (typeof SettingsResourceRegistrationMode)[keyof typeof SettingsResourceRegistrationMode];
+export declare const SettingsResourceRegistrationMode: {
+    readonly OPEN: "OPEN";
+    readonly INVITE_ONLY: "INVITE_ONLY";
+    readonly CLOSED: "CLOSED";
+};
+export interface SettingsResource {
+    /** Maximum number of members a project may hold; 0 means unlimited */
+    max_members_per_project: number;
+    /** Maximum number of projects an account may own; 0 means unlimited. Deleted projects do not count */
+    max_projects_per_user: number;
+    /** VERIFIED_ONLY requires identity verification to have completed; a submission under review does not qualify */
+    project_creation_mode: SettingsResourceProjectCreationMode;
+    /** INVITE_ONLY accepts only an email address holding a project invitation */
+    registration_mode: SettingsResourceRegistrationMode;
+}
+export type AgreementResourceType = (typeof AgreementResourceType)[keyof typeof AgreementResourceType];
+export declare const AgreementResourceType: {
+    readonly TERMS: "TERMS";
+    readonly PRIVACY: "PRIVACY";
+    readonly DPA: "DPA";
+};
+export interface AgreementResource {
+    /** From this moment on, registration requires this version */
+    effective_at: string;
+    type: AgreementResourceType;
+    /** Where the text is published */
+    url: string;
+    /** Send this value back unchanged when consenting */
+    version: string;
+}
+export interface AgreementListResponseBody {
+    /** @nullable */
+    items: AgreementResource[] | null;
+}
+/**
+ * OFFLINE is a consent given off the platform and recorded by an operator
+ */
+export type ConsentResourceMethod = (typeof ConsentResourceMethod)[keyof typeof ConsentResourceMethod];
+export declare const ConsentResourceMethod: {
+    readonly CLICKWRAP: "CLICKWRAP";
+    readonly OFFLINE: "OFFLINE";
+};
+export type ConsentResourceType = (typeof ConsentResourceType)[keyof typeof ConsentResourceType];
+export declare const ConsentResourceType: {
+    readonly TERMS: "TERMS";
+    readonly PRIVACY: "PRIVACY";
+    readonly DPA: "DPA";
+};
+export interface ConsentResource {
+    consented_at: string;
+    /** OFFLINE is a consent given off the platform and recorded by an operator */
+    method: ConsentResourceMethod;
+    type: ConsentResourceType;
+    version: string;
+}
+export interface ConsentListResponseBody {
+    /** @nullable */
+    items: ConsentResource[] | null;
+}
+export type ConsentBodyType = (typeof ConsentBodyType)[keyof typeof ConsentBodyType];
+export declare const ConsentBodyType: {
+    readonly TERMS: "TERMS";
+    readonly PRIVACY: "PRIVACY";
+    readonly DPA: "DPA";
+};
+export interface ConsentBody {
+    type: ConsentBodyType;
+    /**
+     * @minLength 1
+     * @maxLength 32
+     */
+    version: string;
+}
+export interface AcceptConsentsRequestBody {
+    /** @nullable */
+    consents: ConsentBody[] | null;
+}
+export type AccountResourceStatus = (typeof AccountResourceStatus)[keyof typeof AccountResourceStatus];
+export declare const AccountResourceStatus: {
+    readonly ACTIVE: "ACTIVE";
+    readonly SUSPENDED: "SUSPENDED";
+    readonly BANNED: "BANNED";
+    readonly DELETING: "DELETING";
+};
+export interface AccountResource {
+    created_at: string;
+    email: string;
+    /** @nullable */
+    email_verified_at: string | null;
+    /** Taken from the sign-in claims; may be empty */
+    first_name: string;
+    /** The subject issued by the identity provider */
+    id: string;
+    /** Taken from the sign-in claims; may be empty */
+    last_name: string;
+    /** ISO 3166-1 alpha-2. Empty on an account that registered before this was required; such an account continues to work and can set it from the settings page */
+    country?: string;
+    /** Empty while never set, in which case `Accept-Language` applies, and the platform default when that is absent as well */
+    locale?: string;
+    /** @nullable */
+    pending_agreements: AgreementResource[] | null;
+    status: AccountResourceStatus;
+}
+/**
+ * `none` while no deletion is open. `checking` while the services holding data for the account are asked whether it can be closed. `scheduled` once they agree; it is carried out at `scheduled_at` and can be cancelled until then. `executing` once `scheduled_at` has passed; it can no longer be cancelled
+ */
+export type AccountDeletionState = (typeof AccountDeletionState)[keyof typeof AccountDeletionState];
+export declare const AccountDeletionState: {
+    readonly none: "none";
+    readonly checking: "checking";
+    readonly scheduled: "scheduled";
+    readonly executing: "executing";
+};
+export type ProjectTraitResourceEffect = (typeof ProjectTraitResourceEffect)[keyof typeof ProjectTraitResourceEffect];
+export declare const ProjectTraitResourceEffect: {
+    readonly NoWrite: "NoWrite";
+    readonly NoAccess: "NoAccess";
+};
+export interface ProjectTraitResource {
+    key: string;
+    value: string;
+    effect: ProjectTraitResourceEffect;
+    reason: string;
+}
+/**
+ * `active` until deletion is requested; `deleting` while the resources under the project are being removed, when `deletion_requested_at` is set; `deleted` once removal has finished, when `deleted_at` is set
+ */
+export type ProjectStatus = (typeof ProjectStatus)[keyof typeof ProjectStatus];
+export declare const ProjectStatus: {
+    readonly active: "active";
+    readonly deleting: "deleting";
+    readonly deleted: "deleted";
+};
+export interface ProjectResource {
+    traits: ProjectTraitResource[];
+    /** @nullable */
+    deletion_requested_at: string | null;
+    created_at: string;
+    created_by: string;
+    /**
+     * When the project was deleted
+     * @nullable
+     */
+    deleted_at: string | null;
+    description: string;
+    id: string;
+    /**
+     * The label naming the project in its address. It equals `id` until a custom slug is chosen. A custom slug does not change once set, and stays with the project after deletion
+     * @minLength 1
+     * @maxLength 36
+     */
+    slug: string;
+    status: ProjectStatus;
+    name: string;
+    updated_at: string;
+}
+export interface AccountDeletionObjectionResource {
+    /** The service that refused, such as `billing` */
+    service: string;
+    /** A stable code defined by that service, such as `ARREARS`. The service documents what each code means and how to resolve it */
+    code: string;
+}
+export interface AccountDeletionResource {
+    state: AccountDeletionState;
+    /**
+     * Null while `state` is `none`
+     * @nullable
+     */
+    requested_at: string | null;
+    /**
+     * When the deletion is carried out. Null while `state` is `none`
+     * @nullable
+     */
+    scheduled_at: string | null;
+    /** True when an operator requested the deletion rather than the account holder. False while `state` is `none` */
+    requested_by_operator: boolean;
+    /** Projects the caller owns that are not being deleted. A deletion cannot be requested while this is not empty */
+    blocking_projects: ProjectResource[];
+    /**
+     * When the most recent request was turned down. Null unless the most recent request was turned down
+     * @nullable
+     */
+    rejected_at: string | null;
+    /** Why the most recent request was turned down. Empty unless `rejected_at` is set */
+    objections: AccountDeletionObjectionResource[];
+}
+/**
+ * The language used for the interface and for email. It is independent of `country`, and neither can be inferred from the other
+ */
+export type Locale = (typeof Locale)[keyof typeof Locale];
+export declare const Locale: {
+    readonly "zh-Hans": "zh-Hans";
+    readonly "zh-Hant-HK": "zh-Hant-HK";
+    readonly en: "en";
+};
+export interface RegisterRequestBody {
+    /**
+     * Must cover every agreement currently in force, at the versions returned by GET /account/v1/agreements
+     * @nullable
+     */
+    consents: ConsentBody[] | null;
+    /**
+     * ISO 3166-1 alpha-2 (CN, HK, US). Must denote a country or territory that exists; codes such as EU and ZZ hold a place in the standard without denoting one and are refused
+     * @minLength 2
+     * @maxLength 2
+     */
+    country: string;
+    locale: Locale;
+}
+export interface CountryOption {
+    /** ISO 3166-1 alpha-2, sent back unchanged at registration */
+    code: string;
+    /** The name rendered according to `Accept-Language` */
+    name: string;
+}
+export interface LanguageOption {
+    code: Locale;
+    /** The endonym of the language, written in that language itself. It does not follow `Accept-Language` */
+    name: string;
+}
+export interface LocaleOptionsResource {
+    countries: CountryOption[];
+    languages: LanguageOption[];
+}
+/**
+ * Both fields are optional, and an omitted field is left unchanged
+ */
+export interface UpdateAccountRequestBody {
+    /**
+     * As at registration
+     * @minLength 2
+     * @maxLength 2
+     */
+    country?: string;
+    locale?: Locale;
+}
+/**
+ * PERSONAL and ENTERPRISE are two kinds of subject rather than two levels, and are not ordered
+ */
+export type IdentityVerificationResourceStatus = (typeof IdentityVerificationResourceStatus)[keyof typeof IdentityVerificationResourceStatus];
+export declare const IdentityVerificationResourceStatus: {
+    readonly UNVERIFIED: "UNVERIFIED";
+    readonly PENDING: "PENDING";
+    readonly PERSONAL: "PERSONAL";
+    readonly ENTERPRISE: "ENTERPRISE";
+    readonly REJECTED: "REJECTED";
+};
+export interface IdentityVerificationResource {
+    reject_reason: string;
+    /** PERSONAL and ENTERPRISE are two kinds of subject rather than two levels, and are not ordered */
+    status: IdentityVerificationResourceStatus;
+    /** @nullable */
+    submitted_at: string | null;
+    /** @nullable */
+    verified_at: string | null;
+}
+export interface SubmitIdentityVerificationRequestBody {
+    /**
+     * The document number. It is returned by no endpoint, and one number cannot be attached to two accounts
+     * @minLength 6
+     * @maxLength 64
+     */
+    id_number: string;
+    /**
+     * The legal name. It is returned by no endpoint
+     * @minLength 1
+     * @maxLength 128
+     */
+    real_name: string;
+}
+/**
+ * What an invitation states before it is accepted. It carries neither the invitation id nor the full recipient address; the invitations listed against the current account are returned by `list-my-invitations`
+ */
+export interface InvitationPreviewResource {
+    /** The masked recipient address, enough for the recipient to recognise it */
+    email_masked: string;
+    expires_at: string;
+    /** The display name of the sender, or their email address when no name is set */
+    invited_by_name: string;
+    project_name: string;
+    /**
+     * The display names of the roles granted on acceptance
+     * @nullable
+     */
+    role_names: string[] | null;
+}
+export interface InvitationResource {
+    created_at: string;
+    email: string;
+    expires_at: string;
+    id: string;
+    /** The id of the account that issued the invitation */
+    invited_by: string;
+    /** The display name of that account, or its email address when no name is set. It reflects the value at the time of reading rather than at the time the invitation was sent */
+    invited_by_name: string;
+    project_id: string;
+    /** The name of the target project */
+    project_name: string;
+    /**
+     * The role codes granted on acceptance
+     * @nullable
+     */
+    roles: string[] | null;
+    /**
+     * The display names of those codes, in the same order
+     * @nullable
+     */
+    role_names: string[] | null;
+}
+export interface LengthAwarePageInvitationResource {
+    /** The items in this page */
+    items: InvitationResource[];
+    /** Maximum number of items in this page, echoing the request */
+    limit: number;
+    /** Number of items skipped, echoing the request */
+    offset: number;
+    /** Total number of matches, not only this page */
+    total: number;
+}
+export interface AcceptInvitationByTokenRequestBody {
+    /**
+     * The token carried by the invitation link
+     * @minLength 1
+     * @maxLength 128
+     */
+    token: string;
+}
+export interface AcceptedInvitationResponseBody {
+    project: ProjectResource;
+}
+export type RuleResourceEffect = (typeof RuleResourceEffect)[keyof typeof RuleResourceEffect];
+export declare const RuleResourceEffect: {
+    readonly allow: "allow";
+    readonly deny: "deny";
+};
+export interface ResourceRefResource {
+    /** A string rather than a UUID; a DNS zone, for one, is named by its domain. Matching is glob, so `*.example.com` covers a set of subdomains, while a value carrying no glob metacharacter matches exactly */
+    id: string;
+    /** Of the form compute:instance or dns:zone, in the same namespace as permission names */
+    type: string;
+}
+export interface RuleResource {
+    effect: RuleResourceEffect;
+    /**
+     * A trailing wildcard is supported (compute:instance.*), and must carry the service prefix
+     * @nullable
+     */
+    permissions: string[] | null;
+    /**
+     * Empty means the rule holds across the whole project. While it is not empty the rule holds only on those resources, and therefore answers no project-level question
+     * @nullable
+     */
+    resources: ResourceRefResource[] | null;
+}
+export interface GrantResource {
+    admin: boolean;
+    owner: boolean;
+    /**
+     * The role codes held, for display only
+     * @nullable
+     */
+    roles: string[] | null;
+    /**
+     * **Do not walk these rules to reach a decision.** They are compiled from every policy that applies to the caller, and serve to render what a user may do. Each request is decided by the service handling it
+     * @nullable
+     */
+    rules: RuleResource[] | null;
+}
+export interface ProjectAccessResource {
+    grant: GrantResource;
+    project: ProjectResource;
+}
+export interface LengthAwarePageProjectAccessResource {
+    /** The items in this page */
+    items: ProjectAccessResource[];
+    /** Maximum number of items in this page, echoing the request */
+    limit: number;
+    /** Number of items skipped, echoing the request */
+    offset: number;
+    /** Total number of matches, not only this page */
+    total: number;
+}
+export interface CreateProjectRequestBody {
+    /** @maxLength 2000 */
+    description?: string;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    /**
+     * A custom slug of 6 to 32 characters made of lower-case letters, digits and single hyphens, beginning with a letter and ending with a letter or digit. Omitted or empty, the slug is the new project's `id`, and a custom slug can be set once later
+     * @maxLength 32
+     */
+    slug?: string;
+}
+export interface SearchProjectsRequestBody {
+    /**
+     * Matches against name, slug or description, and against the id when it is a complete project id
+     * @maxLength 128
+     */
+    keyword?: string;
+    /**
+     * The statuses to include. Omitted, only `active` projects are returned
+     * @minItems 1
+     */
+    statuses?: ProjectStatus[];
+    /**
+     * 1-based page number. Defaults to 1
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+}
+/**
+ * Pagination metadata for stable numbered pages. total_count is returned only when the operation can determine it without an unbounded scan.
+ */
+export interface OffsetPagination {
+    /** @minimum 1 */
+    page: number;
+    /** @minimum 1 */
+    page_size: number;
+    /** @minimum 0 */
+    total_count?: number;
+}
+export interface ProjectAccessList {
+    items: ProjectAccessResource[];
+    pagination: OffsetPagination;
+}
+/**
+ * `available` when the slug can be chosen now, `reserved` when the name is reserved, and `taken` when a project, including a deleted one, holds it
+ */
+export type ProjectSlugAvailabilityResourceStatus = (typeof ProjectSlugAvailabilityResourceStatus)[keyof typeof ProjectSlugAvailabilityResourceStatus];
+export declare const ProjectSlugAvailabilityResourceStatus: {
+    readonly available: "available";
+    readonly reserved: "reserved";
+    readonly taken: "taken";
+};
+export interface ProjectSlugAvailabilityResource {
+    /** The slug asked about */
+    slug: string;
+    /** `available` when the slug can be chosen now, `reserved` when the name is reserved, and `taken` when a project, including a deleted one, holds it */
+    status: ProjectSlugAvailabilityResourceStatus;
+}
+export interface ScopedTokenResponseBody {
+    /** When the token expires. Exchange for a new one before then rather than waiting for the first 401 */
+    expires_at: string;
+    /** Seconds remaining before expiry */
+    expires_in: number;
+    /** **A snapshot taken at the moment of the exchange. It is not carried in the token, and must not be cached.** It serves to render what a user may do; each request is decided again */
+    grant: GrantResource;
+    /** The project itself, so that no further lookup is needed after the exchange */
+    project: ProjectResource;
+    /** The scoped token, to be sent as `Authorization: Bearer` */
+    token: string;
+    /** Always `Bearer` */
+    token_type: string;
+}
+/**
+ * Pagination metadata for keyset traversal. Pass next_cursor as cursor to read the following page; null means there is no following page.
+ */
+export interface CursorPagination {
+    /** @minimum 1 */
+    page_size: number;
+    /** @nullable */
+    next_cursor?: string | null;
+}
+export type RequestAccountDeletionParams = {
+    /**
+     * Must be true. Confirms that any remaining balance and prepaid benefits are forfeited when the deletion is carried out.
+     */
+    acknowledge_forfeiture: true;
+};
+export type ListMyInvitationsParams = {
+    /**
+     * Items returned in this page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+    /**
+     * Items to skip. Defaults to 0; at most 10000.
+     * @minimum 0
+     * @maximum 10000
+     */
+    offset?: number;
+};
+export type PreviewInvitationByTokenParams = {
+    /**
+     * The token carried by the invitation link
+     * @minLength 1
+     * @maxLength 128
+     */
+    token: string;
+};
+export type ListProjectsParams = {
+    /**
+     * Items returned in this page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+    /**
+     * Items to skip. Defaults to 0; at most 10000.
+     * @minimum 0
+     * @maximum 10000
+     */
+    offset?: number;
+    /**
+     * Matches against name, slug or description, and against the id when it is a complete project id
+     * @maxLength 128
+     */
+    keyword?: string;
+    include_deleted?: boolean;
+};

package/dist/account/v1/generated/models.js

@@ -0,0 +1,71 @@
+export const SettingsResourceProjectCreationMode = {
+    OPEN: "OPEN",
+    VERIFIED_ONLY: "VERIFIED_ONLY",
+    CLOSED: "CLOSED",
+};
+export const SettingsResourceRegistrationMode = {
+    OPEN: "OPEN",
+    INVITE_ONLY: "INVITE_ONLY",
+    CLOSED: "CLOSED",
+};
+export const AgreementResourceType = {
+    TERMS: "TERMS",
+    PRIVACY: "PRIVACY",
+    DPA: "DPA",
+};
+export const ConsentResourceMethod = {
+    CLICKWRAP: "CLICKWRAP",
+    OFFLINE: "OFFLINE",
+};
+export const ConsentResourceType = {
+    TERMS: "TERMS",
+    PRIVACY: "PRIVACY",
+    DPA: "DPA",
+};
+export const ConsentBodyType = {
+    TERMS: "TERMS",
+    PRIVACY: "PRIVACY",
+    DPA: "DPA",
+};
+export const AccountResourceStatus = {
+    ACTIVE: "ACTIVE",
+    SUSPENDED: "SUSPENDED",
+    BANNED: "BANNED",
+    DELETING: "DELETING",
+};
+export const AccountDeletionState = {
+    none: "none",
+    checking: "checking",
+    scheduled: "scheduled",
+    executing: "executing",
+};
+export const ProjectTraitResourceEffect = {
+    NoWrite: "NoWrite",
+    NoAccess: "NoAccess",
+};
+export const ProjectStatus = {
+    active: "active",
+    deleting: "deleting",
+    deleted: "deleted",
+};
+export const Locale = {
+    "zh-Hans": "zh-Hans",
+    "zh-Hant-HK": "zh-Hant-HK",
+    en: "en",
+};
+export const IdentityVerificationResourceStatus = {
+    UNVERIFIED: "UNVERIFIED",
+    PENDING: "PENDING",
+    PERSONAL: "PERSONAL",
+    ENTERPRISE: "ENTERPRISE",
+    REJECTED: "REJECTED",
+};
+export const RuleResourceEffect = {
+    allow: "allow",
+    deny: "deny",
+};
+export const ProjectSlugAvailabilityResourceStatus = {
+    available: "available",
+    reserved: "reserved",
+    taken: "taken",
+};