@scell/sdk 1.0.0

package/src/resources/auth.ts

@@ -0,0 +1,286 @@
+/**
+ * Auth Resource
+ *
+ * @packageDocumentation
+ */
+
+import type { HttpClient, RequestOptions } from '../client.js';
+import type { MessageResponse, SingleResponse } from '../types/common.js';
+import type {
+  AuthResponse,
+  ForgotPasswordInput,
+  LoginCredentials,
+  RegisterInput,
+  ResetPasswordInput,
+  User,
+} from '../types/auth.js';
+
+/**
+ * Auth API resource
+ *
+ * Note: Most auth endpoints are only used during initial setup.
+ * After login, use the returned token to create a ScellClient.
+ *
+ * @example
+ * ```typescript
+ * // Login and get token
+ * const auth = await ScellAuth.login({
+ *   email: 'user@example.com',
+ *   password: 'password'
+ * });
+ *
+ * // Create client with token
+ * const client = new ScellClient(auth.token);
+ *
+ * // Get current user
+ * const user = await client.auth.me();
+ * ```
+ */
+export class AuthResource {
+  constructor(private readonly http: HttpClient) {}
+
+  /**
+   * Get current authenticated user
+   *
+   * @param requestOptions - Request options
+   * @returns Current user details
+   *
+   * @example
+   * ```typescript
+   * const { data: user } = await client.auth.me();
+   * console.log(`Logged in as: ${user.name} (${user.email})`);
+   * ```
+   */
+  async me(requestOptions?: RequestOptions): Promise<SingleResponse<User>> {
+    return this.http.get<SingleResponse<User>>(
+      '/auth/me',
+      undefined,
+      requestOptions
+    );
+  }
+
+  /**
+   * Logout (revoke current token)
+   *
+   * @param requestOptions - Request options
+   * @returns Logout confirmation
+   *
+   * @example
+   * ```typescript
+   * await client.auth.logout();
+   * // Token is now invalid
+   * ```
+   */
+  async logout(requestOptions?: RequestOptions): Promise<MessageResponse> {
+    return this.http.post<MessageResponse>(
+      '/auth/logout',
+      undefined,
+      requestOptions
+    );
+  }
+}
+
+/**
+ * Static auth methods (don't require authentication)
+ *
+ * @example
+ * ```typescript
+ * import { ScellAuth } from '@scell/sdk';
+ *
+ * // Register new user
+ * const auth = await ScellAuth.register({
+ *   name: 'John Doe',
+ *   email: 'john@example.com',
+ *   password: 'securepassword123',
+ *   password_confirmation: 'securepassword123'
+ * });
+ *
+ * // Login existing user
+ * const auth = await ScellAuth.login({
+ *   email: 'john@example.com',
+ *   password: 'securepassword123'
+ * });
+ *
+ * // Use the token
+ * const client = new ScellClient(auth.token);
+ * ```
+ */
+export const ScellAuth = {
+  /**
+   * Default base URL for auth requests
+   */
+  baseUrl: 'https://api.scell.io/api/v1',
+
+  /**
+   * Register a new user
+   *
+   * @param input - Registration data
+   * @param baseUrl - Optional base URL override
+   * @returns Auth response with token
+   *
+   * @example
+   * ```typescript
+   * const auth = await ScellAuth.register({
+   *   name: 'Jane Doe',
+   *   email: 'jane@example.com',
+   *   password: 'MySecurePassword123!',
+   *   password_confirmation: 'MySecurePassword123!'
+   * });
+   *
+   * console.log('Welcome,', auth.user.name);
+   * const client = new ScellClient(auth.token);
+   * ```
+   */
+  async register(
+    input: RegisterInput,
+    baseUrl?: string
+  ): Promise<AuthResponse> {
+    const url = `${baseUrl ?? this.baseUrl}/auth/register`;
+
+    const response = await fetch(url, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        Accept: 'application/json',
+      },
+      body: JSON.stringify(input),
+    });
+
+    const body = await response.json();
+
+    if (!response.ok) {
+      const { parseApiError } = await import('../errors.js');
+      parseApiError(response.status, body, response.headers);
+    }
+
+    return body as AuthResponse;
+  },
+
+  /**
+   * Login an existing user
+   *
+   * @param credentials - Login credentials
+   * @param baseUrl - Optional base URL override
+   * @returns Auth response with token
+   *
+   * @example
+   * ```typescript
+   * const auth = await ScellAuth.login({
+   *   email: 'user@example.com',
+   *   password: 'password'
+   * });
+   *
+   * // Store the token securely
+   * localStorage.setItem('scell_token', auth.token);
+   *
+   * // Create client
+   * const client = new ScellClient(auth.token);
+   * ```
+   */
+  async login(
+    credentials: LoginCredentials,
+    baseUrl?: string
+  ): Promise<AuthResponse> {
+    const url = `${baseUrl ?? this.baseUrl}/auth/login`;
+
+    const response = await fetch(url, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        Accept: 'application/json',
+      },
+      body: JSON.stringify(credentials),
+    });
+
+    const body = await response.json();
+
+    if (!response.ok) {
+      const { parseApiError } = await import('../errors.js');
+      parseApiError(response.status, body, response.headers);
+    }
+
+    return body as AuthResponse;
+  },
+
+  /**
+   * Request password reset email
+   *
+   * @param input - Email address
+   * @param baseUrl - Optional base URL override
+   * @returns Confirmation message
+   *
+   * @example
+   * ```typescript
+   * await ScellAuth.forgotPassword({
+   *   email: 'user@example.com'
+   * });
+   * console.log('Check your email for reset link');
+   * ```
+   */
+  async forgotPassword(
+    input: ForgotPasswordInput,
+    baseUrl?: string
+  ): Promise<MessageResponse> {
+    const url = `${baseUrl ?? this.baseUrl}/auth/forgot-password`;
+
+    const response = await fetch(url, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        Accept: 'application/json',
+      },
+      body: JSON.stringify(input),
+    });
+
+    const body = await response.json();
+
+    if (!response.ok) {
+      const { parseApiError } = await import('../errors.js');
+      parseApiError(response.status, body, response.headers);
+    }
+
+    return body as MessageResponse;
+  },
+
+  /**
+   * Reset password with token from email
+   *
+   * @param input - Reset password data
+   * @param baseUrl - Optional base URL override
+   * @returns Confirmation message
+   *
+   * @example
+   * ```typescript
+   * await ScellAuth.resetPassword({
+   *   email: 'user@example.com',
+   *   token: 'reset-token-from-email',
+   *   password: 'NewSecurePassword123!',
+   *   password_confirmation: 'NewSecurePassword123!'
+   * });
+   * ```
+   */
+  async resetPassword(
+    input: ResetPasswordInput,
+    baseUrl?: string
+  ): Promise<MessageResponse> {
+    const url = `${baseUrl ?? this.baseUrl}/auth/reset-password`;
+
+    const response = await fetch(url, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        Accept: 'application/json',
+      },
+      body: JSON.stringify(input),
+    });
+
+    const body = await response.json();
+
+    if (!response.ok) {
+      const { parseApiError } = await import('../errors.js');
+      parseApiError(response.status, body, response.headers);
+    }
+
+    return body as MessageResponse;
+  },
+};

package/src/resources/balance.ts

@@ -0,0 +1,157 @@
+/**
+ * Balance Resource
+ *
+ * @packageDocumentation
+ */
+
+import type { HttpClient, RequestOptions } from '../client.js';
+import type {
+  MessageWithDataResponse,
+  PaginatedResponse,
+  SingleResponse,
+} from '../types/common.js';
+import type {
+  Balance,
+  ReloadBalanceInput,
+  ReloadBalanceResponse,
+  Transaction,
+  TransactionListOptions,
+  UpdateBalanceSettingsInput,
+} from '../types/balance.js';
+
+/**
+ * Balance API resource
+ *
+ * @example
+ * ```typescript
+ * // Check balance
+ * const balance = await client.balance.get();
+ * console.log(`Current balance: ${balance.amount} ${balance.currency}`);
+ *
+ * // Reload balance
+ * await client.balance.reload({ amount: 100 });
+ *
+ * // View transactions
+ * const transactions = await client.balance.transactions({
+ *   type: 'debit',
+ *   service: 'invoice'
+ * });
+ * ```
+ */
+export class BalanceResource {
+  constructor(private readonly http: HttpClient) {}
+
+  /**
+   * Get current balance and settings
+   *
+   * @param requestOptions - Request options
+   * @returns Current balance details
+   *
+   * @example
+   * ```typescript
+   * const { data: balance } = await client.balance.get();
+   * console.log(`Balance: ${balance.amount} ${balance.currency}`);
+   *
+   * if (balance.amount < balance.low_balance_alert_threshold) {
+   *   console.log('Warning: Low balance!');
+   * }
+   * ```
+   */
+  async get(requestOptions?: RequestOptions): Promise<SingleResponse<Balance>> {
+    return this.http.get<SingleResponse<Balance>>(
+      '/balance',
+      undefined,
+      requestOptions
+    );
+  }
+
+  /**
+   * Reload balance
+   *
+   * Note: This is a simulation endpoint. In production, use Stripe integration.
+   *
+   * @param input - Reload amount (10-10000 EUR)
+   * @param requestOptions - Request options
+   * @returns Reload transaction details
+   *
+   * @example
+   * ```typescript
+   * const { transaction } = await client.balance.reload({ amount: 100 });
+   * console.log(`New balance: ${transaction.balance_after}`);
+   * ```
+   */
+  async reload(
+    input: ReloadBalanceInput,
+    requestOptions?: RequestOptions
+  ): Promise<ReloadBalanceResponse> {
+    return this.http.post<ReloadBalanceResponse>(
+      '/balance/reload',
+      input,
+      requestOptions
+    );
+  }
+
+  /**
+   * Update balance settings
+   *
+   * Configure auto-reload and alert thresholds.
+   *
+   * @param input - Settings to update
+   * @param requestOptions - Request options
+   * @returns Updated settings
+   *
+   * @example
+   * ```typescript
+   * await client.balance.updateSettings({
+   *   auto_reload_enabled: true,
+   *   auto_reload_threshold: 50,
+   *   auto_reload_amount: 200,
+   *   low_balance_alert_threshold: 100,
+   *   critical_balance_alert_threshold: 25
+   * });
+   * ```
+   */
+  async updateSettings(
+    input: UpdateBalanceSettingsInput,
+    requestOptions?: RequestOptions
+  ): Promise<MessageWithDataResponse<Partial<Balance>>> {
+    return this.http.put<MessageWithDataResponse<Partial<Balance>>>(
+      '/balance/settings',
+      input,
+      requestOptions
+    );
+  }
+
+  /**
+   * List balance transactions
+   *
+   * @param options - Filter and pagination options
+   * @param requestOptions - Request options
+   * @returns Paginated list of transactions
+   *
+   * @example
+   * ```typescript
+   * // List all invoice debits
+   * const { data, meta } = await client.balance.transactions({
+   *   type: 'debit',
+   *   service: 'invoice',
+   *   from: '2024-01-01',
+   *   to: '2024-01-31'
+   * });
+   *
+   * data.forEach(tx => {
+   *   console.log(`${tx.description}: -${tx.amount} EUR`);
+   * });
+   * ```
+   */
+  async transactions(
+    options: TransactionListOptions = {},
+    requestOptions?: RequestOptions
+  ): Promise<PaginatedResponse<Transaction>> {
+    return this.http.get<PaginatedResponse<Transaction>>(
+      '/balance/transactions',
+      options as Record<string, string | number | boolean | undefined>,
+      requestOptions
+    );
+  }
+}

package/src/resources/companies.ts

@@ -0,0 +1,224 @@
+/**
+ * Companies Resource
+ *
+ * @packageDocumentation
+ */
+
+import type { HttpClient, RequestOptions } from '../client.js';
+import type {
+  MessageResponse,
+  MessageWithDataResponse,
+  SingleResponse,
+} from '../types/common.js';
+import type {
+  Company,
+  CreateCompanyInput,
+  KycInitiateResponse,
+  KycStatusResponse,
+  UpdateCompanyInput,
+} from '../types/companies.js';
+
+/**
+ * Companies API resource
+ *
+ * @example
+ * ```typescript
+ * // Create a company
+ * const company = await client.companies.create({
+ *   name: 'My Company',
+ *   siret: '12345678901234',
+ *   address_line1: '1 Rue de la Paix',
+ *   postal_code: '75001',
+ *   city: 'Paris'
+ * });
+ *
+ * // Initiate KYC
+ * const kyc = await client.companies.initiateKyc(company.id);
+ * console.log('KYC URL:', kyc.redirect_url);
+ * ```
+ */
+export class CompaniesResource {
+  constructor(private readonly http: HttpClient) {}
+
+  /**
+   * List all companies for the authenticated user
+   *
+   * @param requestOptions - Request options
+   * @returns List of companies
+   *
+   * @example
+   * ```typescript
+   * const { data: companies } = await client.companies.list();
+   * companies.forEach(c => console.log(c.name, c.status));
+   * ```
+   */
+  async list(
+    requestOptions?: RequestOptions
+  ): Promise<{ data: Company[] }> {
+    return this.http.get<{ data: Company[] }>(
+      '/companies',
+      undefined,
+      requestOptions
+    );
+  }
+
+  /**
+   * Get a specific company by ID
+   *
+   * @param id - Company UUID
+   * @param requestOptions - Request options
+   * @returns Company details
+   *
+   * @example
+   * ```typescript
+   * const { data: company } = await client.companies.get('uuid');
+   * console.log(company.name, company.siret);
+   * ```
+   */
+  async get(
+    id: string,
+    requestOptions?: RequestOptions
+  ): Promise<SingleResponse<Company>> {
+    return this.http.get<SingleResponse<Company>>(
+      `/companies/${id}`,
+      undefined,
+      requestOptions
+    );
+  }
+
+  /**
+   * Create a new company
+   *
+   * @param input - Company creation data
+   * @param requestOptions - Request options
+   * @returns Created company
+   *
+   * @example
+   * ```typescript
+   * const { data: company } = await client.companies.create({
+   *   name: 'Acme Corp',
+   *   siret: '12345678901234',
+   *   vat_number: 'FR12345678901',
+   *   legal_form: 'SAS',
+   *   address_line1: '123 Business Street',
+   *   postal_code: '75001',
+   *   city: 'Paris',
+   *   country: 'FR',
+   *   email: 'contact@acme.com',
+   *   phone: '+33 1 23 45 67 89'
+   * });
+   * ```
+   */
+  async create(
+    input: CreateCompanyInput,
+    requestOptions?: RequestOptions
+  ): Promise<MessageWithDataResponse<Company>> {
+    return this.http.post<MessageWithDataResponse<Company>>(
+      '/companies',
+      input,
+      requestOptions
+    );
+  }
+
+  /**
+   * Update a company
+   *
+   * @param id - Company UUID
+   * @param input - Fields to update
+   * @param requestOptions - Request options
+   * @returns Updated company
+   *
+   * @example
+   * ```typescript
+   * const { data: company } = await client.companies.update('uuid', {
+   *   email: 'new-email@acme.com',
+   *   phone: '+33 1 98 76 54 32'
+   * });
+   * ```
+   */
+  async update(
+    id: string,
+    input: UpdateCompanyInput,
+    requestOptions?: RequestOptions
+  ): Promise<MessageWithDataResponse<Company>> {
+    return this.http.put<MessageWithDataResponse<Company>>(
+      `/companies/${id}`,
+      input,
+      requestOptions
+    );
+  }
+
+  /**
+   * Delete a company
+   *
+   * @param id - Company UUID
+   * @param requestOptions - Request options
+   * @returns Deletion confirmation
+   *
+   * @example
+   * ```typescript
+   * await client.companies.delete('company-uuid');
+   * ```
+   */
+  async delete(
+    id: string,
+    requestOptions?: RequestOptions
+  ): Promise<MessageResponse> {
+    return this.http.delete<MessageResponse>(
+      `/companies/${id}`,
+      requestOptions
+    );
+  }
+
+  /**
+   * Initiate KYC verification for a company
+   *
+   * @param id - Company UUID
+   * @param requestOptions - Request options
+   * @returns KYC reference and redirect URL
+   *
+   * @example
+   * ```typescript
+   * const { kyc_reference, redirect_url } = await client.companies.initiateKyc(
+   *   'company-uuid'
+   * );
+   * // Redirect user to redirect_url for KYC verification
+   * ```
+   */
+  async initiateKyc(
+    id: string,
+    requestOptions?: RequestOptions
+  ): Promise<KycInitiateResponse> {
+    return this.http.post<KycInitiateResponse>(
+      `/companies/${id}/kyc`,
+      undefined,
+      requestOptions
+    );
+  }
+
+  /**
+   * Get KYC verification status
+   *
+   * @param id - Company UUID
+   * @param requestOptions - Request options
+   * @returns Current KYC status
+   *
+   * @example
+   * ```typescript
+   * const status = await client.companies.kycStatus('company-uuid');
+   * if (status.status === 'active') {
+   *   console.log('KYC completed at:', status.kyc_completed_at);
+   * }
+   * ```
+   */
+  async kycStatus(
+    id: string,
+    requestOptions?: RequestOptions
+  ): Promise<KycStatusResponse> {
+    return this.http.get<KycStatusResponse>(
+      `/companies/${id}/kyc/status`,
+      undefined,
+      requestOptions
+    );
+  }
+}