@pimia/sdk 0.5.0 → 0.6.0

package/dist/client.d.ts

@@ -146,6 +146,11 @@ export declare class PimiaClient {
             meta: {
                 invoice_total_count: number;
             };
+        } | {
+            data: components["schemas"]["InvoiceSummaryResource"][];
+            meta: {
+                invoice_total_count: number;
+            };
         }>;
         get: (id: number | string, options?: ReadOptions) => Promise<{
             data: components["schemas"]["InvoiceResource"] & Record<string, never>;
@@ -155,175 +160,177 @@ export declare class PimiaClient {
          * `200` de `invoices.store` está vacío ahí (ver {@link ResourceEnvelope}).
          */
         create: (body: InvoicesRequest, options?: WriteOptions) => Promise<ResourceEnvelope<{
-            id: string;
+            id: number;
             invoice_date: string;
-            due_date: string;
-            invoice_number: string;
+            due_date: string | null;
+            invoice_number: string | null;
             reference_number: string;
             status: string;
             paid_status: string;
             tax_per_item: string;
             tax_included: string;
             discount_per_item: string;
-            notes: string;
-            discount_type: string;
-            discount: string;
-            discount_val: string;
-            sub_total: string;
-            total: string;
+            notes: string | null;
+            discount_type: string | null;
+            discount: number;
+            discount_val: number;
+            sub_total: number;
+            total: number;
             effective_total: string;
-            tax: string;
+            tax: number;
             due_amount: string;
             effective_due_amount: string;
             sent: string;
             viewed: string;
-            unique_hash: string;
-            template_name: string;
+            sent_at: string;
+            viewed_at: string;
+            unique_hash: string | null;
+            template_name: string | null;
             invoice_series_id: string;
-            customer_id: string;
+            customer_id: number | null;
             external_ref: string | null;
             payment_method_id: string;
             recurring_invoice_id: string;
-            sequence_number: string;
-            exchange_rate: string;
-            base_discount_val: string;
-            base_sub_total: string;
-            base_total: string;
-            creator_id: string;
-            base_tax: string;
-            base_due_amount: string;
+            sequence_number: number | null;
+            exchange_rate: number | null;
+            base_discount_val: string | null;
+            base_sub_total: string | null;
+            base_total: string | null;
+            creator_id: number | null;
+            base_tax: string | null;
+            base_due_amount: string | null;
             effective_base_total: string;
             effective_base_due_amount: string;
             credited_total: string;
             credited_base_total: string;
-            currency_id: string;
+            currency_id: number | null;
             formatted_created_at: string;
             invoice_pdf_url: string;
             formatted_invoice_date: string;
             formatted_due_date: string;
             allow_edit: string;
             payment_module_enabled: string;
-            sales_tax_type: string;
-            sales_tax_address_type: string;
             overdue: string;
             effective_paid_status: string;
             effective_overdue: string;
             aeat_status: string;
-            qr_data: string;
-            hash: string;
-            aeat_csv: string;
-            is_credit_note: string | boolean;
-            rectified_invoice_id: string;
+            qr_data: string | null;
+            hash: string | null;
+            aeat_csv: string | null;
+            is_credit_note: boolean;
+            rectified_invoice_id: number | null;
             rectified_invoice_number?: string | null;
             rectified_invoice?: {
-                id: string;
-                invoice_number: string;
+                id: number;
+                invoice_number: string | null;
                 tax_per_item: string;
                 tax_included: string;
-                sub_total: string;
-                discount_val: string;
-                tax: string;
-                total: string;
+                sub_total: number;
+                discount_val: number;
+                tax: number;
+                total: number;
                 items: components["schemas"]["InvoiceItemResource"][];
                 taxes: components["schemas"]["TaxResource"][];
             };
-            credit_notes_count: number;
+            credit_notes_count: string | number;
             items?: components["schemas"]["InvoiceItemResource"][];
             payments?: components["schemas"]["PaymentResource"][];
-            customer?: components["schemas"]["CustomerResource"];
+            email_logs?: components["schemas"]["EmailLogResource"][];
+            customer?: components["schemas"]["CustomerResource"] | null;
             invoice_series?: components["schemas"]["InvoiceSeriesResource"];
             payment_method?: components["schemas"]["PaymentMethodResource"];
-            creator?: components["schemas"]["UserResource"];
+            creator?: components["schemas"]["UserResource"] | null;
             taxes: components["schemas"]["TaxResource"][];
             fields?: components["schemas"]["CustomFieldValueResource"][];
-            company?: components["schemas"]["CompanyResource"];
-            currency?: components["schemas"]["CurrencyResource"];
+            company?: components["schemas"]["CompanyResource"] | null;
+            currency?: components["schemas"]["CurrencyResource"] | null;
         }>>;
         /** Mismo caso que `create`: el `200` de `invoices.update` no está tipado en el spec. */
         update: (id: number | string, body: InvoicesRequest, options?: WriteOptions) => Promise<ResourceEnvelope<{
-            id: string;
+            id: number;
             invoice_date: string;
-            due_date: string;
-            invoice_number: string;
+            due_date: string | null;
+            invoice_number: string | null;
             reference_number: string;
             status: string;
             paid_status: string;
             tax_per_item: string;
             tax_included: string;
             discount_per_item: string;
-            notes: string;
-            discount_type: string;
-            discount: string;
-            discount_val: string;
-            sub_total: string;
-            total: string;
+            notes: string | null;
+            discount_type: string | null;
+            discount: number;
+            discount_val: number;
+            sub_total: number;
+            total: number;
             effective_total: string;
-            tax: string;
+            tax: number;
             due_amount: string;
             effective_due_amount: string;
             sent: string;
             viewed: string;
-            unique_hash: string;
-            template_name: string;
+            sent_at: string;
+            viewed_at: string;
+            unique_hash: string | null;
+            template_name: string | null;
             invoice_series_id: string;
-            customer_id: string;
+            customer_id: number | null;
             external_ref: string | null;
             payment_method_id: string;
             recurring_invoice_id: string;
-            sequence_number: string;
-            exchange_rate: string;
-            base_discount_val: string;
-            base_sub_total: string;
-            base_total: string;
-            creator_id: string;
-            base_tax: string;
-            base_due_amount: string;
+            sequence_number: number | null;
+            exchange_rate: number | null;
+            base_discount_val: string | null;
+            base_sub_total: string | null;
+            base_total: string | null;
+            creator_id: number | null;
+            base_tax: string | null;
+            base_due_amount: string | null;
             effective_base_total: string;
             effective_base_due_amount: string;
             credited_total: string;
             credited_base_total: string;
-            currency_id: string;
+            currency_id: number | null;
             formatted_created_at: string;
             invoice_pdf_url: string;
             formatted_invoice_date: string;
             formatted_due_date: string;
             allow_edit: string;
             payment_module_enabled: string;
-            sales_tax_type: string;
-            sales_tax_address_type: string;
             overdue: string;
             effective_paid_status: string;
             effective_overdue: string;
             aeat_status: string;
-            qr_data: string;
-            hash: string;
-            aeat_csv: string;
-            is_credit_note: string | boolean;
-            rectified_invoice_id: string;
+            qr_data: string | null;
+            hash: string | null;
+            aeat_csv: string | null;
+            is_credit_note: boolean;
+            rectified_invoice_id: number | null;
             rectified_invoice_number?: string | null;
             rectified_invoice?: {
-                id: string;
-                invoice_number: string;
+                id: number;
+                invoice_number: string | null;
                 tax_per_item: string;
                 tax_included: string;
-                sub_total: string;
-                discount_val: string;
-                tax: string;
-                total: string;
+                sub_total: number;
+                discount_val: number;
+                tax: number;
+                total: number;
                 items: components["schemas"]["InvoiceItemResource"][];
                 taxes: components["schemas"]["TaxResource"][];
             };
-            credit_notes_count: number;
+            credit_notes_count: string | number;
             items?: components["schemas"]["InvoiceItemResource"][];
             payments?: components["schemas"]["PaymentResource"][];
-            customer?: components["schemas"]["CustomerResource"];
+            email_logs?: components["schemas"]["EmailLogResource"][];
+            customer?: components["schemas"]["CustomerResource"] | null;
             invoice_series?: components["schemas"]["InvoiceSeriesResource"];
             payment_method?: components["schemas"]["PaymentMethodResource"];
-            creator?: components["schemas"]["UserResource"];
+            creator?: components["schemas"]["UserResource"] | null;
             taxes: components["schemas"]["TaxResource"][];
             fields?: components["schemas"]["CustomFieldValueResource"][];
-            company?: components["schemas"]["CompanyResource"];
-            currency?: components["schemas"]["CurrencyResource"];
+            company?: components["schemas"]["CompanyResource"] | null;
+            currency?: components["schemas"]["CurrencyResource"] | null;
         }>>;
     };
     get customers(): {
@@ -332,6 +339,11 @@ export declare class PimiaClient {
             meta: {
                 customer_total_count: number;
             };
+        } | {
+            data: components["schemas"]["CustomerSummaryResource"][];
+            meta: {
+                customer_total_count: number;
+            };
         }>;
         get: (id: number | string, options?: ReadOptions) => Promise<{
             data: components["schemas"]["CustomerResource"];
@@ -341,40 +353,36 @@ export declare class PimiaClient {
         }>;
         /** El `200` de `customers.update` no está tipado en el spec. */
         update: (id: number | string, body: CustomerRequest, options?: WriteOptions) => Promise<ResourceEnvelope<{
-            id: string;
+            id: number;
             name: string;
-            email: string;
-            phone: string;
-            contact_name: string;
-            company_name: string;
-            website: string;
-            enable_portal: string;
+            email: string | null;
+            phone: string | null;
+            contact_name: string | null;
+            website: string | null;
+            enable_portal: boolean;
             password_added: boolean;
-            currency_id: string;
+            currency_id: number | null;
             payment_method_id: string;
-            company_id: string;
-            facebook_id: string;
-            google_id: string;
-            github_id: string;
-            created_at: string;
+            company_id: number | null;
+            created_at: string | null;
             formatted_created_at: string;
-            updated_at: string;
+            updated_at: string | null;
             avatar: string;
             due_amount: string;
             base_due_amount: string;
-            prefix: string;
+            prefix: string | null;
             tax_id: string;
             notes: string;
             external_ref: string | null;
-            iban: string;
-            bic: string;
-            sepa_mandate_id: string;
-            sepa_mandate_date: string;
-            billing?: components["schemas"]["AddressResource"];
-            shipping?: components["schemas"]["AddressResource"];
+            iban: string | null;
+            bic: string | null;
+            sepa_mandate_id: string | null;
+            sepa_mandate_date: string | null;
+            billing?: components["schemas"]["AddressResource"] | null;
+            shipping?: components["schemas"]["AddressResource"] | null;
             fields?: components["schemas"]["CustomFieldValueResource"][];
-            company?: components["schemas"]["CompanyResource"];
-            currency?: components["schemas"]["CurrencyResource"];
+            company?: components["schemas"]["CompanyResource"] | null;
+            currency?: components["schemas"]["CurrencyResource"] | null;
             payment_method?: components["schemas"]["PaymentMethodResource"];
         }>>;
     };
@@ -384,9 +392,14 @@ export declare class PimiaClient {
             meta: {
                 estimate_total_count: number;
             };
+        } | {
+            data: components["schemas"]["EstimateSummaryResource"][];
+            meta: {
+                estimate_total_count: number;
+            };
         }>;
         get: (id: number | string, options?: ReadOptions) => Promise<{
-            data: components["schemas"]["EstimateResource"];
+            data: components["schemas"]["EstimateResource"] & Record<string, never>;
         }>;
         create: (body: EstimatesRequest, options?: WriteOptions) => Promise<{
             data: components["schemas"]["EstimateResource"];
@@ -427,89 +440,90 @@ export declare class PimiaClient {
         convertToInvoice: (id: number | string, options?: WriteOptions & {
             externalRef?: string | null;
         }) => Promise<ResourceEnvelope<{
-            id: string;
+            id: number;
             invoice_date: string;
-            due_date: string;
-            invoice_number: string;
+            due_date: string | null;
+            invoice_number: string | null;
             reference_number: string;
             status: string;
             paid_status: string;
             tax_per_item: string;
             tax_included: string;
             discount_per_item: string;
-            notes: string;
-            discount_type: string;
-            discount: string;
-            discount_val: string;
-            sub_total: string;
-            total: string;
+            notes: string | null;
+            discount_type: string | null;
+            discount: number;
+            discount_val: number;
+            sub_total: number;
+            total: number;
             effective_total: string;
-            tax: string;
+            tax: number;
             due_amount: string;
             effective_due_amount: string;
             sent: string;
             viewed: string;
-            unique_hash: string;
-            template_name: string;
+            sent_at: string;
+            viewed_at: string;
+            unique_hash: string | null;
+            template_name: string | null;
             invoice_series_id: string;
-            customer_id: string;
+            customer_id: number | null;
             external_ref: string | null;
             payment_method_id: string;
             recurring_invoice_id: string;
-            sequence_number: string;
-            exchange_rate: string;
-            base_discount_val: string;
-            base_sub_total: string;
-            base_total: string;
-            creator_id: string;
-            base_tax: string;
-            base_due_amount: string;
+            sequence_number: number | null;
+            exchange_rate: number | null;
+            base_discount_val: string | null;
+            base_sub_total: string | null;
+            base_total: string | null;
+            creator_id: number | null;
+            base_tax: string | null;
+            base_due_amount: string | null;
             effective_base_total: string;
             effective_base_due_amount: string;
             credited_total: string;
             credited_base_total: string;
-            currency_id: string;
+            currency_id: number | null;
             formatted_created_at: string;
             invoice_pdf_url: string;
             formatted_invoice_date: string;
             formatted_due_date: string;
             allow_edit: string;
             payment_module_enabled: string;
-            sales_tax_type: string;
-            sales_tax_address_type: string;
             overdue: string;
             effective_paid_status: string;
             effective_overdue: string;
             aeat_status: string;
-            qr_data: string;
-            hash: string;
-            aeat_csv: string;
-            is_credit_note: string | boolean;
-            rectified_invoice_id: string;
+            qr_data: string | null;
+            hash: string | null;
+            aeat_csv: string | null;
+            is_credit_note: boolean;
+            rectified_invoice_id: number | null;
             rectified_invoice_number?: string | null;
             rectified_invoice?: {
-                id: string;
-                invoice_number: string;
+                id: number;
+                invoice_number: string | null;
                 tax_per_item: string;
                 tax_included: string;
-                sub_total: string;
-                discount_val: string;
-                tax: string;
-                total: string;
+                sub_total: number;
+                discount_val: number;
+                tax: number;
+                total: number;
                 items: components["schemas"]["InvoiceItemResource"][];
                 taxes: components["schemas"]["TaxResource"][];
             };
-            credit_notes_count: number;
+            credit_notes_count: string | number;
             items?: components["schemas"]["InvoiceItemResource"][];
             payments?: components["schemas"]["PaymentResource"][];
-            customer?: components["schemas"]["CustomerResource"];
+            email_logs?: components["schemas"]["EmailLogResource"][];
+            customer?: components["schemas"]["CustomerResource"] | null;
             invoice_series?: components["schemas"]["InvoiceSeriesResource"];
             payment_method?: components["schemas"]["PaymentMethodResource"];
-            creator?: components["schemas"]["UserResource"];
+            creator?: components["schemas"]["UserResource"] | null;
             taxes: components["schemas"]["TaxResource"][];
             fields?: components["schemas"]["CustomFieldValueResource"][];
-            company?: components["schemas"]["CompanyResource"];
-            currency?: components["schemas"]["CurrencyResource"];
+            company?: components["schemas"]["CompanyResource"] | null;
+            currency?: components["schemas"]["CurrencyResource"] | null;
         }>>;
     };
     get<T = unknown>(path: string, query?: RequestOptions['query'], options?: ReadOptions): Promise<T>;

package/dist/index.d.ts

@@ -35,6 +35,16 @@ export declare const SCOPES: {
     readonly agendaRead: "agenda:read";
     readonly agendaWrite: "agenda:write";
     readonly reportsRead: "reports:read";
+    /** Leer la configuración de la empresa (impuestos, preferencias, series). */
+    readonly settingsRead: "settings:read";
+    /** Ver la tienda de módulos y qué tiene contratado el tenant. */
+    readonly storeRead: "store:read";
+    /** Leer la gestión de personal: empleados, ausencias, fichajes, calendarios. */
+    readonly hrRead: "hr:read";
+    /** Gestionar el personal: altas, ausencias, correcciones de fichaje, horarios. */
+    readonly hrWrite: "hr:write";
+    /** Gestionar los avisos (webhooks) que recibe tu app. */
+    readonly webhooksWrite: "webhooks:write";
     /**
      * Proponer cambios que el dueño del tenant aprueba antes de aplicarse.
      * `approvalsSubmit` es un alias del mismo permiso, aceptado por el

package/dist/index.js

@@ -31,6 +31,16 @@ export const SCOPES = {
     agendaRead: 'agenda:read',
     agendaWrite: 'agenda:write',
     reportsRead: 'reports:read',
+    /** Leer la configuración de la empresa (impuestos, preferencias, series). */
+    settingsRead: 'settings:read',
+    /** Ver la tienda de módulos y qué tiene contratado el tenant. */
+    storeRead: 'store:read',
+    /** Leer la gestión de personal: empleados, ausencias, fichajes, calendarios. */
+    hrRead: 'hr:read',
+    /** Gestionar el personal: altas, ausencias, correcciones de fichaje, horarios. */
+    hrWrite: 'hr:write',
+    /** Gestionar los avisos (webhooks) que recibe tu app. */
+    webhooksWrite: 'webhooks:write',
     /**
      * Proponer cambios que el dueño del tenant aprueba antes de aplicarse.
      * `approvalsSubmit` es un alias del mismo permiso, aceptado por el

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pimia/sdk",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Cliente TypeScript de la API de Pimia para apps de partner: OAuth con PKCE, rotación de refresh persistida, reintentos de rate limit y tipos generados del OpenAPI.",
   "license": "MIT",
   "author": "Pimia (https://pimia.es)",