@peable.to/contracts 0.3.0 → 1.0.0

package/dist/cjs/resources/tax/assessments.js

@@ -0,0 +1,217 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taxAssessmentRoutes = exports.listTaxAssessmentsQuery = exports.createTaxAssessmentParams = exports.taxAssessmentReplaySchema = exports.taxAssessmentSchema = exports.taxAssessmentResultSchema = exports.taxAssessmentMeasuredSchema = exports.taxAssessmentReasonSchema = void 0;
+const zod_1 = require("zod");
+const envelopes_1 = require("../../common/envelopes");
+const objects_1 = require("../../common/objects");
+const params_1 = require("../../common/params");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const tax_1 = require("../../vocabulary/tax");
+const shared_1 = require("./shared");
+/**
+ * An assessment (`taxasm_…`, ADR 0020): the recorded facts judged against a
+ * VERSIONED rule set at one instant. It stores the version and its exact
+ * inputs, so `replay` can re-run them and show the same answer. Every finding
+ * goes to the review queue for a person to decide; none activates collection.
+ */
+exports.taxAssessmentReasonSchema = (0, objects_1.defineComponent)('TaxAssessmentReason', zod_1.z
+    .object({
+    code: zod_1.z.string(),
+    message: zod_1.z.string(),
+    evidence: shared_1.taxFacts.describe('The facts the reason rests on — amounts, counts, ids. Never personal data.'),
+})
+    .strict());
+/** Net sales measured against a rule's threshold. */
+exports.taxAssessmentMeasuredSchema = (0, objects_1.defineComponent)('TaxAssessmentMeasured', zod_1.z
+    .object({
+    amount: primitives_1.signedAmount.describe('Net sales in `currency`: reversals are netted in.'),
+    currency: primitives_1.currency,
+    transactions: zod_1.z.number().int().nonnegative(),
+    from: primitives_1.unixSeconds,
+    to: primitives_1.unixSeconds,
+    excluded_currencies: zod_1.z
+        .array(zod_1.z.string())
+        .describe('Sales in other currencies: counted nowhere, named here.'),
+})
+    .strict());
+exports.taxAssessmentResultSchema = (0, objects_1.defineComponent)('TaxAssessmentResult', zod_1.z
+    .object({
+    rule: primitives_1.nullableString.describe('The rule applied, or `null` for an unsupported jurisdiction.'),
+    country: primitives_1.nullableString,
+    state: shared_1.taxState,
+    tax_type: zod_1.z.enum(tax_1.TAX_TYPES).nullable(),
+    outcome: zod_1.z.enum(tax_1.TAX_OBLIGATION_OUTCOMES),
+    reasons: zod_1.z.array(exports.taxAssessmentReasonSchema),
+    measured: exports.taxAssessmentMeasuredSchema
+        .nullable()
+        .describe('Net sales measured against the threshold, when the rule has one.'),
+    threshold: zod_1.z.object({ amount: primitives_1.amount, currency: primitives_1.currency }).strict().nullable(),
+    deadline: zod_1.z
+        .object({
+        kind: zod_1.z.literal('registration'),
+        due: primitives_1.unixSeconds,
+        source: shared_1.taxRuleSourceSchema,
+    })
+        .strict()
+        .nullable()
+        .describe('A deadline the rule itself sets (a Texas permit after crossing).'),
+    coverage_limits: zod_1.z.array(shared_1.taxCoverageLimitSchema),
+    review_items: zod_1.z
+        .array(zod_1.z.string())
+        .describe('The review items (`taxrev_…`) this result opened or kept open.'),
+})
+    .strict());
+const outcomeCount = zod_1.z.number().int().nonnegative();
+exports.taxAssessmentSchema = (0, objects_1.defineObject)('tax.assessment', 'TaxAssessment', zod_1.z
+    .object({
+    object: zod_1.z.literal('tax.assessment'),
+    id: zod_1.z.string().describe('`taxasm_…`.'),
+    livemode: primitives_1.livemode,
+    rule_set_version: zod_1.z.string(),
+    as_of: primitives_1.unixSeconds.describe('The instant the facts were judged at.'),
+    inputs_digest: zod_1.z
+        .string()
+        .describe('SHA-256 of the canonical inputs — what a replay is checked against.'),
+    results: zod_1.z.array(exports.taxAssessmentResultSchema),
+    summary: zod_1.z
+        .object({
+        registration_declared: outcomeCount,
+        likely_required: outcomeCount,
+        approaching_threshold: outcomeCount,
+        not_indicated: outcomeCount,
+        uncertain: outcomeCount,
+        unsupported: outcomeCount,
+    })
+        .strict()
+        .describe('How many results have each outcome.'),
+    created_by: zod_1.z.object({ type: zod_1.z.enum(['user', 'service']), id: primitives_1.nullableString }).strict(),
+    created: primitives_1.unixSeconds,
+})
+    .strict(), {
+    examples: [
+        {
+            object: 'tax.assessment',
+            id: 'taxasm_0193b8f2c1a87d3e9f4a',
+            livemode: false,
+            rule_set_version: '2026-11-03.1',
+            as_of: 1793750400,
+            inputs_digest: '9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08',
+            results: [
+                {
+                    rule: 'us_tx_sales_tax',
+                    country: 'US',
+                    state: 'TX',
+                    tax_type: 'sales_tax',
+                    outcome: 'approaching_threshold',
+                    reasons: [
+                        {
+                            code: 'approaching_threshold',
+                            message: 'Texas revenue is at or above 80% of the safe-harbor threshold.',
+                            evidence: { measured_minor: '41000000', threshold_minor: '50000000' },
+                        },
+                    ],
+                    measured: {
+                        amount: '41000000',
+                        currency: 'USD',
+                        transactions: 812,
+                        from: 1762041600,
+                        to: 1793577600,
+                        excluded_currencies: [],
+                    },
+                    threshold: { amount: '50000000', currency: 'USD' },
+                    deadline: null,
+                    coverage_limits: [],
+                    review_items: ['taxrev_0193b8f2c1a87d3e9f4a'],
+                },
+            ],
+            summary: {
+                registration_declared: 0,
+                likely_required: 0,
+                approaching_threshold: 1,
+                not_indicated: 0,
+                uncertain: 0,
+                unsupported: 0,
+            },
+            created_by: { type: 'service', id: 'app_42' },
+            created: 1793750400,
+        },
+    ],
+});
+/** Re-running a stored assessment's inputs through its own rule set version. */
+exports.taxAssessmentReplaySchema = (0, objects_1.defineObject)('tax.assessment_replay', 'TaxAssessmentReplay', zod_1.z
+    .object({
+    object: zod_1.z.literal('tax.assessment_replay'),
+    assessment: zod_1.z.string().describe('The assessment replayed (`taxasm_…`).'),
+    rule_set_version: zod_1.z.string(),
+    inputs_digest: zod_1.z.string(),
+    matches: zod_1.z
+        .boolean()
+        .describe('`true` when the replayed results are identical to the stored ones.'),
+    results: zod_1.z
+        .array(exports.taxAssessmentResultSchema)
+        .describe('A replay opens no review items: every `review_items` is empty.'),
+})
+    .strict());
+exports.createTaxAssessmentParams = zod_1.z
+    .object({
+    as_of: shared_1.taxInstantParam.optional().describe('Unix seconds; default now. Never in the future.'),
+})
+    .strict();
+exports.listTaxAssessmentsQuery = (0, params_1.listQuery)({});
+exports.taxAssessmentRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'listTaxAssessments',
+        method: 'get',
+        path: '/v1/tax/assessments',
+        tag: 'Tax compliance',
+        summary: 'List assessments',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.listTaxAssessmentsQuery,
+        response: (0, envelopes_1.listOf)(exports.taxAssessmentSchema),
+        sdk: 'tax.compliance.listAssessments',
+        expandable: 'tax.assessment',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'createTaxAssessment',
+        method: 'post',
+        path: '/v1/tax/assessments',
+        tag: 'Tax compliance',
+        summary: 'Run an assessment',
+        description: 'Judges the recorded facts against the current rule set, opening review items for what needs a person. Activates nothing.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        body: exports.createTaxAssessmentParams,
+        response: exports.taxAssessmentSchema,
+        sdk: 'tax.compliance.createAssessment',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveTaxAssessment',
+        method: 'get',
+        path: '/v1/tax/assessments/{id}',
+        tag: 'Tax compliance',
+        summary: 'Retrieve an assessment',
+        auth: 'service',
+        scope: 'payments:read',
+        params: { id: 'The assessment (`taxasm_…`).' },
+        query: params_1.expandOnlyQuery,
+        response: exports.taxAssessmentSchema,
+        sdk: 'tax.compliance.retrieveAssessment',
+        expandable: 'tax.assessment',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'replayTaxAssessment',
+        method: 'get',
+        path: '/v1/tax/assessments/{id}/replay',
+        tag: 'Tax compliance',
+        summary: 'Replay an assessment',
+        description: "Re-runs the stored inputs through the assessment's own rule set version; `matches` says whether the answer is the same.",
+        auth: 'service',
+        scope: 'payments:read',
+        params: { id: 'The assessment (`taxasm_…`).' },
+        response: exports.taxAssessmentReplaySchema,
+        sdk: 'tax.compliance.replayAssessment',
+    }),
+];

package/dist/cjs/resources/tax/businessProfile.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taxBusinessProfileRoutes = exports.updateTaxBusinessProfileParams = exports.taxBusinessProfileSchema = void 0;
+const zod_1 = require("zod");
+const objects_1 = require("../../common/objects");
+const params_1 = require("../../common/params");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const tax_1 = require("../../vocabulary/tax");
+const shared_1 = require("./shared");
+/**
+ * Peable Tax business compliance (ADR 0020): what a business tells Peable
+ * about itself, what Peable works out from it against a VERSIONED rule set
+ * (an assessment), and what needs a person's decision (the review queue).
+ * Nothing here registers, files or pays anything with a government, and
+ * nothing here turns tax collection on: that is still the owner's registration
+ * plus approval (ADR 0011). The merchant API reads it and may run an
+ * assessment; every onboarding fact and decision is the owner's, in Orbit.
+ */
+/**
+ * The business behind a merchant. Deliberately carries NO government
+ * identifier (company number, EIN): none is evidence of a tax obligation and
+ * none is needed by any rule in the supported set.
+ */
+exports.taxBusinessProfileSchema = (0, objects_1.defineObject)('tax.business_profile', 'TaxBusinessProfile', zod_1.z
+    .object({
+    object: zod_1.z.literal('tax.business_profile'),
+    livemode: primitives_1.livemode,
+    legal_name: primitives_1.nullableString.describe('Read from the tax settings, where editing it returns collection to draft.'),
+    entity_type: zod_1.z
+        .enum(tax_1.TAX_LEGAL_ENTITY_TYPES)
+        .describe('`unknown` is an answer: the owner does not know yet.'),
+    incorporation_country: primitives_1.nullableString.describe('ISO 3166-1 alpha-2, or `null` while not given. Never evidence of registration.'),
+    incorporation_state: primitives_1.nullableString,
+    fiscal_year_end_month: zod_1.z
+        .number()
+        .int()
+        .min(1)
+        .max(12)
+        .nullable()
+        .describe('1–12, the month the fiscal year ends in.'),
+    customer_types: zod_1.z.enum(tax_1.TAX_CUSTOMER_TYPES),
+    supply_types: zod_1.z.array(zod_1.z.enum(tax_1.TAX_SUPPLY_TYPES)),
+    missing: zod_1.z
+        .array(zod_1.z.string())
+        .describe('What onboarding still lacks before an assessment can be complete: `legal_name`, `entity_type`, `customer_types`, `establishment`, `sales_destinations`.'),
+    metadata: primitives_1.metadata,
+    updated_by: primitives_1.nullableString,
+    updated: primitives_1.unixSeconds.nullable(),
+})
+    .strict(), {
+    examples: [
+        {
+            object: 'tax.business_profile',
+            livemode: false,
+            legal_name: 'Example Software SL',
+            entity_type: 'limited_liability_company',
+            incorporation_country: 'ES',
+            incorporation_state: null,
+            fiscal_year_end_month: 12,
+            customer_types: 'both',
+            supply_types: ['software_as_a_service'],
+            missing: [],
+            metadata: {},
+            updated_by: 'user_42',
+            updated: 1793750400,
+        },
+    ],
+});
+/** Orbit's profile update (the owner's); `metadata` is a patch. */
+exports.updateTaxBusinessProfileParams = zod_1.z
+    .object({
+    entity_type: zod_1.z.enum(tax_1.TAX_LEGAL_ENTITY_TYPES).optional(),
+    incorporation_country: shared_1.complianceCountryParam.nullable().optional(),
+    incorporation_state: shared_1.complianceStateParam.optional(),
+    fiscal_year_end_month: zod_1.z.number().int().min(1).max(12).nullable().optional(),
+    customer_types: zod_1.z.enum(tax_1.TAX_CUSTOMER_TYPES).optional(),
+    supply_types: zod_1.z
+        .array(zod_1.z.enum(tax_1.TAX_SUPPLY_TYPES))
+        .max(tax_1.TAX_SUPPLY_TYPES.length)
+        .refine((list) => new Set(list).size === list.length, 'supply_types must be distinct')
+        .optional(),
+    metadata: params_1.metadataUpdateParam.optional(),
+})
+    .strict();
+exports.taxBusinessProfileRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveTaxBusinessProfile',
+        method: 'get',
+        path: '/v1/tax/business_profile',
+        tag: 'Tax compliance',
+        summary: 'Retrieve the business profile',
+        description: 'Changed by the owner in Orbit; a service credential records no onboarding fact.',
+        auth: 'service',
+        scope: 'payments:read',
+        response: exports.taxBusinessProfileSchema,
+        sdk: 'tax.compliance.retrieveBusinessProfile',
+    }),
+];

package/dist/cjs/resources/tax/calculations.js

@@ -0,0 +1,176 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taxCalculationRoutes = exports.createTaxCalculationParams = exports.taxLineItemParams = exports.taxCalculationSchema = exports.taxCalculationLineItemSchema = exports.taxBreakdownEntrySchema = void 0;
+const zod_1 = require("zod");
+const objects_1 = require("../../common/objects");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const tax_1 = require("../../vocabulary/tax");
+const shared_1 = require("./shared");
+/**
+ * A tax calculation (`taxcalc_…`, ADR 0011): a frozen answer. Peable decides
+ * whether a registration covers the customer's evidenced location and asks
+ * the provider for the amount only when one does; the answer is stored exactly
+ * as given and never recomputed.
+ */
+exports.taxBreakdownEntrySchema = (0, objects_1.defineComponent)('TaxBreakdownEntry', zod_1.z
+    .object({
+    country: shared_1.taxCountry,
+    state: shared_1.taxState,
+    level: primitives_1.nullableString.describe('The jurisdiction level (`country`, `state`, …).'),
+    display_name: primitives_1.nullableString,
+    tax_type: primitives_1.nullableString.describe('`vat`, `sales_tax`, …; `null` when no tax is imposed.'),
+    rate_percentage: primitives_1.nullableString.describe('Decimal string, e.g. `"20.0"`; `null` when no tax is imposed.'),
+    taxable_amount: shared_1.taxMinorAmount,
+    amount: shared_1.taxMinorAmount,
+    inclusive: zod_1.z.boolean(),
+    taxability_reason: zod_1.z
+        .string()
+        .describe("The provider's reason, or Peable's own `not_registered` / `product_nontaxable`."),
+})
+    .strict());
+exports.taxCalculationLineItemSchema = (0, objects_1.defineComponent)('TaxCalculationLineItem', zod_1.z
+    .object({
+    reference: zod_1.z.string(),
+    quantity: zod_1.z.number().int(),
+    tax_code: zod_1.z.string(),
+    tax_behavior: zod_1.z.enum(tax_1.TAX_BEHAVIORS),
+    amount: shared_1.taxMinorAmount.describe('As given: includes tax when inclusive.'),
+    amount_tax: shared_1.taxMinorAmount,
+    amount_net: shared_1.taxMinorAmount.describe('Excluding tax.'),
+    breakdown: zod_1.z.array(exports.taxBreakdownEntrySchema),
+})
+    .strict());
+exports.taxCalculationSchema = (0, objects_1.defineObject)('tax.calculation', 'TaxCalculation', zod_1.z
+    .object({
+    object: zod_1.z.literal('tax.calculation'),
+    id: zod_1.z.string().describe('`taxcalc_…`.'),
+    currency: zod_1.z.string().describe('Uppercase ISO 4217.'),
+    collection: zod_1.z
+        .enum(tax_1.TAX_COLLECTIONS)
+        .describe('Why the tax is what it is: `collect` (a registration covers the customer and the provider calculated), `not_registered` (none does: zero tax, recorded as such), `nontaxable` (every line used the nontaxable code).'),
+    registration_id: primitives_1.nullableString.describe('The registration (`taxreg_…`) that collects.'),
+    provider: primitives_1.nullableString,
+    provider_calculation_ref: primitives_1.nullableString,
+    customer_location_evidence_id: zod_1.z.string().describe('`taxloc_…`.'),
+    country: shared_1.taxCountry,
+    state: shared_1.taxState,
+    amount_total: shared_1.taxMinorAmount.describe('What the customer pays.'),
+    amount_net: shared_1.taxMinorAmount,
+    tax_amount_exclusive: shared_1.taxMinorAmount,
+    tax_amount_inclusive: shared_1.taxMinorAmount,
+    line_items: zod_1.z.array(exports.taxCalculationLineItemSchema),
+    tax_date: primitives_1.unixSeconds,
+    created: primitives_1.unixSeconds,
+    expires_at: primitives_1.unixSeconds,
+    livemode: primitives_1.livemode,
+})
+    .strict(), {
+    examples: [
+        {
+            object: 'tax.calculation',
+            id: 'taxcalc_0193b8f2c1a87d3e9f4a',
+            currency: 'EUR',
+            collection: 'collect',
+            registration_id: 'taxreg_0193b8f2c1a87d3e9f4a',
+            provider: 'stripe_tax',
+            provider_calculation_ref: 'taxcalc_1QxYz2AbCdEf',
+            customer_location_evidence_id: 'taxloc_0193b8f2c1a87d3e9f4a',
+            country: 'DE',
+            state: null,
+            amount_total: 1190,
+            amount_net: 1000,
+            tax_amount_exclusive: 190,
+            tax_amount_inclusive: 0,
+            line_items: [
+                {
+                    reference: 'plan_pro_monthly',
+                    quantity: 1,
+                    tax_code: 'txcd_10103001',
+                    tax_behavior: 'exclusive',
+                    amount: 1000,
+                    amount_tax: 190,
+                    amount_net: 1000,
+                    breakdown: [
+                        {
+                            country: 'DE',
+                            state: null,
+                            level: 'country',
+                            display_name: 'VAT',
+                            tax_type: 'vat',
+                            rate_percentage: '19.0',
+                            taxable_amount: 1000,
+                            amount: 190,
+                            inclusive: false,
+                            taxability_reason: 'standard_rated',
+                        },
+                    ],
+                },
+            ],
+            tax_date: 1793750400,
+            created: 1793750400,
+            expires_at: 1793836800,
+            livemode: false,
+        },
+    ],
+});
+exports.taxLineItemParams = zod_1.z
+    .object({
+    reference: zod_1.z.string().min(1).max(200),
+    amount: zod_1.z
+        .number()
+        .int()
+        .nonnegative()
+        .safe()
+        .describe('Unit amount × quantity, minor units. Includes tax when inclusive.'),
+    quantity: zod_1.z.number().int().positive().max(1000000).optional(),
+    tax_code: zod_1.z
+        .string()
+        .optional()
+        .describe("Defaults to the product's tax code, then the merchant's default."),
+    tax_behavior: zod_1.z
+        .enum(tax_1.TAX_BEHAVIORS)
+        .optional()
+        .describe("Defaults to the merchant's default tax behavior."),
+})
+    .strict();
+exports.createTaxCalculationParams = zod_1.z
+    .object({
+    currency: zod_1.z.string().regex(/^[A-Za-z]{3}$/),
+    customer_location_evidence_id: shared_1.taxReferenceParam.describe('Sufficient, unexpired evidence (`taxloc_…`).'),
+    line_items: zod_1.z
+        .array(exports.taxLineItemParams)
+        .min(1)
+        .max(100)
+        .refine((lines) => new Set(lines.map((line) => line.reference)).size === lines.length, 'Line references must be unique'),
+})
+    .strict();
+exports.taxCalculationRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'createTaxCalculation',
+        method: 'post',
+        path: '/v1/tax/calculations',
+        tag: 'Tax',
+        summary: 'Calculate tax',
+        description: 'Calculate and freeze. Refused with `tax_settings_not_active` until the owner approves; a covered sale the provider cannot price fails closed (`tax_calculation_unavailable`), never zero.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        body: exports.createTaxCalculationParams,
+        response: exports.taxCalculationSchema,
+        status: 201,
+        sdk: 'tax.calculations.create',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveTaxCalculation',
+        method: 'get',
+        path: '/v1/tax/calculations/{id}',
+        tag: 'Tax',
+        summary: 'Retrieve a tax calculation',
+        auth: 'service',
+        scope: 'payments:read',
+        params: { id: 'The calculation (`taxcalc_…`).' },
+        response: exports.taxCalculationSchema,
+        sdk: 'tax.calculations.retrieve',
+    }),
+];

package/dist/cjs/resources/tax/capabilities.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taxCapabilityRoutes = exports.taxComplianceCapabilitiesSchema = exports.taxComplianceCapabilitySchema = void 0;
+const zod_1 = require("zod");
+const objects_1 = require("../../common/objects");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const tax_1 = require("../../vocabulary/tax");
+/** What Peable Tax compliance can and cannot do, each stated rather than simulated. */
+exports.taxComplianceCapabilitySchema = (0, objects_1.defineComponent)('TaxComplianceCapability', zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    category: zod_1.z
+        .enum(tax_1.TAX_COMPLIANCE_CAPABILITY_CATEGORIES)
+        .describe('VAT/sales tax, corporate income tax and annual company filings are different obligations.'),
+    status: zod_1.z.enum(tax_1.TAX_COMPLIANCE_CAPABILITY_STATUSES),
+    reason: zod_1.z.string(),
+})
+    .strict());
+exports.taxComplianceCapabilitiesSchema = (0, objects_1.defineObject)('tax.compliance_capabilities', 'TaxComplianceCapabilities', zod_1.z
+    .object({
+    object: zod_1.z.literal('tax.compliance_capabilities'),
+    livemode: primitives_1.livemode,
+    rule_set_version: zod_1.z.string(),
+    supported_rules: zod_1.z.array(zod_1.z.string()).describe('The ids of the rules assessed.'),
+    capabilities: zod_1.z.array(exports.taxComplianceCapabilitySchema),
+})
+    .strict());
+exports.taxCapabilityRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveTaxComplianceCapabilities',
+        method: 'get',
+        path: '/v1/tax/capabilities',
+        tag: 'Tax compliance',
+        summary: 'Retrieve compliance capabilities',
+        description: 'What is available, limited, not available or out of scope — Peable submits, files and pays nothing with any authority.',
+        auth: 'service',
+        scope: 'payments:read',
+        response: exports.taxComplianceCapabilitiesSchema,
+        sdk: 'tax.compliance.retrieveCapabilities',
+    }),
+];

package/dist/cjs/resources/tax/codes.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taxCodeRoutes = exports.taxCodeSchema = void 0;
+const zod_1 = require("zod");
+const envelopes_1 = require("../../common/envelopes");
+const objects_1 = require("../../common/objects");
+const route_1 = require("../../route");
+/** A product tax code Peable accepts (`txcd_…`, Stripe Tax's ids). */
+exports.taxCodeSchema = (0, objects_1.defineComponent)('TaxCode', zod_1.z
+    .object({
+    id: zod_1.z.string().describe('`txcd_…`.'),
+    name: zod_1.z.string(),
+    description: zod_1.z.string(),
+})
+    .strict(), {
+    examples: [
+        {
+            id: 'txcd_10103001',
+            name: 'Software as a service (SaaS) - business use',
+            description: 'Hosted software accessed online, sold to businesses for business use.',
+        },
+    ],
+});
+exports.taxCodeRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'listTaxCodes',
+        method: 'get',
+        path: '/v1/tax/codes',
+        tag: 'Tax',
+        summary: 'List tax codes',
+        description: 'Every product tax code Peable accepts: a complete list, `has_more` is `false`.',
+        auth: 'service',
+        scope: 'payments:read',
+        response: (0, envelopes_1.listOf)(exports.taxCodeSchema),
+        sdk: 'tax.listCodes',
+    }),
+];

package/dist/cjs/resources/tax/complianceActions.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taxComplianceActionRoutes = exports.listTaxComplianceActionsQuery = exports.taxComplianceActionSchema = void 0;
+const zod_1 = require("zod");
+const envelopes_1 = require("../../common/envelopes");
+const objects_1 = require("../../common/objects");
+const params_1 = require("../../common/params");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const tax_1 = require("../../vocabulary/tax");
+const shared_1 = require("./shared");
+/** One recorded compliance change (`taxact_…`), written in the transaction of the change itself. */
+exports.taxComplianceActionSchema = (0, objects_1.defineObject)('tax.compliance_action', 'TaxComplianceAction', zod_1.z
+    .object({
+    object: zod_1.z.literal('tax.compliance_action'),
+    id: zod_1.z.string().describe('`taxact_…`.'),
+    livemode: primitives_1.livemode,
+    action: zod_1.z.string().describe('e.g. `business_profile.updated`, `review_item.resolved`.'),
+    actor: zod_1.z.object({ type: zod_1.z.enum(tax_1.TAX_ACTOR_TYPES), id: primitives_1.nullableString }).strict(),
+    object_type: zod_1.z.string(),
+    object_id: primitives_1.nullableString,
+    details: shared_1.taxFacts.describe('Field names and statuses that changed — never the values of a document or a number.'),
+    created: primitives_1.unixSeconds,
+})
+    .strict(), {
+    examples: [
+        {
+            object: 'tax.compliance_action',
+            id: 'taxact_0193b8f2c1a87d3e9f4a',
+            livemode: false,
+            action: 'review_item.resolved',
+            actor: { type: 'user', id: 'user_42' },
+            object_type: 'tax.review_item',
+            object_id: 'taxrev_0193b8f2c1a87d3e9f4a',
+            details: { decision: 'will_register' },
+            created: 1793750400,
+        },
+    ],
+});
+exports.listTaxComplianceActionsQuery = (0, params_1.listQuery)({});
+exports.taxComplianceActionRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'listTaxComplianceActions',
+        method: 'get',
+        path: '/v1/tax/compliance_actions',
+        tag: 'Tax compliance',
+        summary: 'List compliance actions',
+        description: 'The history of every compliance change, newest first.',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.listTaxComplianceActionsQuery,
+        response: (0, envelopes_1.listOf)(exports.taxComplianceActionSchema),
+        sdk: 'tax.compliance.listActions',
+        expandable: 'tax.compliance_action',
+    }),
+];