@lumeweb/portal-sdk 0.0.2 → 0.1.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Hammer Technologies LLC
+Copyright (c) 2024-2026 Hammer Technologies LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/dist/esm/account/generated/accountAPI.schemas.d.ts

@@ -0,0 +1,646 @@
+//#region src/account/generated/accountAPI.schemas.d.ts
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Account API
+ * API endpoints for managing user accounts, authentication, and API keys.
+ * OpenAPI spec version: v0.2.7-0.20260418132608-572560c6efd0
+ */
+interface APIEndpointInfoResponse {
+  method: string;
+  path: string;
+}
+interface APIKeyCreateRequest {
+  name: string;
+}
+type BinaryUUID = string;
+interface APIKeyResponse {
+  created_at: string;
+  name: string;
+  uuid: BinaryUUID;
+}
+interface APIKeyListResponse {
+  data: APIKeyResponse[];
+  total: number;
+}
+interface AccessModelDef {
+  key: string;
+  value: string;
+}
+interface AccessModel {
+  matchers: AccessModelDef;
+  policy_definition: AccessModelDef;
+  policy_effect: AccessModelDef;
+  request_definition: AccessModelDef;
+  role_definition: AccessModelDef;
+}
+interface AccessPolicy {
+  act: string;
+  dom: string;
+  obj: string;
+  sub: string;
+}
+interface AccountInfoResponse {
+  avatar?: string;
+  created_at?: string;
+  email: string;
+  first_name: string;
+  id: number;
+  last_name: string;
+  otp: boolean;
+  verified: boolean;
+}
+interface AccountPermissionsResponse {
+  model: AccessModel;
+  permissions: AccessPolicy[];
+}
+interface Decimal {
+  [key: string]: unknown;
+}
+interface BalanceResponse {
+  balance: Decimal;
+  user_id: number;
+}
+interface ChangePlanRequest {
+  period_id: number;
+}
+interface CheckoutSessionStatusResponse {
+  customer_email: string;
+  session_id: string;
+  status: string;
+  user_id: number;
+}
+type CheckoutUIFragmentMetadata = {
+  [key: string]: unknown;
+};
+interface CheckoutUIFragment {
+  css?: string;
+  html?: string;
+  link?: string;
+  metadata?: CheckoutUIFragmentMetadata;
+  script?: string;
+  type: string;
+}
+type CheckoutUIResponseMetadata = {
+  [key: string]: unknown;
+};
+interface CheckoutUIResponse {
+  expires_at: string;
+  fragments: CheckoutUIFragment[];
+  metadata?: CheckoutUIResponseMetadata;
+  session_id?: string;
+}
+interface CreateAPIKeyResponse {
+  name: string;
+  token: string;
+  uuid: BinaryUUID;
+}
+interface Error {
+  error: string;
+  message: string;
+  namespace: string;
+}
+interface ErrorResponse {
+  error: string;
+}
+interface GatewayAbilities {
+  checkout: boolean;
+  customer_portal: boolean;
+  session_status: boolean;
+}
+interface GatewayPublicInfo {
+  abilities: GatewayAbilities;
+  description: string;
+  id: string;
+  is_active: boolean;
+  logo_url: string;
+  name: string;
+}
+type GatewayListResponse = GatewayPublicInfo[];
+interface LoginRequest {
+  email: string;
+  password: string;
+  remember: boolean;
+}
+interface LoginResponse {
+  otp?: boolean;
+  token: string;
+}
+type ManagementCapabilitiesResponseAdminOperations = {
+  [key: string]: boolean;
+};
+type ManagementCapabilitiesResponseOperations = {
+  [key: string]: boolean;
+};
+interface ManagementCapabilitiesResponse {
+  admin_operations: ManagementCapabilitiesResponseAdminOperations;
+  management_mode: string;
+  operations: ManagementCapabilitiesResponseOperations;
+}
+interface ManagementRequest {
+  operation: string;
+}
+interface ManagementResultResponse {
+  action: string;
+  api_endpoint?: APIEndpointInfoResponse;
+  can_abort: boolean;
+  confirmation_message?: string;
+  effective_time?: string;
+  error_message?: string;
+  requires_confirmation: boolean;
+  status: string;
+  url?: string;
+}
+interface OTPDisableRequest {
+  password: string;
+}
+interface OTPGenerateResponse {
+  otp: string;
+}
+interface OTPValidateRequest {
+  otp: string;
+}
+interface OTPVerifyRequest {
+  otp: string;
+}
+interface OperationDetailResponse {
+  cid?: string;
+  current_step?: number;
+  error?: string;
+  estimated_completion_at?: string;
+  id: number;
+  operation: string;
+  operation_display_name: string;
+  progress_percent: number;
+  protocol: string;
+  protocol_display_name: string;
+  started_at: string;
+  status: string;
+  status_display_name: string;
+  status_message: string;
+  total_steps?: number;
+  updated_at: string;
+}
+interface OperationFilterItem {
+  description?: string;
+  name: string;
+  value: string;
+}
+interface OperationFiltersResponseData {
+  operations: OperationFilterItem[];
+  protocols: OperationFilterItem[];
+  statuses: OperationFilterItem[];
+}
+interface OperationFiltersResponse {
+  data: OperationFiltersResponseData;
+}
+interface OperationFiltersResponseResponse {
+  data: OperationFiltersResponse;
+  total: number;
+}
+interface OperationListItem {
+  cid?: string;
+  current_step?: number;
+  error?: string;
+  estimated_completion_at?: string;
+  id: number;
+  operation: string;
+  operation_display_name: string;
+  progress_percent: number;
+  protocol: string;
+  protocol_display_name: string;
+  started_at: string;
+  status: string;
+  status_display_name: string;
+  status_message: string;
+  total_steps?: number;
+  updated_at: string;
+}
+interface OperationListItemResponse {
+  data: OperationListItem[];
+  total: number;
+}
+interface PasswordResetRequest {
+  email: string;
+}
+interface PasswordResetVerifyRequest {
+  email: string;
+  password: string;
+  token: string;
+}
+interface PongResponse {
+  ping: string;
+  token: string;
+}
+interface PublicPricingPlanPeriodDTO {
+  cadence: string;
+  id: number;
+  price_usd: number;
+  quota_plan_id: number;
+  rolling_days?: number;
+}
+interface PublicPricingPlanResponse {
+  currency: string;
+  description: string;
+  features: string[];
+  id: number;
+  name: string;
+  pricing_periods: PublicPricingPlanPeriodDTO[];
+}
+interface PublicPricingPlansListResponse {
+  data: PublicPricingPlanResponse[];
+  total: number;
+}
+interface UsagePoint {
+  bytes: number;
+  date: string;
+}
+interface QuotaHistoryResponse {
+  points: UsagePoint[];
+  user_id: number;
+}
+interface WindowInfo {
+  duration?: number;
+  end_date?: string;
+  start_date?: string;
+  timezone?: string;
+  type: string;
+}
+interface QuotaTypeStatus {
+  limit?: number;
+  percentage: number;
+  remaining?: number;
+  reserved?: number;
+  threshold?: number;
+  used: number;
+  window?: WindowInfo;
+}
+interface QuotaStatusResponse {
+  download: QuotaTypeStatus;
+  storage: QuotaTypeStatus;
+  upload: QuotaTypeStatus;
+}
+interface RegisterRequest {
+  email: string;
+  first_name: string;
+  last_name: string;
+  password: string;
+}
+interface ResendVerifyEmailRequest {
+  email: string;
+}
+interface SubscriptionStatusResponse {
+  created_at?: string;
+  gateway_type?: string;
+  is_subscribed: boolean;
+  paused_at?: string;
+  pricing_plan_period_id?: number;
+  updated_at?: string;
+  will_cancel_at?: string;
+}
+/**
+ * @minItems 16
+ * @maxItems 16
+ */
+type Uuid = number[];
+interface UpdateEmailRequest {
+  email: string;
+  password: string;
+}
+interface UpdatePasswordRequest {
+  current_password: string;
+  new_password: string;
+}
+interface UpdateProfileRequest {
+  first_name?: string;
+  last_name?: string;
+}
+interface UploadLimitResponse {
+  limit: number;
+}
+interface UserCreditItem {
+  amount: Decimal;
+  created_at: string;
+  description?: string;
+  direction: string;
+  id: Uuid;
+  type: string;
+}
+interface UserCreditsListResponse {
+  data: UserCreditItem[];
+  total: number;
+}
+interface VerifyEmailRequest {
+  email: string;
+  token: string;
+}
+type StringUUIDSchema = string;
+type PostApiAccountAvatarBody = {
+  file: Blob;
+};
+type GetApiAccountBillingCheckoutSessionSessionIdStatusParams = {
+  /**
+   * Payment gateway type (defaults to Stripe if not specified)
+   */
+  gateway?: string;
+};
+type GetApiAccountBillingCheckoutUiPlanIdParams = {
+  /**
+   * Payment gateway type (defaults to Stripe if not specified)
+   */
+  gateway?: string;
+  /**
+   * Period ID for the selected pricing period
+   */
+  period_id?: string;
+};
+type PostApiAccountBillingWebhooksGatewayTypeBody = {
+  [key: string]: unknown;
+};
+type GetApiAccountKeysParams = {
+  /**
+   * Ending index of the items to return (exclusive). Defaults to 10.
+   */
+  _end?: number;
+  /**
+   * Comma-separated list of sort orders ('asc' or 'desc') corresponding to _sort fields. Defaults to 'asc'.
+   */
+  _order?: string;
+  /**
+   * Comma-separated list of fields to sort by. Available fields:
+   */
+  _sort?: string;
+  /**
+   * Starting index of the items to return (0-based). Defaults to 0.
+   */
+  _start?: number;
+  /**
+   * Filter by name contains
+   */
+  'filters[name][contains]'?: string;
+  /**
+   * Filter by name endswith
+   */
+  'filters[name][endswith]'?: string;
+  /**
+   * Filter by name eq
+   */
+  'filters[name][eq]'?: string;
+  /**
+   * Filter by name ne
+   */
+  'filters[name][ne]'?: string;
+  /**
+   * Filter by name startswith
+   */
+  'filters[name][startswith]'?: string;
+  /**
+   * Filter by name contains
+   */
+  name_contains?: string;
+  /**
+   * Filter by name endswith
+   */
+  name_endswith?: string;
+  /**
+   * Filter by name eq
+   */
+  name_eq?: string;
+  /**
+   * Filter by name ne
+   */
+  name_ne?: string;
+  /**
+   * Filter by name startswith
+   */
+  name_startswith?: string;
+};
+type GetApiAccountQuotaHistoryParams = {
+  /**
+   * End date in RFC3339 format
+   */
+  end_date?: string;
+  /**
+   * Start date in RFC3339 format
+   */
+  start_date?: string;
+  /**
+   * Usage type (upload or download)
+   */
+  type?: string;
+};
+type PostApiAccountVerifyEmailParams = {
+  /**
+   * Auto-login user after verification (boolean: true/false; also accepts 1/0).
+   */
+  login?: string;
+};
+type GetApiOperationsParams = {
+  /**
+   * Ending index of the items to return (exclusive). Defaults to 10.
+   */
+  _end?: number;
+  /**
+   * Comma-separated list of sort orders ('asc' or 'desc') corresponding to _sort fields. Defaults to 'asc'.
+   */
+  _order?: string;
+  /**
+   * Comma-separated list of fields to sort by. Available fields: id, operation, protocol, status, status_message, progress_percent, cid, total_steps, current_step, error
+   */
+  _sort?: string;
+  /**
+   * Starting index of the items to return (0-based). Defaults to 0.
+   */
+  _start?: number;
+  /**
+   * Filter by cid contains
+   */
+  cid_contains?: string;
+  /**
+   * Filter by cid endswith
+   */
+  cid_endswith?: string;
+  /**
+   * Filter by cid eq
+   */
+  cid_eq?: string;
+  /**
+   * Filter by cid ne
+   */
+  cid_ne?: string;
+  /**
+   * Filter by cid startswith
+   */
+  cid_startswith?: string;
+  /**
+   * Filter by cid contains
+   */
+  'filters[cid][contains]'?: string;
+  /**
+   * Filter by cid endswith
+   */
+  'filters[cid][endswith]'?: string;
+  /**
+   * Filter by cid eq
+   */
+  'filters[cid][eq]'?: string;
+  /**
+   * Filter by cid ne
+   */
+  'filters[cid][ne]'?: string;
+  /**
+   * Filter by cid startswith
+   */
+  'filters[cid][startswith]'?: string;
+  /**
+   * Filter by id between
+   */
+  'filters[id][between]'?: string;
+  /**
+   * Filter by id eq
+   */
+  'filters[id][eq]'?: string;
+  /**
+   * Filter by id gt
+   */
+  'filters[id][gt]'?: string;
+  /**
+   * Filter by id gte
+   */
+  'filters[id][gte]'?: string;
+  /**
+   * Filter by id lt
+   */
+  'filters[id][lt]'?: string;
+  /**
+   * Filter by id lte
+   */
+  'filters[id][lte]'?: string;
+  /**
+   * Filter by id ne
+   */
+  'filters[id][ne]'?: string;
+  /**
+   * Filter by operation contains
+   */
+  'filters[operation][contains]'?: string;
+  /**
+   * Filter by operation endswith
+   */
+  'filters[operation][endswith]'?: string;
+  /**
+   * Filter by operation eq
+   */
+  'filters[operation][eq]'?: string;
+  /**
+   * Filter by operation ne
+   */
+  'filters[operation][ne]'?: string;
+  /**
+   * Filter by operation startswith
+   */
+  'filters[operation][startswith]'?: string;
+  /**
+   * Filter by progress_percent between
+   */
+  'filters[progress_percent][between]'?: string;
+  /**
+   * Filter by progress_percent eq
+   */
+  'filters[progress_percent][eq]'?: string;
+  /**
+   * Filter by progress_percent gt
+   */
+  'filters[progress_percent][gt]'?: string;
+  /**
+   * Filter by progress_percent gte
+   */
+  'filters[progress_percent][gte]'?: string;
+  /**
+   * Filter by progress_percent lt
+   */
+  'filters[progress_percent][lt]'?: string;
+  /**
+   * Filter by progress_percent lte
+   */
+  'filters[progress_percent][lte]'?: string;
+  /**
+   * Filter by progress_percent ne
+   */
+  'filters[progress_percent][ne]'?: string;
+  /**
+   * Filter by id eq
+   */
+  id_eq?: string;
+  /**
+   * Filter by id gt
+   */
+  id_gt?: string;
+  /**
+   * Filter by id gte
+   */
+  id_gte?: string;
+  /**
+   * Filter by id lt
+   */
+  id_lt?: string;
+  /**
+   * Filter by id lte
+   */
+  id_lte?: string;
+  /**
+   * Filter by id ne
+   */
+  id_ne?: string;
+  /**
+   * Filter by operation contains
+   */
+  operation_contains?: string;
+  /**
+   * Filter by operation endswith
+   */
+  operation_endswith?: string;
+  /**
+   * Filter by operation eq
+   */
+  operation_eq?: string;
+  /**
+   * Filter by operation ne
+   */
+  operation_ne?: string;
+  /**
+   * Filter by operation startswith
+   */
+  operation_startswith?: string;
+  /**
+   * Filter by progress_percent eq
+   */
+  progress_percent_eq?: string;
+  /**
+   * Filter by progress_percent gt
+   */
+  progress_percent_gt?: string;
+  /**
+   * Filter by progress_percent gte
+   */
+  progress_percent_gte?: string;
+  /**
+   * Filter by progress_percent lt
+   */
+  progress_percent_lt?: string;
+  /**
+   * Filter by progress_percent lte
+   */
+  progress_percent_lte?: string;
+  /**
+   * Filter by progress_percent ne
+   */
+  progress_percent_ne?: string;
+  /**
+   * Search term for filename or other relevant operation data
+   */
+  search?: string;
+};
+//#endregion
+export { APIEndpointInfoResponse, APIKeyCreateRequest, APIKeyListResponse, APIKeyResponse, AccessModel, AccessModelDef, AccessPolicy, AccountInfoResponse, AccountPermissionsResponse, BalanceResponse, BinaryUUID, ChangePlanRequest, CheckoutSessionStatusResponse, CheckoutUIFragment, CheckoutUIFragmentMetadata, CheckoutUIResponse, CheckoutUIResponseMetadata, CreateAPIKeyResponse, Decimal, Error, ErrorResponse, GatewayAbilities, GatewayListResponse, GatewayPublicInfo, GetApiAccountBillingCheckoutSessionSessionIdStatusParams, GetApiAccountBillingCheckoutUiPlanIdParams, GetApiAccountKeysParams, GetApiAccountQuotaHistoryParams, GetApiOperationsParams, LoginRequest, LoginResponse, ManagementCapabilitiesResponse, ManagementCapabilitiesResponseAdminOperations, ManagementCapabilitiesResponseOperations, ManagementRequest, ManagementResultResponse, OTPDisableRequest, OTPGenerateResponse, OTPValidateRequest, OTPVerifyRequest, OperationDetailResponse, OperationFilterItem, OperationFiltersResponse, OperationFiltersResponseData, OperationFiltersResponseResponse, OperationListItem, OperationListItemResponse, PasswordResetRequest, PasswordResetVerifyRequest, PongResponse, PostApiAccountAvatarBody, PostApiAccountBillingWebhooksGatewayTypeBody, PostApiAccountVerifyEmailParams, PublicPricingPlanPeriodDTO, PublicPricingPlanResponse, PublicPricingPlansListResponse, QuotaHistoryResponse, QuotaStatusResponse, QuotaTypeStatus, RegisterRequest, ResendVerifyEmailRequest, StringUUIDSchema, SubscriptionStatusResponse, UpdateEmailRequest, UpdatePasswordRequest, UpdateProfileRequest, UploadLimitResponse, UsagePoint, UserCreditItem, UserCreditsListResponse, Uuid, VerifyEmailRequest, WindowInfo };
+//# sourceMappingURL=accountAPI.schemas.d.ts.map