From cef667e409c128bfd21684fc29e8c2b44792dda4 Mon Sep 17 00:00:00 2001 From: Pierluigi Viti Date: Tue, 28 Jan 2025 15:21:44 +0100 Subject: [PATCH] fix: fix example field in attribute's comment --- gen/generator.ts | 2 +- package.json | 2 +- pnpm-lock.yaml | 232 +++++++++--------- src/resources/addresses.ts | 16 +- src/resources/adjustments.ts | 14 +- src/resources/adyen_gateways.ts | 18 +- src/resources/adyen_payments.ts | 18 +- src/resources/applications.ts | 2 +- src/resources/authorizations.ts | 26 +- src/resources/avalara_accounts.ts | 12 +- src/resources/axerve_payments.ts | 16 +- src/resources/braintree_payments.ts | 14 +- src/resources/bundles.ts | 26 +- src/resources/buy_x_pay_y_promotions.ts | 48 ++-- src/resources/captures.ts | 20 +- src/resources/carrier_accounts.ts | 6 +- src/resources/checkout_com_payments.ts | 8 +- src/resources/cleanups.ts | 14 +- src/resources/coupons.ts | 8 +- src/resources/custom_promotion_rules.ts | 6 +- src/resources/customers.ts | 2 +- src/resources/delivery_lead_times.ts | 16 +- src/resources/discount_engine_items.ts | 2 +- src/resources/event_callbacks.ts | 2 +- src/resources/events.ts | 2 +- src/resources/exports.ts | 18 +- src/resources/external_gateways.ts | 4 +- src/resources/external_payments.ts | 8 +- src/resources/external_promotions.ts | 34 +-- src/resources/external_tax_calculators.ts | 4 +- src/resources/fixed_amount_promotions.ts | 38 +-- src/resources/fixed_price_promotions.ts | 38 +-- src/resources/flex_promotions.ts | 40 +-- src/resources/free_gift_promotions.ts | 36 +-- src/resources/free_shipping_promotions.ts | 30 +-- src/resources/gift_cards.ts | 44 ++-- src/resources/imports.ts | 18 +- src/resources/in_stock_subscriptions.ts | 10 +- src/resources/inventory_models.ts | 24 +- src/resources/inventory_return_locations.ts | 6 +- src/resources/inventory_stock_locations.ts | 6 +- src/resources/klarna_payments.ts | 6 +- src/resources/line_item_options.ts | 28 +-- src/resources/line_items.ts | 62 ++--- src/resources/links.ts | 16 +- src/resources/markets.ts | 18 +- src/resources/notifications.ts | 6 +- src/resources/order_amount_promotion_rules.ts | 14 +- src/resources/order_copies.ts | 28 +-- src/resources/order_factories.ts | 8 +- src/resources/order_subscription_items.ts | 18 +- src/resources/order_subscriptions.ts | 32 +-- src/resources/orders.ts | 172 ++++++------- src/resources/organizations.ts | 52 ++-- src/resources/packages.ts | 18 +- src/resources/parcel_line_items.ts | 4 +- src/resources/parcels.ts | 12 +- src/resources/payment_methods.ts | 20 +- src/resources/payment_options.ts | 6 +- src/resources/paypal_payments.ts | 2 +- .../percentage_discount_promotions.ts | 36 +-- src/resources/price_frequency_tiers.ts | 14 +- src/resources/price_list_schedulers.ts | 10 +- src/resources/price_lists.ts | 16 +- src/resources/price_tiers.ts | 6 +- src/resources/price_volume_tiers.ts | 14 +- src/resources/prices.ts | 30 +-- src/resources/promotions.ts | 10 +- src/resources/recurring_order_copies.ts | 12 +- src/resources/refunds.ts | 6 +- src/resources/reserved_stocks.ts | 2 +- src/resources/return_line_items.ts | 18 +- src/resources/returns.ts | 28 +-- src/resources/satispay_payments.ts | 6 +- src/resources/shipments.ts | 36 +-- src/resources/shipping_method_tiers.ts | 6 +- src/resources/shipping_methods.ts | 46 ++-- src/resources/shipping_weight_tiers.ts | 14 +- src/resources/sku_list_items.ts | 12 +- src/resources/sku_list_promotion_rules.ts | 12 +- src/resources/sku_options.ts | 16 +- src/resources/skus.ts | 16 +- src/resources/stock_items.ts | 8 +- src/resources/stock_line_items.ts | 12 +- src/resources/stock_locations.ts | 2 +- src/resources/stock_reservations.ts | 8 +- src/resources/stock_transfers.ts | 18 +- src/resources/stripe_gateways.ts | 6 +- src/resources/stripe_payments.ts | 14 +- src/resources/subscription_models.ts | 12 +- src/resources/tax_rules.ts | 8 +- src/resources/transactions.ts | 4 +- src/resources/versions.ts | 4 +- src/resources/voids.ts | 6 +- src/resources/webhooks.ts | 18 +- src/resources/wire_transfers.ts | 2 +- 96 files changed, 950 insertions(+), 950 deletions(-) diff --git a/gen/generator.ts b/gen/generator.ts index f7f2de03..0c683bcb 100644 --- a/gen/generator.ts +++ b/gen/generator.ts @@ -862,7 +862,7 @@ const templatedComponent = (res: string, name: string, cmp: Component): { compon if (a.enum) enums[a.name] = attrType if (a.description || a.example) { const desc = (a.description && !a.description.endsWith('.')) ? `${a.description}.` : a.description - fields.push(`/** ${desc ? `\n\t * ${desc}` : ''}${a.example ? `\n\t * @example \`\`\`"${a.example}"\`\`\`` : ''}\n\t */`) + fields.push(`/** ${desc ? `\n\t * ${desc}` : ''}${a.example ? `\n\t * @example \`\`\`${JSON.stringify(a.example)}\`\`\`` : ''}\n\t */`) } fields.push(`${a.name}${a.required ? '' : '?'}: ${attrType}${a.required ? '' : ' | null'}`) } diff --git a/package.json b/package.json index dfc98c7c..feea85b7 100644 --- a/package.json +++ b/package.json @@ -40,7 +40,7 @@ "@semantic-release/git": "^10.0.1", "@types/debug": "^4.1.12", "@types/jest": "^29.5.14", - "@types/node": "^22.10.10", + "@types/node": "^22.12.0", "dotenv": "^16.4.7", "eslint": "^8.57.1", "jest": "^29.7.0", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 39b7039b..c35cdeae 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -36,8 +36,8 @@ importers: specifier: ^29.5.14 version: 29.5.14 '@types/node': - specifier: ^22.10.10 - version: 22.10.10 + specifier: ^22.12.0 + version: 22.12.0 dotenv: specifier: ^16.4.7 version: 16.4.7 @@ -46,7 +46,7 @@ importers: version: 8.57.1 jest: specifier: ^29.7.0 - version: 29.7.0(@types/node@22.10.10) + version: 29.7.0(@types/node@22.12.0) json-typescript: specifier: ^1.1.2 version: 1.1.2 @@ -1104,8 +1104,8 @@ packages: resolution: {integrity: sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==} engines: {node: '>= 8'} - '@octokit/auth-token@5.1.1': - resolution: {integrity: sha512-rh3G3wDO8J9wSjfI436JUKzHIxq8NaiL0tVeB2aXmG6p/9859aUOAjA9pmSPNGGZxfwmaJ9ozOJImuNVJdpvbA==} + '@octokit/auth-token@5.1.2': + resolution: {integrity: sha512-JcQDsBdg49Yky2w2ld20IHAlwr8d/d8N6NiOXbtuoPCqzbsiJgF633mVUw3x4mo0H5ypataQIX7SFu3yy44Mpw==} engines: {node: '>= 18'} '@octokit/core@6.1.3': @@ -1172,98 +1172,98 @@ packages: resolution: {integrity: sha512-c83qWb22rNRuB0UaVCI0uRPNRr8Z0FWnEIvT47jiHAmOIUHbBOg5XvV7pM5x+rKn9HRpjxquDbXYSXr3fAKFcw==} engines: {node: '>=12'} - '@rollup/rollup-android-arm-eabi@4.32.0': - resolution: {integrity: sha512-G2fUQQANtBPsNwiVFg4zKiPQyjVKZCUdQUol53R8E71J7AsheRMV/Yv/nB8giOcOVqP7//eB5xPqieBYZe9bGg==} + '@rollup/rollup-android-arm-eabi@4.32.1': + resolution: {integrity: sha512-/pqA4DmqyCm8u5YIDzIdlLcEmuvxb0v8fZdFhVMszSpDTgbQKdw3/mB3eMUHIbubtJ6F9j+LtmyCnHTEqIHyzA==} cpu: [arm] os: [android] - '@rollup/rollup-android-arm64@4.32.0': - resolution: {integrity: sha512-qhFwQ+ljoymC+j5lXRv8DlaJYY/+8vyvYmVx074zrLsu5ZGWYsJNLjPPVJJjhZQpyAKUGPydOq9hRLLNvh1s3A==} + '@rollup/rollup-android-arm64@4.32.1': + resolution: {integrity: sha512-If3PDskT77q7zgqVqYuj7WG3WC08G1kwXGVFi9Jr8nY6eHucREHkfpX79c0ACAjLj3QIWKPJR7w4i+f5EdLH5Q==} cpu: [arm64] os: [android] - '@rollup/rollup-darwin-arm64@4.32.0': - resolution: {integrity: sha512-44n/X3lAlWsEY6vF8CzgCx+LQaoqWGN7TzUfbJDiTIOjJm4+L2Yq+r5a8ytQRGyPqgJDs3Rgyo8eVL7n9iW6AQ==} + '@rollup/rollup-darwin-arm64@4.32.1': + resolution: {integrity: sha512-zCpKHioQ9KgZToFp5Wvz6zaWbMzYQ2LJHQ+QixDKq52KKrF65ueu6Af4hLlLWHjX1Wf/0G5kSJM9PySW9IrvHA==} cpu: [arm64] os: [darwin] - '@rollup/rollup-darwin-x64@4.32.0': - resolution: {integrity: sha512-F9ct0+ZX5Np6+ZDztxiGCIvlCaW87HBdHcozUfsHnj1WCUTBUubAoanhHUfnUHZABlElyRikI0mgcw/qdEm2VQ==} + '@rollup/rollup-darwin-x64@4.32.1': + resolution: {integrity: sha512-sFvF+t2+TyUo/ZQqUcifrJIgznx58oFZbdHS9TvHq3xhPVL9nOp+yZ6LKrO9GWTP+6DbFtoyLDbjTpR62Mbr3Q==} cpu: [x64] os: [darwin] - '@rollup/rollup-freebsd-arm64@4.32.0': - resolution: {integrity: sha512-JpsGxLBB2EFXBsTLHfkZDsXSpSmKD3VxXCgBQtlPcuAqB8TlqtLcbeMhxXQkCDv1avgwNjF8uEIbq5p+Cee0PA==} + '@rollup/rollup-freebsd-arm64@4.32.1': + resolution: {integrity: sha512-NbOa+7InvMWRcY9RG+B6kKIMD/FsnQPH0MWUvDlQB1iXnF/UcKSudCXZtv4lW+C276g3w5AxPbfry5rSYvyeYA==} cpu: [arm64] os: [freebsd] - '@rollup/rollup-freebsd-x64@4.32.0': - resolution: {integrity: sha512-wegiyBT6rawdpvnD9lmbOpx5Sph+yVZKHbhnSP9MqUEDX08G4UzMU+D87jrazGE7lRSyTRs6NEYHtzfkJ3FjjQ==} + '@rollup/rollup-freebsd-x64@4.32.1': + resolution: {integrity: sha512-JRBRmwvHPXR881j2xjry8HZ86wIPK2CcDw0EXchE1UgU0ubWp9nvlT7cZYKc6bkypBt745b4bglf3+xJ7hXWWw==} cpu: [x64] os: [freebsd] - '@rollup/rollup-linux-arm-gnueabihf@4.32.0': - resolution: {integrity: sha512-3pA7xecItbgOs1A5H58dDvOUEboG5UfpTq3WzAdF54acBbUM+olDJAPkgj1GRJ4ZqE12DZ9/hNS2QZk166v92A==} + '@rollup/rollup-linux-arm-gnueabihf@4.32.1': + resolution: {integrity: sha512-PKvszb+9o/vVdUzCCjL0sKHukEQV39tD3fepXxYrHE3sTKrRdCydI7uldRLbjLmDA3TFDmh418XH19NOsDRH8g==} cpu: [arm] os: [linux] - '@rollup/rollup-linux-arm-musleabihf@4.32.0': - resolution: {integrity: sha512-Y7XUZEVISGyge51QbYyYAEHwpGgmRrAxQXO3siyYo2kmaj72USSG8LtlQQgAtlGfxYiOwu+2BdbPjzEpcOpRmQ==} + '@rollup/rollup-linux-arm-musleabihf@4.32.1': + resolution: {integrity: sha512-9WHEMV6Y89eL606ReYowXuGF1Yb2vwfKWKdD1A5h+OYnPZSJvxbEjxTRKPgi7tkP2DSnW0YLab1ooy+i/FQp/Q==} cpu: [arm] os: [linux] - '@rollup/rollup-linux-arm64-gnu@4.32.0': - resolution: {integrity: sha512-r7/OTF5MqeBrZo5omPXcTnjvv1GsrdH8a8RerARvDFiDwFpDVDnJyByYM/nX+mvks8XXsgPUxkwe/ltaX2VH7w==} + '@rollup/rollup-linux-arm64-gnu@4.32.1': + resolution: {integrity: sha512-tZWc9iEt5fGJ1CL2LRPw8OttkCBDs+D8D3oEM8mH8S1ICZCtFJhD7DZ3XMGM8kpqHvhGUTvNUYVDnmkj4BDXnw==} cpu: [arm64] os: [linux] - '@rollup/rollup-linux-arm64-musl@4.32.0': - resolution: {integrity: sha512-HJbifC9vex9NqnlodV2BHVFNuzKL5OnsV2dvTw6e1dpZKkNjPG6WUq+nhEYV6Hv2Bv++BXkwcyoGlXnPrjAKXw==} + '@rollup/rollup-linux-arm64-musl@4.32.1': + resolution: {integrity: sha512-FTYc2YoTWUsBz5GTTgGkRYYJ5NGJIi/rCY4oK/I8aKowx1ToXeoVVbIE4LGAjsauvlhjfl0MYacxClLld1VrOw==} cpu: [arm64] os: [linux] - '@rollup/rollup-linux-loongarch64-gnu@4.32.0': - resolution: {integrity: sha512-VAEzZTD63YglFlWwRj3taofmkV1V3xhebDXffon7msNz4b14xKsz7utO6F8F4cqt8K/ktTl9rm88yryvDpsfOw==} + '@rollup/rollup-linux-loongarch64-gnu@4.32.1': + resolution: {integrity: sha512-F51qLdOtpS6P1zJVRzYM0v6MrBNypyPEN1GfMiz0gPu9jN8ScGaEFIZQwteSsGKg799oR5EaP7+B2jHgL+d+Kw==} cpu: [loong64] os: [linux] - '@rollup/rollup-linux-powerpc64le-gnu@4.32.0': - resolution: {integrity: sha512-Sts5DST1jXAc9YH/iik1C9QRsLcCoOScf3dfbY5i4kH9RJpKxiTBXqm7qU5O6zTXBTEZry69bGszr3SMgYmMcQ==} + '@rollup/rollup-linux-powerpc64le-gnu@4.32.1': + resolution: {integrity: sha512-wO0WkfSppfX4YFm5KhdCCpnpGbtgQNj/tgvYzrVYFKDpven8w2N6Gg5nB6w+wAMO3AIfSTWeTjfVe+uZ23zAlg==} cpu: [ppc64] os: [linux] - '@rollup/rollup-linux-riscv64-gnu@4.32.0': - resolution: {integrity: sha512-qhlXeV9AqxIyY9/R1h1hBD6eMvQCO34ZmdYvry/K+/MBs6d1nRFLm6BOiITLVI+nFAAB9kUB6sdJRKyVHXnqZw==} + '@rollup/rollup-linux-riscv64-gnu@4.32.1': + resolution: {integrity: sha512-iWswS9cIXfJO1MFYtI/4jjlrGb/V58oMu4dYJIKnR5UIwbkzR0PJ09O0PDZT0oJ3LYWXBSWahNf/Mjo6i1E5/g==} cpu: [riscv64] os: [linux] - '@rollup/rollup-linux-s390x-gnu@4.32.0': - resolution: {integrity: sha512-8ZGN7ExnV0qjXa155Rsfi6H8M4iBBwNLBM9lcVS+4NcSzOFaNqmt7djlox8pN1lWrRPMRRQ8NeDlozIGx3Omsw==} + '@rollup/rollup-linux-s390x-gnu@4.32.1': + resolution: {integrity: sha512-RKt8NI9tebzmEthMnfVgG3i/XeECkMPS+ibVZjZ6mNekpbbUmkNWuIN2yHsb/mBPyZke4nlI4YqIdFPgKuoyQQ==} cpu: [s390x] os: [linux] - '@rollup/rollup-linux-x64-gnu@4.32.0': - resolution: {integrity: sha512-VDzNHtLLI5s7xd/VubyS10mq6TxvZBp+4NRWoW+Hi3tgV05RtVm4qK99+dClwTN1McA6PHwob6DEJ6PlXbY83A==} + '@rollup/rollup-linux-x64-gnu@4.32.1': + resolution: {integrity: sha512-WQFLZ9c42ECqEjwg/GHHsouij3pzLXkFdz0UxHa/0OM12LzvX7DzedlY0SIEly2v18YZLRhCRoHZDxbBSWoGYg==} cpu: [x64] os: [linux] - '@rollup/rollup-linux-x64-musl@4.32.0': - resolution: {integrity: sha512-qcb9qYDlkxz9DxJo7SDhWxTWV1gFuwznjbTiov289pASxlfGbaOD54mgbs9+z94VwrXtKTu+2RqwlSTbiOqxGg==} + '@rollup/rollup-linux-x64-musl@4.32.1': + resolution: {integrity: sha512-BLoiyHDOWoS3uccNSADMza6V6vCNiphi94tQlVIL5de+r6r/CCQuNnerf+1g2mnk2b6edp5dk0nhdZ7aEjOBsA==} cpu: [x64] os: [linux] - '@rollup/rollup-win32-arm64-msvc@4.32.0': - resolution: {integrity: sha512-pFDdotFDMXW2AXVbfdUEfidPAk/OtwE/Hd4eYMTNVVaCQ6Yl8et0meDaKNL63L44Haxv4UExpv9ydSf3aSayDg==} + '@rollup/rollup-win32-arm64-msvc@4.32.1': + resolution: {integrity: sha512-w2l3UnlgYTNNU+Z6wOR8YdaioqfEnwPjIsJ66KxKAf0p+AuL2FHeTX6qvM+p/Ue3XPBVNyVSfCrfZiQh7vZHLQ==} cpu: [arm64] os: [win32] - '@rollup/rollup-win32-ia32-msvc@4.32.0': - resolution: {integrity: sha512-/TG7WfrCAjeRNDvI4+0AAMoHxea/USWhAzf9PVDFHbcqrQ7hMMKp4jZIy4VEjk72AAfN5k4TiSMRXRKf/0akSw==} + '@rollup/rollup-win32-ia32-msvc@4.32.1': + resolution: {integrity: sha512-Am9H+TGLomPGkBnaPWie4F3x+yQ2rr4Bk2jpwy+iV+Gel9jLAu/KqT8k3X4jxFPW6Zf8OMnehyutsd+eHoq1WQ==} cpu: [ia32] os: [win32] - '@rollup/rollup-win32-x64-msvc@4.32.0': - resolution: {integrity: sha512-5hqO5S3PTEO2E5VjCePxv40gIgyS2KvO7E7/vvC/NbIW4SIRamkMr1hqj+5Y67fbBWv/bQLB6KelBQmXlyCjWA==} + '@rollup/rollup-win32-x64-msvc@4.32.1': + resolution: {integrity: sha512-ar80GhdZb4DgmW3myIS9nRFYcpJRSME8iqWgzH2i44u+IdrzmiXVxeFnExQ5v4JYUSpg94bWjevMG8JHf1Da5Q==} cpu: [x64] os: [win32] @@ -1377,8 +1377,8 @@ packages: '@types/ms@2.1.0': resolution: {integrity: sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA==} - '@types/node@22.10.10': - resolution: {integrity: sha512-X47y/mPNzxviAGY5TcYPtYL8JsY3kAq2n8fMmKoRCxq/c4v4pyGNCzM2R6+M5/umG4ZfHuT+sgqDYqWc9rJ6ww==} + '@types/node@22.12.0': + resolution: {integrity: sha512-Fll2FZ1riMjNmlmJOdAyY5pUbkftXslB5DgEzlIuNaiWhXd00FhWxVC/r4yV/4wBb9JfImTu+jiSvXTkJ7F/gA==} '@types/normalize-package-data@2.4.4': resolution: {integrity: sha512-37i+OaWTh9qeK4LSHPsyRC7NahnGotNuZvjLSgcPzblpHB3rrCJxAOgI5gCdKm7coonsaX1Of0ILiTcnZjbfxA==} @@ -3518,8 +3518,8 @@ packages: deprecated: Rimraf versions prior to v4 are no longer supported hasBin: true - rollup@4.32.0: - resolution: {integrity: sha512-JmrhfQR31Q4AuNBjjAX4s+a/Pu/Q8Q9iwjWBsjRH1q52SPFE2NqRMK6fUZKKnvKO6id+h7JIRf0oYsph53eATg==} + rollup@4.32.1: + resolution: {integrity: sha512-z+aeEsOeEa3mEbS1Tjl6sAZ8NE3+AalQz1RJGj81M+fizusbdDMoEJwdJNHfaB40Scr4qNu+welOfes7maKonA==} engines: {node: '>=18.0.0', npm: '>=8.0.0'} hasBin: true @@ -5046,7 +5046,7 @@ snapshots: '@jest/console@29.7.0': dependencies: '@jest/types': 29.6.3 - '@types/node': 22.10.10 + '@types/node': 22.12.0 chalk: 4.1.2 jest-message-util: 29.7.0 jest-util: 29.7.0 @@ -5059,14 +5059,14 @@ snapshots: '@jest/test-result': 29.7.0 '@jest/transform': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.10.10 + '@types/node': 22.12.0 ansi-escapes: 4.3.2 chalk: 4.1.2 ci-info: 3.9.0 exit: 0.1.2 graceful-fs: 4.2.11 jest-changed-files: 29.7.0 - jest-config: 29.7.0(@types/node@22.10.10) + jest-config: 29.7.0(@types/node@22.12.0) jest-haste-map: 29.7.0 jest-message-util: 29.7.0 jest-regex-util: 29.6.3 @@ -5091,7 +5091,7 @@ snapshots: dependencies: '@jest/fake-timers': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.10.10 + '@types/node': 22.12.0 jest-mock: 29.7.0 '@jest/expect-utils@29.7.0': @@ -5109,7 +5109,7 @@ snapshots: dependencies: '@jest/types': 29.6.3 '@sinonjs/fake-timers': 10.3.0 - '@types/node': 22.10.10 + '@types/node': 22.12.0 jest-message-util: 29.7.0 jest-mock: 29.7.0 jest-util: 29.7.0 @@ -5131,7 +5131,7 @@ snapshots: '@jest/transform': 29.7.0 '@jest/types': 29.6.3 '@jridgewell/trace-mapping': 0.3.25 - '@types/node': 22.10.10 + '@types/node': 22.12.0 chalk: 4.1.2 collect-v8-coverage: 1.0.2 exit: 0.1.2 @@ -5201,7 +5201,7 @@ snapshots: '@jest/schemas': 29.6.3 '@types/istanbul-lib-coverage': 2.0.6 '@types/istanbul-reports': 3.0.4 - '@types/node': 22.10.10 + '@types/node': 22.12.0 '@types/yargs': 17.0.33 chalk: 4.1.2 @@ -5234,11 +5234,11 @@ snapshots: '@nodelib/fs.scandir': 2.1.5 fastq: 1.18.0 - '@octokit/auth-token@5.1.1': {} + '@octokit/auth-token@5.1.2': {} '@octokit/core@6.1.3': dependencies: - '@octokit/auth-token': 5.1.1 + '@octokit/auth-token': 5.1.2 '@octokit/graphql': 8.1.2 '@octokit/request': 9.2.0 '@octokit/request-error': 6.1.6 @@ -5310,61 +5310,61 @@ snapshots: '@pnpm/network.ca-file': 1.0.2 config-chain: 1.1.13 - '@rollup/rollup-android-arm-eabi@4.32.0': + '@rollup/rollup-android-arm-eabi@4.32.1': optional: true - '@rollup/rollup-android-arm64@4.32.0': + '@rollup/rollup-android-arm64@4.32.1': optional: true - '@rollup/rollup-darwin-arm64@4.32.0': + '@rollup/rollup-darwin-arm64@4.32.1': optional: true - '@rollup/rollup-darwin-x64@4.32.0': + '@rollup/rollup-darwin-x64@4.32.1': optional: true - '@rollup/rollup-freebsd-arm64@4.32.0': + '@rollup/rollup-freebsd-arm64@4.32.1': optional: true - '@rollup/rollup-freebsd-x64@4.32.0': + '@rollup/rollup-freebsd-x64@4.32.1': optional: true - '@rollup/rollup-linux-arm-gnueabihf@4.32.0': + '@rollup/rollup-linux-arm-gnueabihf@4.32.1': optional: true - '@rollup/rollup-linux-arm-musleabihf@4.32.0': + '@rollup/rollup-linux-arm-musleabihf@4.32.1': optional: true - '@rollup/rollup-linux-arm64-gnu@4.32.0': + '@rollup/rollup-linux-arm64-gnu@4.32.1': optional: true - '@rollup/rollup-linux-arm64-musl@4.32.0': + '@rollup/rollup-linux-arm64-musl@4.32.1': optional: true - '@rollup/rollup-linux-loongarch64-gnu@4.32.0': + '@rollup/rollup-linux-loongarch64-gnu@4.32.1': optional: true - '@rollup/rollup-linux-powerpc64le-gnu@4.32.0': + '@rollup/rollup-linux-powerpc64le-gnu@4.32.1': optional: true - '@rollup/rollup-linux-riscv64-gnu@4.32.0': + '@rollup/rollup-linux-riscv64-gnu@4.32.1': optional: true - '@rollup/rollup-linux-s390x-gnu@4.32.0': + '@rollup/rollup-linux-s390x-gnu@4.32.1': optional: true - '@rollup/rollup-linux-x64-gnu@4.32.0': + '@rollup/rollup-linux-x64-gnu@4.32.1': optional: true - '@rollup/rollup-linux-x64-musl@4.32.0': + '@rollup/rollup-linux-x64-musl@4.32.1': optional: true - '@rollup/rollup-win32-arm64-msvc@4.32.0': + '@rollup/rollup-win32-arm64-msvc@4.32.1': optional: true - '@rollup/rollup-win32-ia32-msvc@4.32.0': + '@rollup/rollup-win32-ia32-msvc@4.32.1': optional: true - '@rollup/rollup-win32-x64-msvc@4.32.0': + '@rollup/rollup-win32-x64-msvc@4.32.1': optional: true '@rtsao/scc@1.1.0': {} @@ -5511,7 +5511,7 @@ snapshots: '@types/graceful-fs@4.1.9': dependencies: - '@types/node': 22.10.10 + '@types/node': 22.12.0 '@types/istanbul-lib-coverage@2.0.6': {} @@ -5532,7 +5532,7 @@ snapshots: '@types/ms@2.1.0': {} - '@types/node@22.10.10': + '@types/node@22.12.0': dependencies: undici-types: 6.20.0 @@ -6064,13 +6064,13 @@ snapshots: optionalDependencies: typescript: 5.7.3 - create-jest@29.7.0(@types/node@22.10.10): + create-jest@29.7.0(@types/node@22.12.0): dependencies: '@jest/types': 29.6.3 chalk: 4.1.2 exit: 0.1.2 graceful-fs: 4.2.11 - jest-config: 29.7.0(@types/node@22.10.10) + jest-config: 29.7.0(@types/node@22.12.0) jest-util: 29.7.0 prompts: 2.4.2 transitivePeerDependencies: @@ -7118,7 +7118,7 @@ snapshots: '@jest/expect': 29.7.0 '@jest/test-result': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.10.10 + '@types/node': 22.12.0 chalk: 4.1.2 co: 4.6.0 dedent: 1.5.3 @@ -7138,16 +7138,16 @@ snapshots: - babel-plugin-macros - supports-color - jest-cli@29.7.0(@types/node@22.10.10): + jest-cli@29.7.0(@types/node@22.12.0): dependencies: '@jest/core': 29.7.0 '@jest/test-result': 29.7.0 '@jest/types': 29.6.3 chalk: 4.1.2 - create-jest: 29.7.0(@types/node@22.10.10) + create-jest: 29.7.0(@types/node@22.12.0) exit: 0.1.2 import-local: 3.2.0 - jest-config: 29.7.0(@types/node@22.10.10) + jest-config: 29.7.0(@types/node@22.12.0) jest-util: 29.7.0 jest-validate: 29.7.0 yargs: 17.7.2 @@ -7157,7 +7157,7 @@ snapshots: - supports-color - ts-node - jest-config@29.7.0(@types/node@22.10.10): + jest-config@29.7.0(@types/node@22.12.0): dependencies: '@babel/core': 7.26.7 '@jest/test-sequencer': 29.7.0 @@ -7182,7 +7182,7 @@ snapshots: slash: 3.0.0 strip-json-comments: 3.1.1 optionalDependencies: - '@types/node': 22.10.10 + '@types/node': 22.12.0 transitivePeerDependencies: - babel-plugin-macros - supports-color @@ -7211,7 +7211,7 @@ snapshots: '@jest/environment': 29.7.0 '@jest/fake-timers': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.10.10 + '@types/node': 22.12.0 jest-mock: 29.7.0 jest-util: 29.7.0 @@ -7221,7 +7221,7 @@ snapshots: dependencies: '@jest/types': 29.6.3 '@types/graceful-fs': 4.1.9 - '@types/node': 22.10.10 + '@types/node': 22.12.0 anymatch: 3.1.3 fb-watchman: 2.0.2 graceful-fs: 4.2.11 @@ -7260,7 +7260,7 @@ snapshots: jest-mock@29.7.0: dependencies: '@jest/types': 29.6.3 - '@types/node': 22.10.10 + '@types/node': 22.12.0 jest-util: 29.7.0 jest-pnp-resolver@1.2.3(jest-resolve@29.7.0): @@ -7295,7 +7295,7 @@ snapshots: '@jest/test-result': 29.7.0 '@jest/transform': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.10.10 + '@types/node': 22.12.0 chalk: 4.1.2 emittery: 0.13.1 graceful-fs: 4.2.11 @@ -7323,7 +7323,7 @@ snapshots: '@jest/test-result': 29.7.0 '@jest/transform': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.10.10 + '@types/node': 22.12.0 chalk: 4.1.2 cjs-module-lexer: 1.4.1 collect-v8-coverage: 1.0.2 @@ -7369,7 +7369,7 @@ snapshots: jest-util@29.7.0: dependencies: '@jest/types': 29.6.3 - '@types/node': 22.10.10 + '@types/node': 22.12.0 chalk: 4.1.2 ci-info: 3.9.0 graceful-fs: 4.2.11 @@ -7388,7 +7388,7 @@ snapshots: dependencies: '@jest/test-result': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 22.10.10 + '@types/node': 22.12.0 ansi-escapes: 4.3.2 chalk: 4.1.2 emittery: 0.13.1 @@ -7397,17 +7397,17 @@ snapshots: jest-worker@29.7.0: dependencies: - '@types/node': 22.10.10 + '@types/node': 22.12.0 jest-util: 29.7.0 merge-stream: 2.0.0 supports-color: 8.1.1 - jest@29.7.0(@types/node@22.10.10): + jest@29.7.0(@types/node@22.12.0): dependencies: '@jest/core': 29.7.0 '@jest/types': 29.6.3 import-local: 3.2.0 - jest-cli: 29.7.0(@types/node@22.10.10) + jest-cli: 29.7.0(@types/node@22.12.0) transitivePeerDependencies: - '@types/node' - babel-plugin-macros @@ -7962,29 +7962,29 @@ snapshots: dependencies: glob: 7.2.3 - rollup@4.32.0: + rollup@4.32.1: dependencies: '@types/estree': 1.0.6 optionalDependencies: - '@rollup/rollup-android-arm-eabi': 4.32.0 - '@rollup/rollup-android-arm64': 4.32.0 - '@rollup/rollup-darwin-arm64': 4.32.0 - '@rollup/rollup-darwin-x64': 4.32.0 - '@rollup/rollup-freebsd-arm64': 4.32.0 - '@rollup/rollup-freebsd-x64': 4.32.0 - '@rollup/rollup-linux-arm-gnueabihf': 4.32.0 - '@rollup/rollup-linux-arm-musleabihf': 4.32.0 - '@rollup/rollup-linux-arm64-gnu': 4.32.0 - '@rollup/rollup-linux-arm64-musl': 4.32.0 - '@rollup/rollup-linux-loongarch64-gnu': 4.32.0 - '@rollup/rollup-linux-powerpc64le-gnu': 4.32.0 - '@rollup/rollup-linux-riscv64-gnu': 4.32.0 - '@rollup/rollup-linux-s390x-gnu': 4.32.0 - '@rollup/rollup-linux-x64-gnu': 4.32.0 - '@rollup/rollup-linux-x64-musl': 4.32.0 - '@rollup/rollup-win32-arm64-msvc': 4.32.0 - '@rollup/rollup-win32-ia32-msvc': 4.32.0 - '@rollup/rollup-win32-x64-msvc': 4.32.0 + '@rollup/rollup-android-arm-eabi': 4.32.1 + '@rollup/rollup-android-arm64': 4.32.1 + '@rollup/rollup-darwin-arm64': 4.32.1 + '@rollup/rollup-darwin-x64': 4.32.1 + '@rollup/rollup-freebsd-arm64': 4.32.1 + '@rollup/rollup-freebsd-x64': 4.32.1 + '@rollup/rollup-linux-arm-gnueabihf': 4.32.1 + '@rollup/rollup-linux-arm-musleabihf': 4.32.1 + '@rollup/rollup-linux-arm64-gnu': 4.32.1 + '@rollup/rollup-linux-arm64-musl': 4.32.1 + '@rollup/rollup-linux-loongarch64-gnu': 4.32.1 + '@rollup/rollup-linux-powerpc64le-gnu': 4.32.1 + '@rollup/rollup-linux-riscv64-gnu': 4.32.1 + '@rollup/rollup-linux-s390x-gnu': 4.32.1 + '@rollup/rollup-linux-x64-gnu': 4.32.1 + '@rollup/rollup-linux-x64-musl': 4.32.1 + '@rollup/rollup-win32-arm64-msvc': 4.32.1 + '@rollup/rollup-win32-ia32-msvc': 4.32.1 + '@rollup/rollup-win32-x64-msvc': 4.32.1 fsevents: 2.3.3 run-parallel@1.2.0: @@ -8362,7 +8362,7 @@ snapshots: picocolors: 1.1.1 postcss-load-config: 6.0.1(tsx@4.19.2)(yaml@2.4.5) resolve-from: 5.0.0 - rollup: 4.32.0 + rollup: 4.32.1 source-map: 0.8.0-beta.0 sucrase: 3.35.0 tinyexec: 0.3.2 diff --git a/src/resources/addresses.ts b/src/resources/addresses.ts index 8a43b74a..ea93bb3c 100644 --- a/src/resources/addresses.ts +++ b/src/resources/addresses.ts @@ -103,22 +103,22 @@ interface Address extends Resource { notes?: string | null /** * The address geocoded latitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market. - * @example ```"40.6971494"``` + * @example ```40.6971494``` */ lat?: number | null /** * The address geocoded longitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market. - * @example ```"-74.2598672"``` + * @example ```-74.2598672``` */ lng?: number | null /** * Indicates if the latitude and logitude are present, either geocoded or manually updated. - * @example ```"true"``` + * @example ```true``` */ is_localized?: boolean | null /** * Indicates if the address has been successfully geocoded. - * @example ```"true"``` + * @example ```true``` */ is_geocoded?: boolean | null /** @@ -218,12 +218,12 @@ interface AddressCreate extends ResourceCreate { notes?: string | null /** * The address geocoded latitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market. - * @example ```"40.6971494"``` + * @example ```40.6971494``` */ lat?: number | null /** * The address geocoded longitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market. - * @example ```"-74.2598672"``` + * @example ```-74.2598672``` */ lng?: number | null /** @@ -306,12 +306,12 @@ interface AddressUpdate extends ResourceUpdate { notes?: string | null /** * The address geocoded latitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market. - * @example ```"40.6971494"``` + * @example ```40.6971494``` */ lat?: number | null /** * The address geocoded longitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market. - * @example ```"-74.2598672"``` + * @example ```-74.2598672``` */ lng?: number | null /** diff --git a/src/resources/adjustments.ts b/src/resources/adjustments.ts index 9655fc83..0f6bdc65 100644 --- a/src/resources/adjustments.ts +++ b/src/resources/adjustments.ts @@ -29,12 +29,12 @@ interface Adjustment extends Resource { currency_code: string /** * The adjustment amount, in cents. - * @example ```"1500"``` + * @example ```1500``` */ amount_cents: number /** * The adjustment amount, float. - * @example ```"15"``` + * @example ```15``` */ amount_float: number /** @@ -44,7 +44,7 @@ interface Adjustment extends Resource { formatted_amount: string /** * Indicates if negative adjustment amount is distributed for tax calculation. - * @example ```"true"``` + * @example ```true``` */ distribute_discount?: boolean | null @@ -67,12 +67,12 @@ interface AdjustmentCreate extends ResourceCreate { currency_code: string /** * The adjustment amount, in cents. - * @example ```"1500"``` + * @example ```1500``` */ amount_cents: number /** * Indicates if negative adjustment amount is distributed for tax calculation. - * @example ```"true"``` + * @example ```true``` */ distribute_discount?: boolean | null @@ -93,12 +93,12 @@ interface AdjustmentUpdate extends ResourceUpdate { currency_code?: string | null /** * The adjustment amount, in cents. - * @example ```"1500"``` + * @example ```1500``` */ amount_cents?: number | null /** * Indicates if negative adjustment amount is distributed for tax calculation. - * @example ```"true"``` + * @example ```true``` */ distribute_discount?: boolean | null diff --git a/src/resources/adyen_gateways.ts b/src/resources/adyen_gateways.ts index 1f7680c0..f16c1713 100644 --- a/src/resources/adyen_gateways.ts +++ b/src/resources/adyen_gateways.ts @@ -32,17 +32,17 @@ interface AdyenGateway extends Resource { live_url_prefix: string /** * The checkout API version, supported range is from 66 to 71, default is 71. - * @example ```"71"``` + * @example ```71``` */ api_version?: number | null /** * Indicates if the gateway will leverage on the Adyen notification webhooks, using latest API version. - * @example ```"true"``` + * @example ```true``` */ async_api?: boolean | null /** * Indicates if the gateway will use the native customer payment sources. - * @example ```"true"``` + * @example ```true``` */ native_customer_payment_sources?: boolean | null /** @@ -92,17 +92,17 @@ interface AdyenGatewayCreate extends ResourceCreate { live_url_prefix: string /** * The checkout API version, supported range is from 66 to 71, default is 71. - * @example ```"71"``` + * @example ```71``` */ api_version?: number | null /** * Indicates if the gateway will leverage on the Adyen notification webhooks, using latest API version. - * @example ```"true"``` + * @example ```true``` */ async_api?: boolean | null /** * Indicates if the gateway will use the native customer payment sources. - * @example ```"true"``` + * @example ```true``` */ native_customer_payment_sources?: boolean | null /** @@ -145,17 +145,17 @@ interface AdyenGatewayUpdate extends ResourceUpdate { live_url_prefix?: string | null /** * The checkout API version, supported range is from 66 to 71, default is 71. - * @example ```"71"``` + * @example ```71``` */ api_version?: number | null /** * Indicates if the gateway will leverage on the Adyen notification webhooks, using latest API version. - * @example ```"true"``` + * @example ```true``` */ async_api?: boolean | null /** * Indicates if the gateway will use the native customer payment sources. - * @example ```"true"``` + * @example ```true``` */ native_customer_payment_sources?: boolean | null /** diff --git a/src/resources/adyen_payments.ts b/src/resources/adyen_payments.ts index acf9517c..a3126e64 100644 --- a/src/resources/adyen_payments.ts +++ b/src/resources/adyen_payments.ts @@ -27,22 +27,22 @@ interface AdyenPayment extends Resource { public_key?: string | null /** * The merchant available payment methods for the assoiated order (i.e. country and amount). Required by the Adyen JS SDK. - * @example ```"[object Object]"``` + * @example ```{"foo":"bar"}``` */ payment_methods: Record /** * The Adyen payment request data, collected by client. - * @example ```"[object Object]"``` + * @example ```{"foo":"bar"}``` */ payment_request_data?: Record | null /** * The Adyen additional details request data, collected by client. - * @example ```"[object Object]"``` + * @example ```{"foo":"bar"}``` */ payment_request_details?: Record | null /** * The Adyen payment response, used by client (includes 'resultCode' and 'action'). - * @example ```"[object Object]"``` + * @example ```{"foo":"bar"}``` */ payment_response?: Record | null /** @@ -51,7 +51,7 @@ interface AdyenPayment extends Resource { mismatched_amounts?: boolean | null /** * Information about the payment instrument used in the transaction. - * @example ```"[object Object]"``` + * @example ```{"issuer":"cl bank","card_type":"visa"}``` */ payment_instrument?: Record | null @@ -73,22 +73,22 @@ interface AdyenPaymentUpdate extends ResourceUpdate { /** * The Adyen payment request data, collected by client. - * @example ```"[object Object]"``` + * @example ```{"foo":"bar"}``` */ payment_request_data?: Record | null /** * The Adyen additional details request data, collected by client. - * @example ```"[object Object]"``` + * @example ```{"foo":"bar"}``` */ payment_request_details?: Record | null /** * The Adyen payment response, used by client (includes 'resultCode' and 'action'). - * @example ```"[object Object]"``` + * @example ```{"foo":"bar"}``` */ payment_response?: Record | null /** * Send this attribute if you want to send additional details the payment request. - * @example ```"true"``` + * @example ```true``` */ _details?: boolean | null diff --git a/src/resources/applications.ts b/src/resources/applications.ts index dffa83c2..13a89b20 100644 --- a/src/resources/applications.ts +++ b/src/resources/applications.ts @@ -28,7 +28,7 @@ interface Application extends Resource { kind?: string | null /** * Indicates if the application has public access. - * @example ```"true"``` + * @example ```true``` */ public_access?: boolean | null /** diff --git a/src/resources/authorizations.ts b/src/resources/authorizations.ts index 28f6dfbf..08e28676 100644 --- a/src/resources/authorizations.ts +++ b/src/resources/authorizations.ts @@ -44,12 +44,12 @@ interface Authorization extends Resource { currency_code: string /** * The transaction amount, in cents. - * @example ```"1500"``` + * @example ```1500``` */ amount_cents: number /** * The transaction amount, float. - * @example ```"15"``` + * @example ```15``` */ amount_float: number /** @@ -113,12 +113,12 @@ interface Authorization extends Resource { fraud_review?: string | null /** * The amount to be captured, in cents. - * @example ```"500"``` + * @example ```500``` */ capture_amount_cents?: number | null /** * The amount to be captured, float. - * @example ```"5"``` + * @example ```5``` */ capture_amount_float?: number | null /** @@ -128,12 +128,12 @@ interface Authorization extends Resource { formatted_capture_amount?: string | null /** * The balance to be captured, in cents. - * @example ```"1000"``` + * @example ```1000``` */ capture_balance_cents?: number | null /** * The balance to be captured, float. - * @example ```"10"``` + * @example ```10``` */ capture_balance_float?: number | null /** @@ -143,12 +143,12 @@ interface Authorization extends Resource { formatted_capture_balance?: string | null /** * The balance to be voided, in cents. - * @example ```"1500"``` + * @example ```1500``` */ void_balance_cents?: number | null /** * The balance to be voided, float. - * @example ```"15"``` + * @example ```15``` */ void_balance_float?: number | null /** @@ -176,27 +176,27 @@ interface AuthorizationUpdate extends ResourceUpdate { succeeded?: boolean | null /** * Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly. - * @example ```"true"``` + * @example ```true``` */ _forward?: boolean | null /** * Send this attribute if you want to create a capture for this authorization. - * @example ```"true"``` + * @example ```true``` */ _capture?: boolean | null /** * Send this attribute as a value in cents if you want to overwrite the amount to be captured. - * @example ```"500"``` + * @example ```500``` */ _capture_amount_cents?: number | null /** * Send this attribute if you want to create a void for this authorization. - * @example ```"true"``` + * @example ```true``` */ _void?: boolean | null /** * Send this attribute if you want to void a succeeded authorization of a pending order (which is left unpaid). - * @example ```"true"``` + * @example ```true``` */ _cancel?: boolean | null diff --git a/src/resources/avalara_accounts.ts b/src/resources/avalara_accounts.ts index 7db69fa9..e2d7e290 100644 --- a/src/resources/avalara_accounts.ts +++ b/src/resources/avalara_accounts.ts @@ -39,12 +39,12 @@ interface AvalaraAccount extends Resource { company_code: string /** * Indicates if the transaction will be recorded and visible on the Avalara website. - * @example ```"true"``` + * @example ```true``` */ commit_invoice?: boolean | null /** * Indicates if the seller is responsible for paying/remitting the customs duty & import tax to the customs authorities. - * @example ```"true"``` + * @example ```true``` */ ddp?: boolean | null @@ -81,12 +81,12 @@ interface AvalaraAccountCreate extends ResourceCreate { company_code: string /** * Indicates if the transaction will be recorded and visible on the Avalara website. - * @example ```"true"``` + * @example ```true``` */ commit_invoice?: boolean | null /** * Indicates if the seller is responsible for paying/remitting the customs duty & import tax to the customs authorities. - * @example ```"true"``` + * @example ```true``` */ ddp?: boolean | null @@ -119,12 +119,12 @@ interface AvalaraAccountUpdate extends ResourceUpdate { company_code?: string | null /** * Indicates if the transaction will be recorded and visible on the Avalara website. - * @example ```"true"``` + * @example ```true``` */ commit_invoice?: boolean | null /** * Indicates if the seller is responsible for paying/remitting the customs duty & import tax to the customs authorities. - * @example ```"true"``` + * @example ```true``` */ ddp?: boolean | null diff --git a/src/resources/axerve_payments.ts b/src/resources/axerve_payments.ts index 857ca7b8..f1cac4b2 100644 --- a/src/resources/axerve_payments.ts +++ b/src/resources/axerve_payments.ts @@ -32,7 +32,7 @@ interface AxervePayment extends Resource { return_url: string /** * The Axerve payment request data, collected by client. - * @example ```"[object Object]"``` + * @example ```{"foo":"bar"}``` */ payment_request_data?: Record | null /** @@ -42,12 +42,12 @@ interface AxervePayment extends Resource { client_ip?: string | null /** * The details of the buyer creating the payment. - * @example ```"[object Object]"``` + * @example ```{"cardHolder":{"email":"george.harrison@gmail.com"},"shippingAddress":{"firstName":"George"}}``` */ buyer_details?: Record | null /** * Requires the creation of a token to represent this payment, mandatory to use customer's wallet and order subscriptions. - * @example ```"true"``` + * @example ```true``` */ request_token?: boolean | null /** @@ -56,7 +56,7 @@ interface AxervePayment extends Resource { mismatched_amounts?: boolean | null /** * Information about the payment instrument used in the transaction. - * @example ```"[object Object]"``` + * @example ```{"issuer":"cl bank","card_type":"visa"}``` */ payment_instrument?: Record | null @@ -81,12 +81,12 @@ interface AxervePaymentCreate extends ResourceCreate { client_ip?: string | null /** * The details of the buyer creating the payment. - * @example ```"[object Object]"``` + * @example ```{"cardHolder":{"email":"george.harrison@gmail.com"},"shippingAddress":{"firstName":"George"}}``` */ buyer_details?: Record | null /** * Requires the creation of a token to represent this payment, mandatory to use customer's wallet and order subscriptions. - * @example ```"true"``` + * @example ```true``` */ request_token?: boolean | null @@ -99,12 +99,12 @@ interface AxervePaymentUpdate extends ResourceUpdate { /** * The Axerve payment request data, collected by client. - * @example ```"[object Object]"``` + * @example ```{"foo":"bar"}``` */ payment_request_data?: Record | null /** * Send this attribute if you want to update the payment with fresh order data. - * @example ```"true"``` + * @example ```true``` */ _update?: boolean | null diff --git a/src/resources/braintree_payments.ts b/src/resources/braintree_payments.ts index 619454b3..726fbf64 100644 --- a/src/resources/braintree_payments.ts +++ b/src/resources/braintree_payments.ts @@ -37,17 +37,17 @@ interface BraintreePayment extends Resource { payment_id?: string | null /** * Indicates if the payment is local, in such case Braintree will trigger a webhook call passing the "payment_id" and "payment_method_nonce" in order to complete the transaction. - * @example ```"true"``` + * @example ```true``` */ local?: boolean | null /** * Braintree payment options, 'customer_id' and 'payment_method_token'. - * @example ```"[object Object]"``` + * @example ```{"customer_id":"1234567890"}``` */ options?: Record | null /** * Information about the payment instrument used in the transaction. - * @example ```"[object Object]"``` + * @example ```{"issuer":"cl bank","card_type":"visa"}``` */ payment_instrument?: Record | null @@ -67,12 +67,12 @@ interface BraintreePaymentCreate extends ResourceCreate { payment_id?: string | null /** * Indicates if the payment is local, in such case Braintree will trigger a webhook call passing the "payment_id" and "payment_method_nonce" in order to complete the transaction. - * @example ```"true"``` + * @example ```true``` */ local?: boolean | null /** * Braintree payment options, 'customer_id' and 'payment_method_token'. - * @example ```"[object Object]"``` + * @example ```{"customer_id":"1234567890"}``` */ options?: Record | null @@ -95,12 +95,12 @@ interface BraintreePaymentUpdate extends ResourceUpdate { payment_id?: string | null /** * Indicates if the payment is local, in such case Braintree will trigger a webhook call passing the "payment_id" and "payment_method_nonce" in order to complete the transaction. - * @example ```"true"``` + * @example ```true``` */ local?: boolean | null /** * Braintree payment options, 'customer_id' and 'payment_method_token'. - * @example ```"[object Object]"``` + * @example ```{"customer_id":"1234567890"}``` */ options?: Record | null diff --git a/src/resources/bundles.ts b/src/resources/bundles.ts index 3cd3da2e..d85f7e20 100644 --- a/src/resources/bundles.ts +++ b/src/resources/bundles.ts @@ -61,12 +61,12 @@ interface Bundle extends Resource { do_not_track?: boolean | null /** * The bundle price amount for the associated market, in cents. - * @example ```"10000"``` + * @example ```10000``` */ price_amount_cents?: number | null /** * The bundle price amount for the associated market, float. - * @example ```"100"``` + * @example ```100``` */ price_amount_float?: number | null /** @@ -76,12 +76,12 @@ interface Bundle extends Resource { formatted_price_amount?: string | null /** * The compared price amount, in cents. Useful to display a percentage discount. - * @example ```"13000"``` + * @example ```13000``` */ compare_at_amount_cents?: number | null /** * The compared price amount, float. - * @example ```"130"``` + * @example ```130``` */ compare_at_amount_float?: number | null /** @@ -91,7 +91,7 @@ interface Bundle extends Resource { formatted_compare_at_amount?: string | null /** * The total number of SKUs in the bundle. - * @example ```"2"``` + * @example ```2``` */ skus_count?: number | null @@ -135,22 +135,22 @@ interface BundleCreate extends ResourceCreate { image_url?: string | null /** * The bundle price amount for the associated market, in cents. - * @example ```"10000"``` + * @example ```10000``` */ price_amount_cents?: number | null /** * The compared price amount, in cents. Useful to display a percentage discount. - * @example ```"13000"``` + * @example ```13000``` */ compare_at_amount_cents?: number | null /** * Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle SKUs for the market. - * @example ```"true"``` + * @example ```true``` */ _compute_price_amount?: boolean | null /** * Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle SKUs for the market. - * @example ```"true"``` + * @example ```true``` */ _compute_compare_at_amount?: boolean | null @@ -190,22 +190,22 @@ interface BundleUpdate extends ResourceUpdate { image_url?: string | null /** * The bundle price amount for the associated market, in cents. - * @example ```"10000"``` + * @example ```10000``` */ price_amount_cents?: number | null /** * The compared price amount, in cents. Useful to display a percentage discount. - * @example ```"13000"``` + * @example ```13000``` */ compare_at_amount_cents?: number | null /** * Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle SKUs for the market. - * @example ```"true"``` + * @example ```true``` */ _compute_price_amount?: boolean | null /** * Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle SKUs for the market. - * @example ```"true"``` + * @example ```true``` */ _compute_compare_at_amount?: boolean | null diff --git a/src/resources/buy_x_pay_y_promotions.ts b/src/resources/buy_x_pay_y_promotions.ts index 75d47ba1..8fb01f04 100644 --- a/src/resources/buy_x_pay_y_promotions.ts +++ b/src/resources/buy_x_pay_y_promotions.ts @@ -48,12 +48,12 @@ interface BuyXPayYPromotion extends Resource { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -68,17 +68,17 @@ interface BuyXPayYPromotion extends Resource { expires_at: string /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * The number of times this promotion has been applied. - * @example ```"2"``` + * @example ```2``` */ total_usage_count?: number | null /** * Indicates if the promotion is active (enabled and not expired). - * @example ```"true"``` + * @example ```true``` */ active?: boolean | null /** @@ -93,17 +93,17 @@ interface BuyXPayYPromotion extends Resource { disabled_at?: string | null /** * The quantity which defines the threshold for free items (works by multiple of x). - * @example ```"3"``` + * @example ```3``` */ x: number /** * The quantity which defines how many items you get for free, with the formula x-y. - * @example ```"2"``` + * @example ```2``` */ y: number /** * Indicates if the cheapest items are discounted, allowing all of the SKUs in the associated list to be eligible for counting. - * @example ```"true"``` + * @example ```true``` */ cheapest_free?: boolean | null @@ -138,12 +138,12 @@ interface BuyXPayYPromotionCreate extends ResourceCreate { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -158,32 +158,32 @@ interface BuyXPayYPromotionCreate extends ResourceCreate { expires_at: string /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null /** * The quantity which defines the threshold for free items (works by multiple of x). - * @example ```"3"``` + * @example ```3``` */ x: number /** * The quantity which defines how many items you get for free, with the formula x-y. - * @example ```"2"``` + * @example ```2``` */ y: number /** * Indicates if the cheapest items are discounted, allowing all of the SKUs in the associated list to be eligible for counting. - * @example ```"true"``` + * @example ```true``` */ cheapest_free?: boolean | null @@ -212,12 +212,12 @@ interface BuyXPayYPromotionUpdate extends ResourceUpdate { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -232,32 +232,32 @@ interface BuyXPayYPromotionUpdate extends ResourceUpdate { expires_at?: string | null /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null /** * The quantity which defines the threshold for free items (works by multiple of x). - * @example ```"3"``` + * @example ```3``` */ x?: number | null /** * The quantity which defines how many items you get for free, with the formula x-y. - * @example ```"2"``` + * @example ```2``` */ y?: number | null /** * Indicates if the cheapest items are discounted, allowing all of the SKUs in the associated list to be eligible for counting. - * @example ```"true"``` + * @example ```true``` */ cheapest_free?: boolean | null diff --git a/src/resources/captures.ts b/src/resources/captures.ts index d254b7c7..1cf25aa4 100644 --- a/src/resources/captures.ts +++ b/src/resources/captures.ts @@ -45,12 +45,12 @@ interface Capture extends Resource { currency_code: string /** * The transaction amount, in cents. - * @example ```"1500"``` + * @example ```1500``` */ amount_cents: number /** * The transaction amount, float. - * @example ```"15"``` + * @example ```15``` */ amount_float: number /** @@ -89,12 +89,12 @@ interface Capture extends Resource { gateway_transaction_id?: string | null /** * The amount to be refunded, in cents. - * @example ```"500"``` + * @example ```500``` */ refund_amount_cents?: number | null /** * The amount to be refunded, float. - * @example ```"5"``` + * @example ```5``` */ refund_amount_float?: number | null /** @@ -104,12 +104,12 @@ interface Capture extends Resource { formatted_refund_amount?: string | null /** * The balance to be refunded, in cents. - * @example ```"1000"``` + * @example ```1000``` */ refund_balance_cents?: number | null /** * The balance to be refunded, float. - * @example ```"10"``` + * @example ```10``` */ refund_balance_float?: number | null /** @@ -138,22 +138,22 @@ interface CaptureUpdate extends ResourceUpdate { succeeded?: boolean | null /** * Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly. - * @example ```"true"``` + * @example ```true``` */ _forward?: boolean | null /** * Send this attribute if you want to create a refund for this capture. - * @example ```"true"``` + * @example ```true``` */ _refund?: boolean | null /** * Send this attribute as a value in cents if you want to overwrite the amount to be refunded. - * @example ```"500"``` + * @example ```500``` */ _refund_amount_cents?: number | null /** * Send this attribute if you want to refund a succeeded capture of a pending order (which is left unpaid). - * @example ```"true"``` + * @example ```true``` */ _cancel?: boolean | null diff --git a/src/resources/carrier_accounts.ts b/src/resources/carrier_accounts.ts index 1435b48b..341034c9 100644 --- a/src/resources/carrier_accounts.ts +++ b/src/resources/carrier_accounts.ts @@ -37,7 +37,7 @@ interface CarrierAccount extends Resource { easypost_id?: string | null /** * The Easypost carrier accounts credentials fields. - * @example ```"[object Object]"``` + * @example ```{"username":"xxxx","password":"secret"}``` */ credentials: Record @@ -62,7 +62,7 @@ interface CarrierAccountCreate extends ResourceCreate { easypost_type: string /** * The Easypost carrier accounts credentials fields. - * @example ```"[object Object]"``` + * @example ```{"username":"xxxx","password":"secret"}``` */ credentials: Record @@ -85,7 +85,7 @@ interface CarrierAccountUpdate extends ResourceUpdate { easypost_type?: string | null /** * The Easypost carrier accounts credentials fields. - * @example ```"[object Object]"``` + * @example ```{"username":"xxxx","password":"secret"}``` */ credentials?: Record | null diff --git a/src/resources/checkout_com_payments.ts b/src/resources/checkout_com_payments.ts index 64ad81dd..8eda0fb3 100644 --- a/src/resources/checkout_com_payments.ts +++ b/src/resources/checkout_com_payments.ts @@ -67,7 +67,7 @@ interface CheckoutComPayment extends Resource { redirect_uri?: string | null /** * The Checkout.com payment response, used to fetch internal data. - * @example ```"[object Object]"``` + * @example ```{"foo":"bar"}``` */ payment_response?: Record | null /** @@ -76,7 +76,7 @@ interface CheckoutComPayment extends Resource { mismatched_amounts?: boolean | null /** * Information about the payment instrument used in the transaction. - * @example ```"[object Object]"``` + * @example ```{"issuer":"cl bank","card_type":"visa"}``` */ payment_instrument?: Record | null @@ -149,12 +149,12 @@ interface CheckoutComPaymentUpdate extends ResourceUpdate { failure_url?: string | null /** * Send this attribute if you want to send additional details the payment request (i.e. upon 3DS check). - * @example ```"true"``` + * @example ```true``` */ _details?: boolean | null /** * Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic. - * @example ```"true"``` + * @example ```true``` */ _refresh?: boolean | null diff --git a/src/resources/cleanups.ts b/src/resources/cleanups.ts index 6d892268..6a435767 100644 --- a/src/resources/cleanups.ts +++ b/src/resources/cleanups.ts @@ -45,27 +45,27 @@ interface Cleanup extends Resource { interrupted_at?: string | null /** * The filters used to select the records to be cleaned. - * @example ```"[object Object]"``` + * @example ```{"code_eq":"AAA"}``` */ filters?: Record | null /** * Indicates the number of records to be cleaned. - * @example ```"300"``` + * @example ```300``` */ records_count?: number | null /** * Indicates the number of cleanup errors, if any. - * @example ```"30"``` + * @example ```30``` */ errors_count?: number | null /** * Indicates the number of records that have been cleaned. - * @example ```"270"``` + * @example ```270``` */ processed_count?: number | null /** * Contains the cleanup errors, if any. - * @example ```"[object Object]"``` + * @example ```{"ABC":{"name":["has already been taken"]}}``` */ errors_log?: Record | null @@ -84,7 +84,7 @@ interface CleanupCreate extends ResourceCreate { resource_type: string /** * The filters used to select the records to be cleaned. - * @example ```"[object Object]"``` + * @example ```{"code_eq":"AAA"}``` */ filters?: Record | null @@ -95,7 +95,7 @@ interface CleanupUpdate extends ResourceUpdate { /** * Send this attribute if you want to mark status as 'interrupted'. - * @example ```"true"``` + * @example ```true``` */ _interrupt?: boolean | null diff --git a/src/resources/coupons.ts b/src/resources/coupons.ts index a68339d4..948e56b0 100644 --- a/src/resources/coupons.ts +++ b/src/resources/coupons.ts @@ -35,12 +35,12 @@ interface Coupon extends Resource { customer_single_use?: boolean | null /** * The total number of times this coupon can be used. - * @example ```"50"``` + * @example ```50``` */ usage_limit?: number | null /** * The number of times this coupon has been used. - * @example ```"20"``` + * @example ```20``` */ usage_count?: number | null /** @@ -76,7 +76,7 @@ interface CouponCreate extends ResourceCreate { customer_single_use?: boolean | null /** * The total number of times this coupon can be used. - * @example ```"50"``` + * @example ```50``` */ usage_limit?: number | null /** @@ -110,7 +110,7 @@ interface CouponUpdate extends ResourceUpdate { customer_single_use?: boolean | null /** * The total number of times this coupon can be used. - * @example ```"50"``` + * @example ```50``` */ usage_limit?: number | null /** diff --git a/src/resources/custom_promotion_rules.ts b/src/resources/custom_promotion_rules.ts index 75cd1598..6e57cf51 100644 --- a/src/resources/custom_promotion_rules.ts +++ b/src/resources/custom_promotion_rules.ts @@ -35,7 +35,7 @@ interface CustomPromotionRule extends Resource { /** * The filters used to trigger promotion on the matching order and its relationships attributes. - * @example ```"[object Object]"``` + * @example ```{"status_eq":"pending","line_items_sku_code_eq":"AAA"}``` */ filters?: Record | null @@ -49,7 +49,7 @@ interface CustomPromotionRuleCreate extends ResourceCreate { /** * The filters used to trigger promotion on the matching order and its relationships attributes. - * @example ```"[object Object]"``` + * @example ```{"status_eq":"pending","line_items_sku_code_eq":"AAA"}``` */ filters?: Record | null @@ -62,7 +62,7 @@ interface CustomPromotionRuleUpdate extends ResourceUpdate { /** * The filters used to trigger promotion on the matching order and its relationships attributes. - * @example ```"[object Object]"``` + * @example ```{"status_eq":"pending","line_items_sku_code_eq":"AAA"}``` */ filters?: Record | null diff --git a/src/resources/customers.ts b/src/resources/customers.ts index 0830d485..471ba58e 100644 --- a/src/resources/customers.ts +++ b/src/resources/customers.ts @@ -45,7 +45,7 @@ interface Customer extends Resource { has_password?: boolean | null /** * The total number of orders for the customer. - * @example ```"6"``` + * @example ```6``` */ total_orders_count?: number | null /** diff --git a/src/resources/delivery_lead_times.ts b/src/resources/delivery_lead_times.ts index 332f0a32..4bafd807 100644 --- a/src/resources/delivery_lead_times.ts +++ b/src/resources/delivery_lead_times.ts @@ -24,22 +24,22 @@ interface DeliveryLeadTime extends Resource { /** * The delivery lead minimum time (in hours) when shipping from the associated stock location with the associated shipping method. - * @example ```"48"``` + * @example ```48``` */ min_hours: number /** * The delivery lead maximun time (in hours) when shipping from the associated stock location with the associated shipping method. - * @example ```"72"``` + * @example ```72``` */ max_hours: number /** * The delivery lead minimum time, in days (rounded). - * @example ```"2"``` + * @example ```2``` */ min_days?: number | null /** * The delivery lead maximun time, in days (rounded). - * @example ```"3"``` + * @example ```3``` */ max_days?: number | null @@ -55,12 +55,12 @@ interface DeliveryLeadTimeCreate extends ResourceCreate { /** * The delivery lead minimum time (in hours) when shipping from the associated stock location with the associated shipping method. - * @example ```"48"``` + * @example ```48``` */ min_hours: number /** * The delivery lead maximun time (in hours) when shipping from the associated stock location with the associated shipping method. - * @example ```"72"``` + * @example ```72``` */ max_hours: number @@ -74,12 +74,12 @@ interface DeliveryLeadTimeUpdate extends ResourceUpdate { /** * The delivery lead minimum time (in hours) when shipping from the associated stock location with the associated shipping method. - * @example ```"48"``` + * @example ```48``` */ min_hours?: number | null /** * The delivery lead maximun time (in hours) when shipping from the associated stock location with the associated shipping method. - * @example ```"72"``` + * @example ```72``` */ max_hours?: number | null diff --git a/src/resources/discount_engine_items.ts b/src/resources/discount_engine_items.ts index fc09e7d6..cda9eaef 100644 --- a/src/resources/discount_engine_items.ts +++ b/src/resources/discount_engine_items.ts @@ -20,7 +20,7 @@ interface DiscountEngineItem extends Resource { /** * The body of the external discount engine response. - * @example ```"[object Object]"``` + * @example ```{"foo":"bar"}``` */ body: Record diff --git a/src/resources/event_callbacks.ts b/src/resources/event_callbacks.ts index 08e77ef5..a0393d80 100644 --- a/src/resources/event_callbacks.ts +++ b/src/resources/event_callbacks.ts @@ -24,7 +24,7 @@ interface EventCallback extends Resource { callback_url: string /** * The payload sent to the callback endpoint, including the event affected resource and the specified includes. - * @example ```"[object Object]"``` + * @example ```{"data":{"attributes":{"id":"PYWehaoXJj","type":"orders"}}}``` */ payload?: Record | null /** diff --git a/src/resources/events.ts b/src/resources/events.ts index 17a787d5..a32bb7bf 100644 --- a/src/resources/events.ts +++ b/src/resources/events.ts @@ -34,7 +34,7 @@ interface EventUpdate extends ResourceUpdate { /** * Send this attribute if you want to force webhooks execution for this event. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _trigger?: boolean | null diff --git a/src/resources/exports.ts b/src/resources/exports.ts index 44884e2c..881f53e6 100644 --- a/src/resources/exports.ts +++ b/src/resources/exports.ts @@ -34,17 +34,17 @@ interface Export extends Resource { status: 'pending' | 'in_progress' | 'interrupted' | 'completed' /** * List of related resources that should be included in the export (redundant when 'fields' are specified). - * @example ```"prices.price_tiers"``` + * @example ```["prices.price_tiers"]``` */ includes?: string[] | null /** * List of fields to export for the main and related resources (automatically included). Pass the asterisk '*' to include all exportable fields for the main and related resources. - * @example ```"code,name,prices.*,prices.price_tiers.price_amount_cents"``` + * @example ```["code","name","prices.*","prices.price_tiers.price_amount_cents"]``` */ fields?: string[] | null /** * The filters used to select the records to be exported. - * @example ```"[object Object]"``` + * @example ```{"code_eq":"AAA"}``` */ filters?: Record | null /** @@ -68,7 +68,7 @@ interface Export extends Resource { interrupted_at?: string | null /** * Indicates the number of records to be exported. - * @example ```"300"``` + * @example ```300``` */ records_count?: number | null /** @@ -78,7 +78,7 @@ interface Export extends Resource { attachment_url?: string | null /** * Contains the exports errors, if any. - * @example ```"[object Object]"``` + * @example ```{"RuntimeError":"query timeout"}``` */ errors_log?: Record | null @@ -101,17 +101,17 @@ interface ExportCreate extends ResourceCreate { format?: string | null /** * List of related resources that should be included in the export (redundant when 'fields' are specified). - * @example ```"prices.price_tiers"``` + * @example ```["prices.price_tiers"]``` */ includes?: string[] | null /** * List of fields to export for the main and related resources (automatically included). Pass the asterisk '*' to include all exportable fields for the main and related resources. - * @example ```"code,name,prices.*,prices.price_tiers.price_amount_cents"``` + * @example ```["code","name","prices.*","prices.price_tiers.price_amount_cents"]``` */ fields?: string[] | null /** * The filters used to select the records to be exported. - * @example ```"[object Object]"``` + * @example ```{"code_eq":"AAA"}``` */ filters?: Record | null /** @@ -126,7 +126,7 @@ interface ExportUpdate extends ResourceUpdate { /** * Send this attribute if you want to mark status as 'interrupted'. - * @example ```"true"``` + * @example ```true``` */ _interrupt?: boolean | null diff --git a/src/resources/external_gateways.ts b/src/resources/external_gateways.ts index 8915dea6..87ccb6bc 100644 --- a/src/resources/external_gateways.ts +++ b/src/resources/external_gateways.ts @@ -56,7 +56,7 @@ interface ExternalGateway extends Resource { circuit_state?: string | null /** * The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback. - * @example ```"5"``` + * @example ```5``` */ circuit_failure_count?: number | null /** @@ -142,7 +142,7 @@ interface ExternalGatewayUpdate extends ResourceUpdate { token_url?: string | null /** * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _reset_circuit?: boolean | null diff --git a/src/resources/external_payments.ts b/src/resources/external_payments.ts index 63f8d0d8..405fbbd6 100644 --- a/src/resources/external_payments.ts +++ b/src/resources/external_payments.ts @@ -28,12 +28,12 @@ interface ExternalPayment extends Resource { payment_source_token: string /** * External payment options. - * @example ```"[object Object]"``` + * @example ```{"foo":"bar"}``` */ options?: Record | null /** * Information about the payment instrument used in the transaction. - * @example ```"[object Object]"``` + * @example ```{"issuer":"cl bank","card_type":"visa"}``` */ payment_instrument?: Record | null @@ -54,7 +54,7 @@ interface ExternalPaymentCreate extends ResourceCreate { payment_source_token: string /** * External payment options. - * @example ```"[object Object]"``` + * @example ```{"foo":"bar"}``` */ options?: Record | null @@ -67,7 +67,7 @@ interface ExternalPaymentUpdate extends ResourceUpdate { /** * External payment options. - * @example ```"[object Object]"``` + * @example ```{"foo":"bar"}``` */ options?: Record | null diff --git a/src/resources/external_promotions.ts b/src/resources/external_promotions.ts index fcd62602..c1f7e38f 100644 --- a/src/resources/external_promotions.ts +++ b/src/resources/external_promotions.ts @@ -48,12 +48,12 @@ interface ExternalPromotion extends Resource { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -68,17 +68,17 @@ interface ExternalPromotion extends Resource { expires_at: string /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * The number of times this promotion has been applied. - * @example ```"2"``` + * @example ```2``` */ total_usage_count?: number | null /** * Indicates if the promotion is active (enabled and not expired). - * @example ```"true"``` + * @example ```true``` */ active?: boolean | null /** @@ -103,7 +103,7 @@ interface ExternalPromotion extends Resource { circuit_state?: string | null /** * The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback. - * @example ```"5"``` + * @example ```5``` */ circuit_failure_count?: number | null /** @@ -143,12 +143,12 @@ interface ExternalPromotionCreate extends ResourceCreate { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -163,17 +163,17 @@ interface ExternalPromotionCreate extends ResourceCreate { expires_at: string /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null /** @@ -207,12 +207,12 @@ interface ExternalPromotionUpdate extends ResourceUpdate { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -227,17 +227,17 @@ interface ExternalPromotionUpdate extends ResourceUpdate { expires_at?: string | null /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null /** @@ -247,7 +247,7 @@ interface ExternalPromotionUpdate extends ResourceUpdate { promotion_url?: string | null /** * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _reset_circuit?: boolean | null diff --git a/src/resources/external_tax_calculators.ts b/src/resources/external_tax_calculators.ts index 8af73a42..ccd57ab7 100644 --- a/src/resources/external_tax_calculators.ts +++ b/src/resources/external_tax_calculators.ts @@ -36,7 +36,7 @@ interface ExternalTaxCalculator extends Resource { circuit_state?: string | null /** * The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback. - * @example ```"5"``` + * @example ```5``` */ circuit_failure_count?: number | null /** @@ -82,7 +82,7 @@ interface ExternalTaxCalculatorUpdate extends ResourceUpdate { tax_calculator_url?: string | null /** * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _reset_circuit?: boolean | null diff --git a/src/resources/fixed_amount_promotions.ts b/src/resources/fixed_amount_promotions.ts index 8ae96add..cd1eab62 100644 --- a/src/resources/fixed_amount_promotions.ts +++ b/src/resources/fixed_amount_promotions.ts @@ -48,12 +48,12 @@ interface FixedAmountPromotion extends Resource { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -68,17 +68,17 @@ interface FixedAmountPromotion extends Resource { expires_at: string /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * The number of times this promotion has been applied. - * @example ```"2"``` + * @example ```2``` */ total_usage_count?: number | null /** * Indicates if the promotion is active (enabled and not expired). - * @example ```"true"``` + * @example ```true``` */ active?: boolean | null /** @@ -93,12 +93,12 @@ interface FixedAmountPromotion extends Resource { disabled_at?: string | null /** * The discount fixed amount to be applied, in cents. - * @example ```"1000"``` + * @example ```1000``` */ fixed_amount_cents: number /** * The discount fixed amount to be applied, float. - * @example ```"10"``` + * @example ```10``` */ fixed_amount_float?: number | null /** @@ -138,12 +138,12 @@ interface FixedAmountPromotionCreate extends ResourceCreate { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -158,22 +158,22 @@ interface FixedAmountPromotionCreate extends ResourceCreate { expires_at: string /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null /** * The discount fixed amount to be applied, in cents. - * @example ```"1000"``` + * @example ```1000``` */ fixed_amount_cents: number @@ -202,12 +202,12 @@ interface FixedAmountPromotionUpdate extends ResourceUpdate { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -222,22 +222,22 @@ interface FixedAmountPromotionUpdate extends ResourceUpdate { expires_at?: string | null /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null /** * The discount fixed amount to be applied, in cents. - * @example ```"1000"``` + * @example ```1000``` */ fixed_amount_cents?: number | null diff --git a/src/resources/fixed_price_promotions.ts b/src/resources/fixed_price_promotions.ts index 6e47f1ed..7a90991b 100644 --- a/src/resources/fixed_price_promotions.ts +++ b/src/resources/fixed_price_promotions.ts @@ -48,12 +48,12 @@ interface FixedPricePromotion extends Resource { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -68,17 +68,17 @@ interface FixedPricePromotion extends Resource { expires_at: string /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * The number of times this promotion has been applied. - * @example ```"2"``` + * @example ```2``` */ total_usage_count?: number | null /** * Indicates if the promotion is active (enabled and not expired). - * @example ```"true"``` + * @example ```true``` */ active?: boolean | null /** @@ -93,12 +93,12 @@ interface FixedPricePromotion extends Resource { disabled_at?: string | null /** * The price fixed amount to be applied on matching SKUs, in cents. - * @example ```"1000"``` + * @example ```1000``` */ fixed_amount_cents: number /** * The discount fixed amount to be applied, float. - * @example ```"10"``` + * @example ```10``` */ fixed_amount_float?: number | null /** @@ -138,12 +138,12 @@ interface FixedPricePromotionCreate extends ResourceCreate { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -158,22 +158,22 @@ interface FixedPricePromotionCreate extends ResourceCreate { expires_at: string /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null /** * The price fixed amount to be applied on matching SKUs, in cents. - * @example ```"1000"``` + * @example ```1000``` */ fixed_amount_cents: number @@ -202,12 +202,12 @@ interface FixedPricePromotionUpdate extends ResourceUpdate { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -222,22 +222,22 @@ interface FixedPricePromotionUpdate extends ResourceUpdate { expires_at?: string | null /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null /** * The price fixed amount to be applied on matching SKUs, in cents. - * @example ```"1000"``` + * @example ```1000``` */ fixed_amount_cents?: number | null diff --git a/src/resources/flex_promotions.ts b/src/resources/flex_promotions.ts index fc89b15c..aa6ee236 100644 --- a/src/resources/flex_promotions.ts +++ b/src/resources/flex_promotions.ts @@ -31,12 +31,12 @@ interface FlexPromotion extends Resource { name: string /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -51,17 +51,17 @@ interface FlexPromotion extends Resource { expires_at: string /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * The number of times this promotion has been applied. - * @example ```"2"``` + * @example ```2``` */ total_usage_count?: number | null /** * Indicates if the promotion is active (enabled and not expired). - * @example ```"true"``` + * @example ```true``` */ active?: boolean | null /** @@ -71,7 +71,7 @@ interface FlexPromotion extends Resource { status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null /** * The discount rule to be applied. - * @example ```"[object Object]"``` + * @example ```{}``` */ rules: Record /** @@ -81,12 +81,12 @@ interface FlexPromotion extends Resource { disabled_at?: string | null /** * The rule outcomes. - * @example ```"[object Object]"``` + * @example ```{}``` */ rule_outcomes?: Record | null /** * The payload used to evaluate the rules. - * @example ```"[object Object]"``` + * @example ```{}``` */ resource_payload?: Record | null @@ -109,12 +109,12 @@ interface FlexPromotionCreate extends ResourceCreate { name: string /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -129,22 +129,22 @@ interface FlexPromotionCreate extends ResourceCreate { expires_at: string /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * The discount rule to be applied. - * @example ```"[object Object]"``` + * @example ```{}``` */ rules: Record /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null @@ -163,12 +163,12 @@ interface FlexPromotionUpdate extends ResourceUpdate { name?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -183,22 +183,22 @@ interface FlexPromotionUpdate extends ResourceUpdate { expires_at?: string | null /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * The discount rule to be applied. - * @example ```"[object Object]"``` + * @example ```{}``` */ rules?: Record | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null diff --git a/src/resources/free_gift_promotions.ts b/src/resources/free_gift_promotions.ts index 42f0ce76..7ab5ed3a 100644 --- a/src/resources/free_gift_promotions.ts +++ b/src/resources/free_gift_promotions.ts @@ -48,12 +48,12 @@ interface FreeGiftPromotion extends Resource { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -68,17 +68,17 @@ interface FreeGiftPromotion extends Resource { expires_at: string /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * The number of times this promotion has been applied. - * @example ```"2"``` + * @example ```2``` */ total_usage_count?: number | null /** * Indicates if the promotion is active (enabled and not expired). - * @example ```"true"``` + * @example ```true``` */ active?: boolean | null /** @@ -93,7 +93,7 @@ interface FreeGiftPromotion extends Resource { disabled_at?: string | null /** * The max quantity of free gifts globally applicable by the promotion. - * @example ```"3"``` + * @example ```3``` */ max_quantity?: number | null @@ -128,12 +128,12 @@ interface FreeGiftPromotionCreate extends ResourceCreate { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -148,22 +148,22 @@ interface FreeGiftPromotionCreate extends ResourceCreate { expires_at: string /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null /** * The max quantity of free gifts globally applicable by the promotion. - * @example ```"3"``` + * @example ```3``` */ max_quantity?: number | null @@ -192,12 +192,12 @@ interface FreeGiftPromotionUpdate extends ResourceUpdate { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -212,22 +212,22 @@ interface FreeGiftPromotionUpdate extends ResourceUpdate { expires_at?: string | null /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null /** * The max quantity of free gifts globally applicable by the promotion. - * @example ```"3"``` + * @example ```3``` */ max_quantity?: number | null diff --git a/src/resources/free_shipping_promotions.ts b/src/resources/free_shipping_promotions.ts index cbad133b..45709934 100644 --- a/src/resources/free_shipping_promotions.ts +++ b/src/resources/free_shipping_promotions.ts @@ -47,12 +47,12 @@ interface FreeShippingPromotion extends Resource { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -67,17 +67,17 @@ interface FreeShippingPromotion extends Resource { expires_at: string /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * The number of times this promotion has been applied. - * @example ```"2"``` + * @example ```2``` */ total_usage_count?: number | null /** * Indicates if the promotion is active (enabled and not expired). - * @example ```"true"``` + * @example ```true``` */ active?: boolean | null /** @@ -121,12 +121,12 @@ interface FreeShippingPromotionCreate extends ResourceCreate { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -141,17 +141,17 @@ interface FreeShippingPromotionCreate extends ResourceCreate { expires_at: string /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null @@ -180,12 +180,12 @@ interface FreeShippingPromotionUpdate extends ResourceUpdate { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -200,17 +200,17 @@ interface FreeShippingPromotionUpdate extends ResourceUpdate { expires_at?: string | null /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null diff --git a/src/resources/gift_cards.ts b/src/resources/gift_cards.ts index 05c0c616..fbe2ab0d 100644 --- a/src/resources/gift_cards.ts +++ b/src/resources/gift_cards.ts @@ -42,12 +42,12 @@ interface GiftCard extends Resource { currency_code?: string | null /** * The gift card initial balance, in cents. - * @example ```"15000"``` + * @example ```15000``` */ initial_balance_cents: number /** * The gift card initial balance, float. - * @example ```"150"``` + * @example ```150``` */ initial_balance_float: number /** @@ -57,12 +57,12 @@ interface GiftCard extends Resource { formatted_initial_balance: string /** * The gift card balance, in cents. - * @example ```"15000"``` + * @example ```15000``` */ balance_cents: number /** * The gift card balance, float. - * @example ```"150"``` + * @example ```150``` */ balance_float: number /** @@ -72,12 +72,12 @@ interface GiftCard extends Resource { formatted_balance: string /** * The gift card balance max, in cents. - * @example ```"100000"``` + * @example ```100000``` */ balance_max_cents?: number | null /** * The gift card balance max, float. - * @example ```"1000"``` + * @example ```1000``` */ balance_max_float?: number | null /** @@ -87,12 +87,12 @@ interface GiftCard extends Resource { formatted_balance_max?: string | null /** * The gift card balance log. Tracks all the gift card transactions. - * @example ```"[object Object],[object Object]"``` + * @example ```[{"datetime":"2019-12-23T12:00:00.000Z","balance_change_cents":-10000},{"datetime":"2020-02-01T12:00:00.000Z","balance_change_cents":5000}]``` */ balance_log: Array> /** * The gift card usage log. Tracks all the gift card usage actions by orders. - * @example ```"[object Object]"``` + * @example ```{"eNoKkhmbNp":[{"action":"use","amount_cents":-1000,"balance_cents":4000,"order_number":"11111","datetime":"2020-02-01T12:00:00.000Z"}]}``` */ usage_log: Record /** @@ -101,12 +101,12 @@ interface GiftCard extends Resource { single_use?: boolean | null /** * Indicates if the gift card can be recharged. - * @example ```"true"``` + * @example ```true``` */ rechargeable?: boolean | null /** * Indicates if redeemed gift card amount is distributed for tax calculation. - * @example ```"true"``` + * @example ```true``` */ distribute_discount?: boolean | null /** @@ -149,12 +149,12 @@ interface GiftCardCreate extends ResourceCreate { currency_code?: string | null /** * The gift card balance, in cents. - * @example ```"15000"``` + * @example ```15000``` */ balance_cents: number /** * The gift card balance max, in cents. - * @example ```"100000"``` + * @example ```100000``` */ balance_max_cents?: number | null /** @@ -163,12 +163,12 @@ interface GiftCardCreate extends ResourceCreate { single_use?: boolean | null /** * Indicates if the gift card can be recharged. - * @example ```"true"``` + * @example ```true``` */ rechargeable?: boolean | null /** * Indicates if redeemed gift card amount is distributed for tax calculation. - * @example ```"true"``` + * @example ```true``` */ distribute_discount?: boolean | null /** @@ -203,12 +203,12 @@ interface GiftCardUpdate extends ResourceUpdate { currency_code?: string | null /** * The gift card balance, in cents. - * @example ```"15000"``` + * @example ```15000``` */ balance_cents?: number | null /** * The gift card balance max, in cents. - * @example ```"100000"``` + * @example ```100000``` */ balance_max_cents?: number | null /** @@ -217,12 +217,12 @@ interface GiftCardUpdate extends ResourceUpdate { single_use?: boolean | null /** * Indicates if the gift card can be recharged. - * @example ```"true"``` + * @example ```true``` */ rechargeable?: boolean | null /** * Indicates if redeemed gift card amount is distributed for tax calculation. - * @example ```"true"``` + * @example ```true``` */ distribute_discount?: boolean | null /** @@ -242,22 +242,22 @@ interface GiftCardUpdate extends ResourceUpdate { recipient_email?: string | null /** * Send this attribute if you want to confirm a draft gift card. The gift card becomes 'inactive', waiting to be activated. - * @example ```"true"``` + * @example ```true``` */ _purchase?: boolean | null /** * Send this attribute if you want to activate a gift card. - * @example ```"true"``` + * @example ```true``` */ _activate?: boolean | null /** * Send this attribute if you want to deactivate a gift card. - * @example ```"true"``` + * @example ```true``` */ _deactivate?: boolean | null /** * The balance change, in cents. Send a negative value to reduces the card balance by the specified amount. Send a positive value to recharge the gift card (if rechargeable). - * @example ```"-5000"``` + * @example ```-5000``` */ _balance_change_cents?: number | null diff --git a/src/resources/imports.ts b/src/resources/imports.ts index a4cd5a04..383921cf 100644 --- a/src/resources/imports.ts +++ b/src/resources/imports.ts @@ -54,37 +54,37 @@ interface Import extends Resource { interrupted_at?: string | null /** * Array of objects representing the resources that are being imported. - * @example ```"[object Object],[object Object]"``` + * @example ```[{"code":"ABC","name":"Foo"},{"code":"DEF","name":"Bar"}]``` */ inputs: Array> /** * Indicates the size of the objects to be imported. - * @example ```"300"``` + * @example ```300``` */ inputs_size?: number | null /** * Indicates the number of import errors, if any. - * @example ```"30"``` + * @example ```30``` */ errors_count?: number | null /** * Indicates the number of import warnings, if any. - * @example ```"1"``` + * @example ```1``` */ warnings_count?: number | null /** * Indicates the number of records that have been processed (created or updated). - * @example ```"270"``` + * @example ```270``` */ processed_count?: number | null /** * Contains the import errors, if any. - * @example ```"[object Object]"``` + * @example ```{"ABC":{"name":["has already been taken"]}}``` */ errors_log?: Record | null /** * Contains the import warnings, if any. - * @example ```"[object Object]"``` + * @example ```{"ABC":["could not be deleted"]}``` */ warnings_log?: Record | null /** @@ -117,7 +117,7 @@ interface ImportCreate extends ResourceCreate { parent_resource_id?: string | null /** * Array of objects representing the resources that are being imported. - * @example ```"[object Object],[object Object]"``` + * @example ```[{"code":"ABC","name":"Foo"},{"code":"DEF","name":"Bar"}]``` */ inputs: Array> @@ -128,7 +128,7 @@ interface ImportUpdate extends ResourceUpdate { /** * Send this attribute if you want to mark status as 'interrupted'. - * @example ```"true"``` + * @example ```true``` */ _interrupt?: boolean | null diff --git a/src/resources/in_stock_subscriptions.ts b/src/resources/in_stock_subscriptions.ts index 6cdb1879..25118fe1 100644 --- a/src/resources/in_stock_subscriptions.ts +++ b/src/resources/in_stock_subscriptions.ts @@ -41,7 +41,7 @@ interface InStockSubscription extends Resource { sku_code?: string | null /** * The threshold at which to trigger the back in stock notification. - * @example ```"3"``` + * @example ```3``` */ stock_threshold?: number | null @@ -68,7 +68,7 @@ interface InStockSubscriptionCreate extends ResourceCreate { sku_code?: string | null /** * The threshold at which to trigger the back in stock notification. - * @example ```"3"``` + * @example ```3``` */ stock_threshold?: number | null @@ -88,17 +88,17 @@ interface InStockSubscriptionUpdate extends ResourceUpdate { sku_code?: string | null /** * The threshold at which to trigger the back in stock notification. - * @example ```"3"``` + * @example ```3``` */ stock_threshold?: number | null /** * Send this attribute if you want to activate an inactive subscription. - * @example ```"true"``` + * @example ```true``` */ _activate?: boolean | null /** * Send this attribute if you want to dactivate an active subscription. - * @example ```"true"``` + * @example ```true``` */ _deactivate?: boolean | null diff --git a/src/resources/inventory_models.ts b/src/resources/inventory_models.ts index ac53fc02..928cb33e 100644 --- a/src/resources/inventory_models.ts +++ b/src/resources/inventory_models.ts @@ -32,22 +32,22 @@ interface InventoryModel extends Resource { strategy?: string | null /** * The maximum number of stock locations used for inventory computation. - * @example ```"3"``` + * @example ```3``` */ stock_locations_cutoff?: number | null /** * The duration in seconds of the generated stock reservations. - * @example ```"3600"``` + * @example ```3600``` */ stock_reservation_cutoff?: number | null /** * Indicates if the the stock transfers must be put on hold automatically with the associated shipment. - * @example ```"true"``` + * @example ```true``` */ put_stock_transfers_on_hold?: boolean | null /** * Indicates if the the stock will be decremented manually after the order approval. - * @example ```"true"``` + * @example ```true``` */ manual_stock_decrement?: boolean | null @@ -73,22 +73,22 @@ interface InventoryModelCreate extends ResourceCreate { strategy?: string | null /** * The maximum number of stock locations used for inventory computation. - * @example ```"3"``` + * @example ```3``` */ stock_locations_cutoff?: number | null /** * The duration in seconds of the generated stock reservations. - * @example ```"3600"``` + * @example ```3600``` */ stock_reservation_cutoff?: number | null /** * Indicates if the the stock transfers must be put on hold automatically with the associated shipment. - * @example ```"true"``` + * @example ```true``` */ put_stock_transfers_on_hold?: boolean | null /** * Indicates if the the stock will be decremented manually after the order approval. - * @example ```"true"``` + * @example ```true``` */ manual_stock_decrement?: boolean | null @@ -109,22 +109,22 @@ interface InventoryModelUpdate extends ResourceUpdate { strategy?: string | null /** * The maximum number of stock locations used for inventory computation. - * @example ```"3"``` + * @example ```3``` */ stock_locations_cutoff?: number | null /** * The duration in seconds of the generated stock reservations. - * @example ```"3600"``` + * @example ```3600``` */ stock_reservation_cutoff?: number | null /** * Indicates if the the stock transfers must be put on hold automatically with the associated shipment. - * @example ```"true"``` + * @example ```true``` */ put_stock_transfers_on_hold?: boolean | null /** * Indicates if the the stock will be decremented manually after the order approval. - * @example ```"true"``` + * @example ```true``` */ manual_stock_decrement?: boolean | null diff --git a/src/resources/inventory_return_locations.ts b/src/resources/inventory_return_locations.ts index 1adb024a..2090971a 100644 --- a/src/resources/inventory_return_locations.ts +++ b/src/resources/inventory_return_locations.ts @@ -23,7 +23,7 @@ interface InventoryReturnLocation extends Resource { /** * The inventory return location priority within the associated invetory model. - * @example ```"1"``` + * @example ```1``` */ priority: number @@ -38,7 +38,7 @@ interface InventoryReturnLocationCreate extends ResourceCreate { /** * The inventory return location priority within the associated invetory model. - * @example ```"1"``` + * @example ```1``` */ priority: number @@ -52,7 +52,7 @@ interface InventoryReturnLocationUpdate extends ResourceUpdate { /** * The inventory return location priority within the associated invetory model. - * @example ```"1"``` + * @example ```1``` */ priority?: number | null diff --git a/src/resources/inventory_stock_locations.ts b/src/resources/inventory_stock_locations.ts index 9c038a84..d688512d 100644 --- a/src/resources/inventory_stock_locations.ts +++ b/src/resources/inventory_stock_locations.ts @@ -23,7 +23,7 @@ interface InventoryStockLocation extends Resource { /** * The stock location priority within the associated invetory model. - * @example ```"1"``` + * @example ```1``` */ priority: number /** @@ -42,7 +42,7 @@ interface InventoryStockLocationCreate extends ResourceCreate { /** * The stock location priority within the associated invetory model. - * @example ```"1"``` + * @example ```1``` */ priority: number /** @@ -60,7 +60,7 @@ interface InventoryStockLocationUpdate extends ResourceUpdate { /** * The stock location priority within the associated invetory model. - * @example ```"1"``` + * @example ```1``` */ priority?: number | null /** diff --git a/src/resources/klarna_payments.ts b/src/resources/klarna_payments.ts index 45746b50..e1c5d230 100644 --- a/src/resources/klarna_payments.ts +++ b/src/resources/klarna_payments.ts @@ -32,7 +32,7 @@ interface KlarnaPayment extends Resource { client_token?: string | null /** * The merchant available payment methods for the assoiated order. Available upon session creation. - * @example ```"[object Object]"``` + * @example ```[{"foo":"bar"}]``` */ payment_methods: Array> /** @@ -46,7 +46,7 @@ interface KlarnaPayment extends Resource { mismatched_amounts?: boolean | null /** * Information about the payment instrument used in the transaction. - * @example ```"[object Object]"``` + * @example ```{"issuer":"cl bank","card_type":"visa"}``` */ payment_instrument?: Record | null @@ -73,7 +73,7 @@ interface KlarnaPaymentUpdate extends ResourceUpdate { auth_token?: string | null /** * Send this attribute if you want to update the payment session with fresh order data. - * @example ```"true"``` + * @example ```true``` */ _update?: boolean | null diff --git a/src/resources/line_item_options.ts b/src/resources/line_item_options.ts index b4bbf992..aa4b4ebd 100644 --- a/src/resources/line_item_options.ts +++ b/src/resources/line_item_options.ts @@ -30,7 +30,7 @@ interface LineItemOption extends Resource { name?: string | null /** * The line item option's quantity. - * @example ```"2"``` + * @example ```2``` */ quantity: number /** @@ -40,12 +40,12 @@ interface LineItemOption extends Resource { currency_code?: string | null /** * The unit amount of the line item option, in cents. When you add a line item option to an order, this is automatically populated from associated SKU option's price. Cannot be passed by sales channels. - * @example ```"990"``` + * @example ```990``` */ unit_amount_cents?: number | null /** * The unit amount of the line item option, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce. - * @example ```"9.9"``` + * @example ```9.9``` */ unit_amount_float?: number | null /** @@ -55,12 +55,12 @@ interface LineItemOption extends Resource { formatted_unit_amount?: string | null /** * The unit amount x quantity, in cents. - * @example ```"1880"``` + * @example ```1880``` */ total_amount_cents?: number | null /** * The unit amount x quantity, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce. - * @example ```"18.8"``` + * @example ```18.8``` */ total_amount_float: number /** @@ -70,17 +70,17 @@ interface LineItemOption extends Resource { formatted_total_amount?: string | null /** * The shipping delay that the customer can expect when adding this option (hours). Inherited from the associated SKU option. - * @example ```"48"``` + * @example ```48``` */ delay_hours?: number | null /** * The shipping delay that the customer can expect when adding this option (days, rounded). - * @example ```"2"``` + * @example ```2``` */ delay_days?: number | null /** * Set of key-value pairs that represent the selected options. - * @example ```"[object Object]"``` + * @example ```{"embossing_text":"Happy Birthday!"}``` */ options: Record @@ -101,17 +101,17 @@ interface LineItemOptionCreate extends ResourceCreate { name?: string | null /** * The line item option's quantity. - * @example ```"2"``` + * @example ```2``` */ quantity: number /** * The unit amount of the line item option, in cents. When you add a line item option to an order, this is automatically populated from associated SKU option's price. Cannot be passed by sales channels. - * @example ```"990"``` + * @example ```990``` */ unit_amount_cents?: number | null /** * Set of key-value pairs that represent the selected options. - * @example ```"[object Object]"``` + * @example ```{"embossing_text":"Happy Birthday!"}``` */ options: Record @@ -131,17 +131,17 @@ interface LineItemOptionUpdate extends ResourceUpdate { name?: string | null /** * The line item option's quantity. - * @example ```"2"``` + * @example ```2``` */ quantity?: number | null /** * The unit amount of the line item option, in cents. When you add a line item option to an order, this is automatically populated from associated SKU option's price. Cannot be passed by sales channels. - * @example ```"990"``` + * @example ```990``` */ unit_amount_cents?: number | null /** * Set of key-value pairs that represent the selected options. - * @example ```"[object Object]"``` + * @example ```{"embossing_text":"Happy Birthday!"}``` */ options?: Record | null diff --git a/src/resources/line_items.ts b/src/resources/line_items.ts index aadae9e4..861a3740 100644 --- a/src/resources/line_items.ts +++ b/src/resources/line_items.ts @@ -69,12 +69,12 @@ interface LineItem extends Resource { bundle_code?: string | null /** * The line item quantity. - * @example ```"4"``` + * @example ```4``` */ quantity: number /** * When creating or updating a new line item, set this attribute to '1' if you want to inject the unit_amount_cents price from an external source. Any successive price computation will be done externally, until the attribute is reset to '0'. - * @example ```"true"``` + * @example ```true``` */ _external_price?: boolean | null /** @@ -84,12 +84,12 @@ interface LineItem extends Resource { currency_code?: string | null /** * The unit amount of the line item, in cents. Can be specified only via an integration application, or when the item is missing, otherwise is automatically computed by using one of the available methods. Cannot be passed by sales channels. - * @example ```"10000"``` + * @example ```10000``` */ unit_amount_cents?: number | null /** * The unit amount of the line item, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce. - * @example ```"100"``` + * @example ```100``` */ unit_amount_float?: number | null /** @@ -99,12 +99,12 @@ interface LineItem extends Resource { formatted_unit_amount?: string | null /** * The compared price amount, in cents. Useful to display a percentage discount. - * @example ```"13000"``` + * @example ```13000``` */ compare_at_amount_cents?: number | null /** * The compared price amount, float. - * @example ```"130"``` + * @example ```130``` */ compare_at_amount_float?: number | null /** @@ -114,12 +114,12 @@ interface LineItem extends Resource { formatted_compare_at_amount?: string | null /** * The options amount of the line item, in cents. Cannot be passed by sales channels. - * @example ```"1000"``` + * @example ```1000``` */ options_amount_cents?: number | null /** * The options amount of the line item, float. - * @example ```"10"``` + * @example ```10``` */ options_amount_float?: number | null /** @@ -129,12 +129,12 @@ interface LineItem extends Resource { formatted_options_amount?: string | null /** * The discount applied to the line item, in cents. When you apply a discount to an order, this is automatically calculated basing on the line item total_amount_cents value. - * @example ```"-1000"``` + * @example ```-1000``` */ discount_cents?: number | null /** * The discount applied to the line item, float. When you apply a discount to an order, this is automatically calculated basing on the line item total_amount_cents value. - * @example ```"10"``` + * @example ```10``` */ discount_float?: number | null /** @@ -144,12 +144,12 @@ interface LineItem extends Resource { formatted_discount?: string | null /** * Calculated as unit amount x quantity + options amount, in cents. - * @example ```"18800"``` + * @example ```18800``` */ total_amount_cents?: number | null /** * Calculated as unit amount x quantity + options amount, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce. - * @example ```"188"``` + * @example ```188``` */ total_amount_float: number /** @@ -159,12 +159,12 @@ interface LineItem extends Resource { formatted_total_amount?: string | null /** * The collected tax amount, otherwise calculated as total amount cents - discount cent * tax rate, in cents. - * @example ```"1880"``` + * @example ```1880``` */ tax_amount_cents?: number | null /** * The collected tax amount, otherwise calculated as total amount cents - discount cent * tax rate, float. - * @example ```"18.8"``` + * @example ```18.8``` */ tax_amount_float: number /** @@ -184,17 +184,17 @@ interface LineItem extends Resource { image_url?: string | null /** * The discount breakdown for this line item (if calculated). - * @example ```"[object Object]"``` + * @example ```{"41":{"name":"10% ALL","cents":-900,"weight":0.416,"coupon_code":"XXXXXXXX"}}``` */ discount_breakdown?: Record | null /** * The tax rate for this line item (if calculated). - * @example ```"0.22"``` + * @example ```0.22``` */ tax_rate?: number | null /** * The tax breakdown for this line item (if calculated). - * @example ```"[object Object]"``` + * @example ```{"id":"1234","city_amount":"0.0","state_amount":6.6,"city_tax_rate":0,"county_amount":2.78,"taxable_amount":139,"county_tax_rate":0.02,"tax_collectable":10.08,"special_tax_rate":0.005,"combined_tax_rate":0.0725,"city_taxable_amount":0,"state_sales_tax_rate":0.0475,"state_taxable_amount":139,"county_taxable_amount":139,"special_district_amount":0.7,"special_district_taxable_amount":139}``` */ tax_breakdown?: Record | null /** @@ -219,7 +219,7 @@ interface LineItem extends Resource { circuit_state?: string | null /** * The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback. - * @example ```"5"``` + * @example ```5``` */ circuit_failure_count?: number | null @@ -257,32 +257,32 @@ interface LineItemCreate extends ResourceCreate { bundle_code?: string | null /** * The line item quantity. - * @example ```"4"``` + * @example ```4``` */ quantity: number /** * When creating or updating a new line item, set this attribute to '1' if you want to inject the unit_amount_cents price from an external source. Any successive price computation will be done externally, until the attribute is reset to '0'. - * @example ```"true"``` + * @example ```true``` */ _external_price?: boolean | null /** * When creating a new line item, set this attribute to '1' if you want to update the line item quantity (if present) instead of creating a new line item for the same SKU. - * @example ```"true"``` + * @example ```true``` */ _update_quantity?: boolean | null /** * Send this attribute if you want to reserve the stock for the line item's SKUs quantity. Stock reservations expiration depends on the inventory model's cutoff. When used on update the existing active stock reservations are renewed. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _reserve_stock?: boolean | null /** * The unit amount of the line item, in cents. Can be specified only via an integration application, or when the item is missing, otherwise is automatically computed by using one of the available methods. Cannot be passed by sales channels. - * @example ```"10000"``` + * @example ```10000``` */ unit_amount_cents?: number | null /** * The compared price amount, in cents. Useful to display a percentage discount. - * @example ```"13000"``` + * @example ```13000``` */ compare_at_amount_cents?: number | null /** @@ -327,32 +327,32 @@ interface LineItemUpdate extends ResourceUpdate { bundle_code?: string | null /** * The line item quantity. - * @example ```"4"``` + * @example ```4``` */ quantity?: number | null /** * When creating or updating a new line item, set this attribute to '1' if you want to inject the unit_amount_cents price from an external source. Any successive price computation will be done externally, until the attribute is reset to '0'. - * @example ```"true"``` + * @example ```true``` */ _external_price?: boolean | null /** * Send this attribute if you want to reserve the stock for the line item's SKUs quantity. Stock reservations expiration depends on the inventory model's cutoff. When used on update the existing active stock reservations are renewed. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _reserve_stock?: boolean | null /** * The unit amount of the line item, in cents. Can be specified only via an integration application, or when the item is missing, otherwise is automatically computed by using one of the available methods. Cannot be passed by sales channels. - * @example ```"10000"``` + * @example ```10000``` */ unit_amount_cents?: number | null /** * The compared price amount, in cents. Useful to display a percentage discount. - * @example ```"13000"``` + * @example ```13000``` */ compare_at_amount_cents?: number | null /** * The options amount of the line item, in cents. Cannot be passed by sales channels. - * @example ```"1000"``` + * @example ```1000``` */ options_amount_cents?: number | null /** @@ -372,7 +372,7 @@ interface LineItemUpdate extends ResourceUpdate { frequency?: string | null /** * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _reset_circuit?: boolean | null diff --git a/src/resources/links.ts b/src/resources/links.ts index 2d409ef8..80e30b33 100644 --- a/src/resources/links.ts +++ b/src/resources/links.ts @@ -50,7 +50,7 @@ interface Link extends Resource { expires_at?: string | null /** * Indicates if the link is active (enabled and not expired). - * @example ```"true"``` + * @example ```true``` */ active?: boolean | null /** @@ -75,7 +75,7 @@ interface Link extends Resource { item_type?: 'orders' | 'skus' | 'sku_lists' | null /** * The link params to be passed in URL the query string. - * @example ```"[object Object]"``` + * @example ```{"param1":"ABC","param2":"XYZ"}``` */ params?: Record | null /** @@ -129,17 +129,17 @@ interface LinkCreate extends ResourceCreate { item_type?: 'orders' | 'skus' | 'sku_lists' | null /** * The link params to be passed in URL the query string. - * @example ```"[object Object]"``` + * @example ```{"param1":"ABC","param2":"XYZ"}``` */ params?: Record | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null @@ -182,17 +182,17 @@ interface LinkUpdate extends ResourceUpdate { domain?: string | null /** * The link params to be passed in URL the query string. - * @example ```"[object Object]"``` + * @example ```{"param1":"ABC","param2":"XYZ"}``` */ params?: Record | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null diff --git a/src/resources/markets.ts b/src/resources/markets.ts index 84c5468f..101392b3 100644 --- a/src/resources/markets.ts +++ b/src/resources/markets.ts @@ -43,7 +43,7 @@ interface Market extends Resource { /** * Unique identifier for the market (numeric). - * @example ```"1234"``` + * @example ```1234``` */ number?: number | null /** @@ -78,12 +78,12 @@ interface Market extends Resource { external_order_validation_url?: string | null /** * Indicates if market belongs to a customer_group. - * @example ```"true"``` + * @example ```true``` */ private?: boolean | null /** * When specified indicates the maximum number of shipping line items with cost that will be added to an order. - * @example ```"3"``` + * @example ```3``` */ shipping_cost_cutoff?: number | null /** @@ -147,17 +147,17 @@ interface MarketCreate extends ResourceCreate { external_order_validation_url?: string | null /** * When specified indicates the maximum number of shipping line items with cost that will be added to an order. - * @example ```"3"``` + * @example ```3``` */ shipping_cost_cutoff?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null @@ -206,17 +206,17 @@ interface MarketUpdate extends ResourceUpdate { external_order_validation_url?: string | null /** * When specified indicates the maximum number of shipping line items with cost that will be added to an order. - * @example ```"3"``` + * @example ```3``` */ shipping_cost_cutoff?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null diff --git a/src/resources/notifications.ts b/src/resources/notifications.ts index 839163c7..b1ef3340 100644 --- a/src/resources/notifications.ts +++ b/src/resources/notifications.ts @@ -33,7 +33,7 @@ interface Notification extends Resource { flash?: boolean | null /** * An internal body of the notification. - * @example ```"[object Object]"``` + * @example ```{"sku":"REDHANDBAG","name":"Enjoy your free item"}``` */ body?: Record | null @@ -55,7 +55,7 @@ interface NotificationCreate extends ResourceCreate { flash?: boolean | null /** * An internal body of the notification. - * @example ```"[object Object]"``` + * @example ```{"sku":"REDHANDBAG","name":"Enjoy your free item"}``` */ body?: Record | null @@ -77,7 +77,7 @@ interface NotificationUpdate extends ResourceUpdate { flash?: boolean | null /** * An internal body of the notification. - * @example ```"[object Object]"``` + * @example ```{"sku":"REDHANDBAG","name":"Enjoy your free item"}``` */ body?: Record | null diff --git a/src/resources/order_amount_promotion_rules.ts b/src/resources/order_amount_promotion_rules.ts index 54a9787d..03ac4e41 100644 --- a/src/resources/order_amount_promotion_rules.ts +++ b/src/resources/order_amount_promotion_rules.ts @@ -35,12 +35,12 @@ interface OrderAmountPromotionRule extends Resource { /** * Apply the promotion only when order is over this amount, in cents. - * @example ```"1000"``` + * @example ```1000``` */ order_amount_cents?: number | null /** * Apply the promotion only when order is over this amount, float. - * @example ```"10"``` + * @example ```10``` */ order_amount_float?: number | null /** @@ -50,7 +50,7 @@ interface OrderAmountPromotionRule extends Resource { formatted_order_amount?: string | null /** * Send this attribute if you want to compare the specified amount with order's subtotal (excluding discounts, if any). - * @example ```"true"``` + * @example ```true``` */ use_subtotal?: boolean | null @@ -64,12 +64,12 @@ interface OrderAmountPromotionRuleCreate extends ResourceCreate { /** * Apply the promotion only when order is over this amount, in cents. - * @example ```"1000"``` + * @example ```1000``` */ order_amount_cents?: number | null /** * Send this attribute if you want to compare the specified amount with order's subtotal (excluding discounts, if any). - * @example ```"true"``` + * @example ```true``` */ use_subtotal?: boolean | null @@ -82,12 +82,12 @@ interface OrderAmountPromotionRuleUpdate extends ResourceUpdate { /** * Apply the promotion only when order is over this amount, in cents. - * @example ```"1000"``` + * @example ```1000``` */ order_amount_cents?: number | null /** * Send this attribute if you want to compare the specified amount with order's subtotal (excluding discounts, if any). - * @example ```"true"``` + * @example ```true``` */ use_subtotal?: boolean | null diff --git a/src/resources/order_copies.ts b/src/resources/order_copies.ts index 9340175e..1ac7f370 100644 --- a/src/resources/order_copies.ts +++ b/src/resources/order_copies.ts @@ -42,42 +42,42 @@ interface OrderCopy extends Resource { failed_at?: string | null /** * Contains the order copy errors, if any. - * @example ```"[object Object]"``` + * @example ```{"status":["cannot transition from draft to placed"]}``` */ errors_log?: Record | null /** * Indicates the number of copy errors, if any. - * @example ```"2"``` + * @example ```2``` */ errors_count?: number | null /** * Indicates if the target order must be placed upon copy. - * @example ```"true"``` + * @example ```true``` */ place_target_order?: boolean | null /** * Indicates if the payment source within the source order customer's wallet must be copied. - * @example ```"true"``` + * @example ```true``` */ reuse_wallet?: boolean | null /** * Indicates if the source order must be cancelled upon copy. - * @example ```"true"``` + * @example ```true``` */ cancel_source_order?: boolean | null /** * Indicates if promotions got applied upon copy. - * @example ```"true"``` + * @example ```true``` */ apply_promotions?: boolean | null /** * Indicates to ignore any errors during copy. - * @example ```"true"``` + * @example ```true``` */ skip_errors?: boolean | null /** * Indicates to ignore invalid coupon code during copy. - * @example ```"true"``` + * @example ```true``` */ ignore_invalid_coupon?: boolean | null @@ -93,32 +93,32 @@ interface OrderCopyCreate extends ResourceCreate { /** * Indicates if the target order must be placed upon copy. - * @example ```"true"``` + * @example ```true``` */ place_target_order?: boolean | null /** * Indicates if the payment source within the source order customer's wallet must be copied. - * @example ```"true"``` + * @example ```true``` */ reuse_wallet?: boolean | null /** * Indicates if the source order must be cancelled upon copy. - * @example ```"true"``` + * @example ```true``` */ cancel_source_order?: boolean | null /** * Indicates if promotions got applied upon copy. - * @example ```"true"``` + * @example ```true``` */ apply_promotions?: boolean | null /** * Indicates to ignore any errors during copy. - * @example ```"true"``` + * @example ```true``` */ skip_errors?: boolean | null /** * Indicates to ignore invalid coupon code during copy. - * @example ```"true"``` + * @example ```true``` */ ignore_invalid_coupon?: boolean | null diff --git a/src/resources/order_factories.ts b/src/resources/order_factories.ts index c945387c..d3eb463e 100644 --- a/src/resources/order_factories.ts +++ b/src/resources/order_factories.ts @@ -40,22 +40,22 @@ interface OrderFactory extends Resource { failed_at?: string | null /** * Contains the order copy errors, if any. - * @example ```"[object Object]"``` + * @example ```{"status":["cannot transition from draft to placed"]}``` */ errors_log?: Record | null /** * Indicates the number of copy errors, if any. - * @example ```"2"``` + * @example ```2``` */ errors_count?: number | null /** * Indicates if the target order must be placed upon copy. - * @example ```"true"``` + * @example ```true``` */ place_target_order?: boolean | null /** * Indicates if the payment source within the source order customer's wallet must be copied. - * @example ```"true"``` + * @example ```true``` */ reuse_wallet?: boolean | null diff --git a/src/resources/order_subscription_items.ts b/src/resources/order_subscription_items.ts index 4ef7af4e..36f45758 100644 --- a/src/resources/order_subscription_items.ts +++ b/src/resources/order_subscription_items.ts @@ -37,17 +37,17 @@ interface OrderSubscriptionItem extends Resource { bundle_code?: string | null /** * The subscription item quantity. - * @example ```"4"``` + * @example ```4``` */ quantity: number /** * The unit amount of the subscription item, in cents. - * @example ```"9900"``` + * @example ```9900``` */ unit_amount_cents?: number | null /** * The unit amount of the subscription item, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce. - * @example ```"99"``` + * @example ```99``` */ unit_amount_float?: number | null /** @@ -57,12 +57,12 @@ interface OrderSubscriptionItem extends Resource { formatted_unit_amount?: string | null /** * Calculated as unit amount x quantity amount, in cents. - * @example ```"18800"``` + * @example ```18800``` */ total_amount_cents?: number | null /** * Calculated as unit amount x quantity amount, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce. - * @example ```"188"``` + * @example ```188``` */ total_amount_float: number /** @@ -95,12 +95,12 @@ interface OrderSubscriptionItemCreate extends ResourceCreate { bundle_code?: string | null /** * The subscription item quantity. - * @example ```"4"``` + * @example ```4``` */ quantity: number /** * The unit amount of the subscription item, in cents. - * @example ```"9900"``` + * @example ```9900``` */ unit_amount_cents?: number | null @@ -127,12 +127,12 @@ interface OrderSubscriptionItemUpdate extends ResourceUpdate { bundle_code?: string | null /** * The subscription item quantity. - * @example ```"4"``` + * @example ```4``` */ quantity?: number | null /** * The unit amount of the subscription item, in cents. - * @example ```"9900"``` + * @example ```9900``` */ unit_amount_cents?: number | null diff --git a/src/resources/order_subscriptions.ts b/src/resources/order_subscriptions.ts index b0d625c6..b898e5f9 100644 --- a/src/resources/order_subscriptions.ts +++ b/src/resources/order_subscriptions.ts @@ -48,17 +48,17 @@ interface OrderSubscription extends Resource { frequency: string /** * Indicates if the subscription will be activated considering the placed source order as its first run. - * @example ```"true"``` + * @example ```true``` */ activate_by_source_order?: boolean | null /** * Indicates if the subscription created orders are automatically placed at the end of the copy. - * @example ```"true"``` + * @example ```true``` */ place_target_order?: boolean | null /** * Indicates the number of hours the renewal alert will be triggered before the subscription next run. Must be included between 1 and 720 hours. - * @example ```"1"``` + * @example ```1``` */ renewal_alert_period?: number | null /** @@ -88,17 +88,17 @@ interface OrderSubscription extends Resource { next_run_at?: string | null /** * The number of times this subscription has run. - * @example ```"2"``` + * @example ```2``` */ occurrencies?: number | null /** * Indicates the number of subscription errors, if any. - * @example ```"3"``` + * @example ```3``` */ errors_count?: number | null /** * Indicates if the subscription has succeeded on its last run. - * @example ```"true"``` + * @example ```true``` */ succeeded_on_last_run?: boolean | null @@ -127,17 +127,17 @@ interface OrderSubscriptionCreate extends ResourceCreate { frequency: string /** * Indicates if the subscription will be activated considering the placed source order as its first run. - * @example ```"true"``` + * @example ```true``` */ activate_by_source_order?: boolean | null /** * Indicates if the subscription created orders are automatically placed at the end of the copy. - * @example ```"true"``` + * @example ```true``` */ place_target_order?: boolean | null /** * Indicates the number of hours the renewal alert will be triggered before the subscription next run. Must be included between 1 and 720 hours. - * @example ```"1"``` + * @example ```1``` */ renewal_alert_period?: number | null /** @@ -167,17 +167,17 @@ interface OrderSubscriptionUpdate extends ResourceUpdate { frequency?: string | null /** * Indicates if the subscription will be activated considering the placed source order as its first run. - * @example ```"true"``` + * @example ```true``` */ activate_by_source_order?: boolean | null /** * Indicates if the subscription created orders are automatically placed at the end of the copy. - * @example ```"true"``` + * @example ```true``` */ place_target_order?: boolean | null /** * Indicates the number of hours the renewal alert will be triggered before the subscription next run. Must be included between 1 and 720 hours. - * @example ```"1"``` + * @example ```1``` */ renewal_alert_period?: number | null /** @@ -192,22 +192,22 @@ interface OrderSubscriptionUpdate extends ResourceUpdate { next_run_at?: string | null /** * Send this attribute if you want to mark this subscription as active. - * @example ```"true"``` + * @example ```true``` */ _activate?: boolean | null /** * Send this attribute if you want to mark this subscription as inactive. - * @example ```"true"``` + * @example ```true``` */ _deactivate?: boolean | null /** * Send this attribute if you want to mark this subscription as cancelled. - * @example ```"true"``` + * @example ```true``` */ _cancel?: boolean | null /** * Send this attribute if you want to convert a manual subscription to an automatic one. A subscription model is required before conversion. - * @example ```"true"``` + * @example ```true``` */ _convert?: boolean | null diff --git a/src/resources/orders.ts b/src/resources/orders.ts index 04fee24e..2e6244bc 100644 --- a/src/resources/orders.ts +++ b/src/resources/orders.ts @@ -85,12 +85,12 @@ interface Order extends Resource { affiliate_code?: string | null /** * Save this attribute as 'false' if you want prevent the order to be refreshed automatically at each change (much faster). - * @example ```"true"``` + * @example ```true``` */ autorefresh?: boolean | null /** * Save this attribute as 'true' if you want perform the place asynchronously. Payment errors, if any, will be collected afterwards. - * @example ```"true"``` + * @example ```true``` */ place_async?: boolean | null /** @@ -110,12 +110,12 @@ interface Order extends Resource { fulfillment_status: 'unfulfilled' | 'in_progress' | 'fulfilled' | 'not_required' /** * Indicates if the order has been placed as guest. - * @example ```"true"``` + * @example ```true``` */ guest?: boolean | null /** * Indicates if the order can be edited. - * @example ```"true"``` + * @example ```true``` */ editable?: boolean | null /** @@ -135,27 +135,27 @@ interface Order extends Resource { currency_code?: string | null /** * Indicates if taxes are included in the order amounts, automatically inherited from the order's price list. - * @example ```"true"``` + * @example ```true``` */ tax_included?: boolean | null /** * The tax rate for this order (if calculated). - * @example ```"0.22"``` + * @example ```0.22``` */ tax_rate?: number | null /** * Indicates if taxes are applied to shipping costs. - * @example ```"true"``` + * @example ```true``` */ freight_taxable?: boolean | null /** * Indicates if taxes are applied to payment methods costs. - * @example ```"true"``` + * @example ```true``` */ payment_method_taxable?: boolean | null /** * Indicates if taxes are applied to positive adjustments. - * @example ```"true"``` + * @example ```true``` */ adjustment_taxable?: boolean | null /** @@ -188,12 +188,12 @@ interface Order extends Resource { gift_card_code?: string | null /** * The sum of all the SKU line items total amounts, in cents. - * @example ```"5000"``` + * @example ```5000``` */ subtotal_amount_cents?: number | null /** * The sum of all the SKU line items total amounts, float. - * @example ```"50"``` + * @example ```50``` */ subtotal_amount_float?: number | null /** @@ -203,12 +203,12 @@ interface Order extends Resource { formatted_subtotal_amount?: string | null /** * The sum of all the shipping costs, in cents. - * @example ```"1200"``` + * @example ```1200``` */ shipping_amount_cents?: number | null /** * The sum of all the shipping costs, float. - * @example ```"12"``` + * @example ```12``` */ shipping_amount_float?: number | null /** @@ -231,12 +231,12 @@ interface Order extends Resource { formatted_payment_method_amount?: string | null /** * The sum of all the discounts applied to the order, in cents (negative amount). - * @example ```"-500"``` + * @example ```-500``` */ discount_amount_cents?: number | null /** * The sum of all the discounts applied to the order, float. - * @example ```"-5"``` + * @example ```-5``` */ discount_amount_float?: number | null /** @@ -246,12 +246,12 @@ interface Order extends Resource { formatted_discount_amount?: string | null /** * The sum of all the adjustments applied to the order, in cents. - * @example ```"1500"``` + * @example ```1500``` */ adjustment_amount_cents?: number | null /** * The sum of all the adjustments applied to the order, float. - * @example ```"15"``` + * @example ```15``` */ adjustment_amount_float?: number | null /** @@ -261,12 +261,12 @@ interface Order extends Resource { formatted_adjustment_amount?: string | null /** * The sum of all the gift_cards applied to the order, in cents. - * @example ```"1500"``` + * @example ```1500``` */ gift_card_amount_cents?: number | null /** * The sum of all the gift_cards applied to the order, float. - * @example ```"15"``` + * @example ```15``` */ gift_card_amount_float?: number | null /** @@ -276,12 +276,12 @@ interface Order extends Resource { formatted_gift_card_amount?: string | null /** * The sum of all the taxes applied to the order, in cents. - * @example ```"1028"``` + * @example ```1028``` */ total_tax_amount_cents?: number | null /** * The sum of all the taxes applied to the order, float. - * @example ```"10.28"``` + * @example ```10.28``` */ total_tax_amount_float?: number | null /** @@ -291,12 +291,12 @@ interface Order extends Resource { formatted_total_tax_amount?: string | null /** * The taxes applied to the order's subtotal, in cents. - * @example ```"902"``` + * @example ```902``` */ subtotal_tax_amount_cents?: number | null /** * The taxes applied to the order's subtotal, float. - * @example ```"9.02"``` + * @example ```9.02``` */ subtotal_tax_amount_float?: number | null /** @@ -306,12 +306,12 @@ interface Order extends Resource { formatted_subtotal_tax_amount?: string | null /** * The taxes applied to the order's shipping costs, in cents. - * @example ```"216"``` + * @example ```216``` */ shipping_tax_amount_cents?: number | null /** * The taxes applied to the order's shipping costs, float. - * @example ```"2.16"``` + * @example ```2.16``` */ shipping_tax_amount_float?: number | null /** @@ -334,12 +334,12 @@ interface Order extends Resource { formatted_payment_method_tax_amount?: string | null /** * The taxes applied to the order adjustments, in cents. - * @example ```"900"``` + * @example ```900``` */ adjustment_tax_amount_cents?: number | null /** * The taxes applied to the order adjustments, float. - * @example ```"9"``` + * @example ```9``` */ adjustment_tax_amount_float?: number | null /** @@ -349,12 +349,12 @@ interface Order extends Resource { formatted_adjustment_tax_amount?: string | null /** * The order's total amount, in cents. - * @example ```"5700"``` + * @example ```5700``` */ total_amount_cents?: number | null /** * The order's total amount, float. - * @example ```"57"``` + * @example ```57``` */ total_amount_float?: number | null /** @@ -364,12 +364,12 @@ interface Order extends Resource { formatted_total_amount?: string | null /** * The order's total taxable amount, in cents (without discounts). - * @example ```"4672"``` + * @example ```4672``` */ total_taxable_amount_cents?: number | null /** * The order's total taxable amount, float. - * @example ```"46.72"``` + * @example ```46.72``` */ total_taxable_amount_float?: number | null /** @@ -379,12 +379,12 @@ interface Order extends Resource { formatted_total_taxable_amount?: string | null /** * The order's subtotal taxable amount, in cents (equal to subtotal_amount_cents when prices don't include taxes). - * @example ```"4098"``` + * @example ```4098``` */ subtotal_taxable_amount_cents?: number | null /** * The order's subtotal taxable amount, float. - * @example ```"40.98"``` + * @example ```40.98``` */ subtotal_taxable_amount_float?: number | null /** @@ -394,12 +394,12 @@ interface Order extends Resource { formatted_subtotal_taxable_amount?: string | null /** * The order's shipping taxable amount, in cents (equal to shipping_amount_cents when prices don't include taxes). - * @example ```"984"``` + * @example ```984``` */ shipping_taxable_amount_cents?: number | null /** * The order's shipping taxable amount, float. - * @example ```"9.84"``` + * @example ```9.84``` */ shipping_taxable_amount_float?: number | null /** @@ -422,12 +422,12 @@ interface Order extends Resource { formatted_payment_method_taxable_amount?: string | null /** * The order's adjustment taxable amount, in cents (equal to discount_adjustment_cents when prices don't include taxes). - * @example ```"120"``` + * @example ```120``` */ adjustment_taxable_amount_cents?: number | null /** * The order's adjustment taxable amount, float. - * @example ```"1.2"``` + * @example ```1.2``` */ adjustment_taxable_amount_float?: number | null /** @@ -437,12 +437,12 @@ interface Order extends Resource { formatted_adjustment_taxable_amount?: string | null /** * The order's total amount (when prices include taxes) or the order's total + taxes amount (when prices don't include taxes, e.g. US Markets or B2B). - * @example ```"5700"``` + * @example ```5700``` */ total_amount_with_taxes_cents?: number | null /** * The order's total amount with taxes, float. - * @example ```"57"``` + * @example ```57``` */ total_amount_with_taxes_float?: number | null /** @@ -491,37 +491,37 @@ interface Order extends Resource { formatted_place_total_amount?: string | null /** * The total number of SKUs in the order's line items. This can be useful to display a preview of the customer shopping cart content. - * @example ```"2"``` + * @example ```2``` */ skus_count?: number | null /** * The total number of line item options. This can be useful to display a preview of the customer shopping cart content. - * @example ```"1"``` + * @example ```1``` */ line_item_options_count?: number | null /** * The total number of shipments. This can be useful to manage the shipping method(s) selection during checkout. - * @example ```"1"``` + * @example ```1``` */ shipments_count?: number | null /** * The total number of tax calculations. This can be useful to monitor external tax service usage. - * @example ```"1"``` + * @example ```1``` */ tax_calculations_count?: number | null /** * The total number of external validation performed. This can be useful to monitor if external validation has been triggered. - * @example ```"1"``` + * @example ```1``` */ validations_count?: number | null /** * The total number of resource errors. - * @example ```"1"``` + * @example ```1``` */ errors_count?: number | null /** * An object that contains the shareable details of the order's payment source. - * @example ```"[object Object]"``` + * @example ```{"foo":"bar"}``` */ payment_source_details?: Record | null /** @@ -601,7 +601,7 @@ interface Order extends Resource { circuit_state?: string | null /** * The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback. - * @example ```"5"``` + * @example ```5``` */ circuit_failure_count?: number | null @@ -659,17 +659,17 @@ interface OrderCreate extends ResourceCreate { affiliate_code?: string | null /** * Save this attribute as 'false' if you want prevent the order to be refreshed automatically at each change (much faster). - * @example ```"true"``` + * @example ```true``` */ autorefresh?: boolean | null /** * Save this attribute as 'true' if you want perform the place asynchronously. Payment errors, if any, will be collected afterwards. - * @example ```"true"``` + * @example ```true``` */ place_async?: boolean | null /** * Indicates if the order has been placed as guest. - * @example ```"true"``` + * @example ```true``` */ guest?: boolean | null /** @@ -689,17 +689,17 @@ interface OrderCreate extends ResourceCreate { language_code?: string | null /** * Indicates if taxes are applied to shipping costs. - * @example ```"true"``` + * @example ```true``` */ freight_taxable?: boolean | null /** * Indicates if taxes are applied to payment methods costs. - * @example ```"true"``` + * @example ```true``` */ payment_method_taxable?: boolean | null /** * Indicates if taxes are applied to positive adjustments. - * @example ```"true"``` + * @example ```true``` */ adjustment_taxable?: boolean | null /** @@ -768,17 +768,17 @@ interface OrderUpdate extends ResourceUpdate { affiliate_code?: string | null /** * Save this attribute as 'false' if you want prevent the order to be refreshed automatically at each change (much faster). - * @example ```"true"``` + * @example ```true``` */ autorefresh?: boolean | null /** * Save this attribute as 'true' if you want perform the place asynchronously. Payment errors, if any, will be collected afterwards. - * @example ```"true"``` + * @example ```true``` */ place_async?: boolean | null /** * Indicates if the order has been placed as guest. - * @example ```"true"``` + * @example ```true``` */ guest?: boolean | null /** @@ -798,17 +798,17 @@ interface OrderUpdate extends ResourceUpdate { language_code?: string | null /** * Indicates if taxes are applied to shipping costs. - * @example ```"true"``` + * @example ```true``` */ freight_taxable?: boolean | null /** * Indicates if taxes are applied to payment methods costs. - * @example ```"true"``` + * @example ```true``` */ payment_method_taxable?: boolean | null /** * Indicates if taxes are applied to positive adjustments. - * @example ```"true"``` + * @example ```true``` */ adjustment_taxable?: boolean | null /** @@ -852,67 +852,67 @@ interface OrderUpdate extends ResourceUpdate { privacy_url?: string | null /** * Send this attribute if you want to archive the order. - * @example ```"true"``` + * @example ```true``` */ _archive?: boolean | null /** * Send this attribute if you want to unarchive the order. - * @example ```"true"``` + * @example ```true``` */ _unarchive?: boolean | null /** * Send this attribute if you want to move a draft or placing order to pending. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _pending?: boolean | null /** * Send this attribute if you want to place the order. - * @example ```"true"``` + * @example ```true``` */ _place?: boolean | null /** * Send this attribute if you want to cancel a placed order. The order's authorization will be automatically voided. - * @example ```"true"``` + * @example ```true``` */ _cancel?: boolean | null /** * Send this attribute if you want to approve a placed order. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _approve?: boolean | null /** * Send this attribute if you want to approve and capture a placed order. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _approve_and_capture?: boolean | null /** * Send this attribute if you want to authorize the order's payment source. - * @example ```"true"``` + * @example ```true``` */ _authorize?: boolean | null /** * Send this attribute as a value in cents if you want to overwrite the amount to be authorized. - * @example ```"500"``` + * @example ```500``` */ _authorization_amount_cents?: number | null /** * Send this attribute if you want to capture an authorized order. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _capture?: boolean | null /** * Send this attribute if you want to refund a captured order. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _refund?: boolean | null /** * Send this attribute if you want to mark as fulfilled the order (shipments must be cancelled, shipped or delivered). Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _fulfill?: boolean | null /** * Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market). - * @example ```"true"``` + * @example ```true``` */ _update_taxes?: boolean | null /** @@ -921,7 +921,7 @@ interface OrderUpdate extends ResourceUpdate { _nullify_payment_source?: boolean | null /** * Send this attribute if you want to set the payment source associated with the last succeeded authorization. At the end of the fix the order should be placed and authorized and ready for approval. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _fix_payment_source?: boolean | null /** @@ -941,67 +941,67 @@ interface OrderUpdate extends ResourceUpdate { _customer_payment_source_id?: string | null /** * Send this attribute if you want the shipping address to be cloned from the order's billing address. - * @example ```"true"``` + * @example ```true``` */ _shipping_address_same_as_billing?: boolean | null /** * Send this attribute if you want the billing address to be cloned from the order's shipping address. - * @example ```"true"``` + * @example ```true``` */ _billing_address_same_as_shipping?: boolean | null /** * Send this attribute if you want commit the sales tax invoice to the associated tax calculator (currently supported by Avalara). - * @example ```"true"``` + * @example ```true``` */ _commit_invoice?: boolean | null /** * Send this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by Avalara). - * @example ```"true"``` + * @example ```true``` */ _refund_invoice?: boolean | null /** * Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source. - * @example ```"true"``` + * @example ```true``` */ _save_payment_source_to_customer_wallet?: boolean | null /** * Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer address. - * @example ```"true"``` + * @example ```true``` */ _save_shipping_address_to_customer_address_book?: boolean | null /** * Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer address. - * @example ```"true"``` + * @example ```true``` */ _save_billing_address_to_customer_address_book?: boolean | null /** * Send this attribute if you want to manually refresh the order. - * @example ```"true"``` + * @example ```true``` */ _refresh?: boolean | null /** * Send this attribute if you want to trigger the external validation for the order. - * @example ```"true"``` + * @example ```true``` */ _validate?: boolean | null /** * Send this attribute upon/after placing the order if you want to create order subscriptions from the line items that have a frequency. - * @example ```"true"``` + * @example ```true``` */ _create_subscriptions?: boolean | null /** * Send this attribute if you want to edit the order after it is placed. Remember you cannot exceed the original total amount. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _start_editing?: boolean | null /** * Send this attribute to stop the editing for the order and return back to placed status. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _stop_editing?: boolean | null /** * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _reset_circuit?: boolean | null diff --git a/src/resources/organizations.ts b/src/resources/organizations.ts index 1ddd7d1c..5d78bb4a 100644 --- a/src/resources/organizations.ts +++ b/src/resources/organizations.ts @@ -68,12 +68,12 @@ interface Organization extends Resource { gtm_id_test?: string | null /** * The organization's configuration. - * @example ```"[object Object]"``` + * @example ```{"mfe":{"default":{"links":{"cart":"https://cart.example.com/:order_id?accessToken=:access_token","checkout":"https://checkout.example.com/:order_id?accessToken=:accessToken","identity":"https://example.com/login","microstore":"https://example.com/microstore/?accessToken=:access_token","my_account":"https://example.com/my-custom-account?accessToken=:access_token"},"checkout":{"thankyou_page":"https://example.com/thanks/:lang/:orderId","billing_countries":[{"value":"ES","label":"Espana"},{"value":"IT","label":"Italia"},{"value":"US","label":"Unites States of America"}],"shipping_countries":[{"value":"ES","label":"Espana"},{"value":"IT","label":"Italia"},{"value":"US","label":"Unites States of America"}],"billing_states":{"FR":[{"value":"PA","label":"Paris"},{"value":"LY","label":"Lyon"},{"value":"NI","label":"Nice"},{"value":"MA","label":"Marseille"},{"value":"BO","label":"Bordeaux"}]},"shipping_states":{"FR":[{"value":"PA","label":"Paris"},{"value":"LY","label":"Lyon"},{"value":"NI","label":"Nice"},{"value":"MA","label":"Marseille"},{"value":"BO","label":"Bordeaux"}]},"default_country":"US"},"urls":{"privacy":"https://example.com/privacy/:lang","terms":"https://example.com/terms/:lang"}},"market:id:ZKcv13rT":{"links":{"cart":"https://example.com/custom-cart/:order_id?accessToken=:access_token"},"checkout":{"thankyou_page":"https://example.com/thanks/:order_id"}}}}``` */ config?: Record | null /** * Enables the redirect on the new Auth API. - * @example ```"true"``` + * @example ```true``` */ api_auth_redirect?: boolean | null /** @@ -82,17 +82,17 @@ interface Organization extends Resource { api_rules_engine?: boolean | null /** * The fallback maximum number of conditions within a rules payload on a ruleable object, default is 150. - * @example ```"150"``` + * @example ```150``` */ api_rules_engine_max_conditions_size?: number | null /** * The fallback maximum number of rules within a rules payload on a ruleable object, default is 15. - * @example ```"15"``` + * @example ```15``` */ api_rules_engine_max_rules_size?: number | null /** * Forces the usage of the new Authentication API. - * @example ```"true"``` + * @example ```true``` */ api_new_auth?: boolean | null /** @@ -101,22 +101,22 @@ interface Organization extends Resource { api_purge_single_resource?: boolean | null /** * The maximum length for the regular expressions, default is 5000. - * @example ```"5000"``` + * @example ```5000``` */ api_max_regex_length?: number | null /** * Indicates if the phone attribute is required for addresses, default is true. - * @example ```"true"``` + * @example ```true``` */ addresses_phone_required?: boolean | null /** * The maximum number line items allowed for a test order before disabling the autorefresh option. - * @example ```"50"``` + * @example ```50``` */ orders_autorefresh_cutoff_test?: number | null /** * The maximum number line items allowed for a live order before disabling the autorefresh option. - * @example ```"500"``` + * @example ```500``` */ orders_autorefresh_cutoff_live?: number | null /** @@ -129,52 +129,52 @@ interface Organization extends Resource { orders_number_editable_live?: boolean | null /** * Enables to use the order number as payment reference on supported gateways. - * @example ```"true"``` + * @example ```true``` */ orders_number_as_reference?: boolean | null /** * The maximum number of SKUs allowed for bundles, default is 10. - * @example ```"10"``` + * @example ```10``` */ bundles_max_items_count?: number | null /** * The minimum length for coupon code, default is 8. - * @example ```"8"``` + * @example ```8``` */ coupons_min_code_length?: number | null /** * The maximum length for coupon code, default is 40. - * @example ```"40"``` + * @example ```40``` */ coupons_max_code_length?: number | null /** * The minimum length for gift card code, default is 8. - * @example ```"8"``` + * @example ```8``` */ gift_cards_min_code_length?: number | null /** * The maximum length for gift card code, default is 40. - * @example ```"40"``` + * @example ```40``` */ gift_cards_max_code_length?: number | null /** * The maximum number of concurrent cleanups allowed for your organization, default is 10. - * @example ```"10"``` + * @example ```10``` */ cleanups_max_concurrent_count?: number | null /** * The maximum number of concurrent exports allowed for your organization, default is 10. - * @example ```"10"``` + * @example ```10``` */ exports_max_concurrent_count?: number | null /** * The maximum number of concurrent imports allowed for your organization, default is 10. - * @example ```"10"``` + * @example ```10``` */ imports_max_concurrent_count?: number | null /** * Enables purging of cached resources upon succeeded imports. - * @example ```"true"``` + * @example ```true``` */ imports_purge_cache?: boolean | null /** @@ -183,27 +183,27 @@ interface Organization extends Resource { imports_skip_errors?: boolean | null /** * The maximum number of active concurrent promotions allowed for your organization, default is 10. - * @example ```"10"``` + * @example ```10``` */ promotions_max_concurrent_count?: number | null /** * The maximum number of conditions within a rules payload on a promotion object, default is 150. - * @example ```"150"``` + * @example ```150``` */ promotions_max_conditions_size?: number | null /** * The maximum number of rules within a rules payload on a promotion object, default is 15. - * @example ```"15"``` + * @example ```15``` */ promotions_max_rules_size?: number | null /** * The maximum number of conditions within a rules payload on a price list object, default is 150. - * @example ```"150"``` + * @example ```150``` */ price_lists_max_conditions_size?: number | null /** * The maximum number of rules within a rules payload on a price list object, default is 15. - * @example ```"15"``` + * @example ```15``` */ price_lists_max_rules_size?: number | null /** @@ -220,12 +220,12 @@ interface Organization extends Resource { discount_engines_errors?: boolean | null /** * The maximum length for the tag name, default is 25. - * @example ```"25"``` + * @example ```25``` */ tags_max_name_length?: number | null /** * The maximum allowed number of tags for each resource, default is 10. - * @example ```"10"``` + * @example ```10``` */ tags_max_allowed_number?: number | null /** diff --git a/src/resources/packages.ts b/src/resources/packages.ts index 6297fa41..233dcb6d 100644 --- a/src/resources/packages.ts +++ b/src/resources/packages.ts @@ -33,17 +33,17 @@ interface Package extends Resource { code?: string | null /** * The package length, used to automatically calculate the tax rates from the available carrier accounts. - * @example ```"40"``` + * @example ```40``` */ length: number /** * The package width, used to automatically calculate the tax rates from the available carrier accounts. - * @example ```"40"``` + * @example ```40``` */ width: number /** * The package height, used to automatically calculate the tax rates from the available carrier accounts. - * @example ```"25"``` + * @example ```25``` */ height: number /** @@ -74,17 +74,17 @@ interface PackageCreate extends ResourceCreate { code?: string | null /** * The package length, used to automatically calculate the tax rates from the available carrier accounts. - * @example ```"40"``` + * @example ```40``` */ length: number /** * The package width, used to automatically calculate the tax rates from the available carrier accounts. - * @example ```"40"``` + * @example ```40``` */ width: number /** * The package height, used to automatically calculate the tax rates from the available carrier accounts. - * @example ```"25"``` + * @example ```25``` */ height: number /** @@ -112,17 +112,17 @@ interface PackageUpdate extends ResourceUpdate { code?: string | null /** * The package length, used to automatically calculate the tax rates from the available carrier accounts. - * @example ```"40"``` + * @example ```40``` */ length?: number | null /** * The package width, used to automatically calculate the tax rates from the available carrier accounts. - * @example ```"40"``` + * @example ```40``` */ width?: number | null /** * The package height, used to automatically calculate the tax rates from the available carrier accounts. - * @example ```"25"``` + * @example ```25``` */ height?: number | null /** diff --git a/src/resources/parcel_line_items.ts b/src/resources/parcel_line_items.ts index 6b01c25c..aa2242ff 100644 --- a/src/resources/parcel_line_items.ts +++ b/src/resources/parcel_line_items.ts @@ -33,7 +33,7 @@ interface ParcelLineItem extends Resource { bundle_code?: string | null /** * The parcel line item quantity. - * @example ```"4"``` + * @example ```4``` */ quantity: number /** @@ -58,7 +58,7 @@ interface ParcelLineItemCreate extends ResourceCreate { /** * The parcel line item quantity. - * @example ```"4"``` + * @example ```4``` */ quantity: number diff --git a/src/resources/parcels.ts b/src/resources/parcels.ts index 5197f257..348f89c1 100644 --- a/src/resources/parcels.ts +++ b/src/resources/parcels.ts @@ -31,7 +31,7 @@ interface Parcel extends Resource { number?: string | null /** * The parcel weight, used to automatically calculate the tax rates from the available carrier accounts. - * @example ```"1000"``` + * @example ```1000``` */ weight: number /** @@ -122,7 +122,7 @@ interface Parcel extends Resource { tracking_status_updated_at?: string | null /** * The parcel's full tracking history, automatically updated in real time by the shipping carrier. - * @example ```"[object Object]"``` + * @example ```[{"object":"TrackingDetail","message":"Pre-Shipment information received","status":"pre_transit","datetime":"2018-02-27T16:02:17Z","source":"DHLExpress","tracking_location":{"object":"TrackingLocation"}}]``` */ tracking_details?: Record | null /** @@ -160,7 +160,7 @@ interface ParcelCreate extends ResourceCreate { /** * The parcel weight, used to automatically calculate the tax rates from the available carrier accounts. - * @example ```"1000"``` + * @example ```1000``` */ weight: number /** @@ -251,7 +251,7 @@ interface ParcelCreate extends ResourceCreate { tracking_status_updated_at?: string | null /** * The parcel's full tracking history, automatically updated in real time by the shipping carrier. - * @example ```"[object Object]"``` + * @example ```[{"object":"TrackingDetail","message":"Pre-Shipment information received","status":"pre_transit","datetime":"2018-02-27T16:02:17Z","source":"DHLExpress","tracking_location":{"object":"TrackingLocation"}}]``` */ tracking_details?: Record | null /** @@ -285,7 +285,7 @@ interface ParcelUpdate extends ResourceUpdate { /** * The parcel weight, used to automatically calculate the tax rates from the available carrier accounts. - * @example ```"1000"``` + * @example ```1000``` */ weight?: number | null /** @@ -376,7 +376,7 @@ interface ParcelUpdate extends ResourceUpdate { tracking_status_updated_at?: string | null /** * The parcel's full tracking history, automatically updated in real time by the shipping carrier. - * @example ```"[object Object]"``` + * @example ```[{"object":"TrackingDetail","message":"Pre-Shipment information received","status":"pre_transit","datetime":"2018-02-27T16:02:17Z","source":"DHLExpress","tracking_location":{"object":"TrackingLocation"}}]``` */ tracking_details?: Record | null /** diff --git a/src/resources/payment_methods.ts b/src/resources/payment_methods.ts index 8bd9dda3..53114e40 100644 --- a/src/resources/payment_methods.ts +++ b/src/resources/payment_methods.ts @@ -46,12 +46,12 @@ interface PaymentMethod extends Resource { moto?: boolean | null /** * Send this attribute if you want to require the payment capture before fulfillment. - * @example ```"true"``` + * @example ```true``` */ require_capture?: boolean | null /** * Send this attribute if you want to automatically place the order upon authorization performed asynchronously. - * @example ```"true"``` + * @example ```true``` */ auto_place?: boolean | null /** @@ -123,12 +123,12 @@ interface PaymentMethodCreate extends ResourceCreate { moto?: boolean | null /** * Send this attribute if you want to require the payment capture before fulfillment. - * @example ```"true"``` + * @example ```true``` */ require_capture?: boolean | null /** * Send this attribute if you want to automatically place the order upon authorization performed asynchronously. - * @example ```"true"``` + * @example ```true``` */ auto_place?: boolean | null /** @@ -145,12 +145,12 @@ interface PaymentMethodCreate extends ResourceCreate { auto_capture_max_amount_cents?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null @@ -184,12 +184,12 @@ interface PaymentMethodUpdate extends ResourceUpdate { moto?: boolean | null /** * Send this attribute if you want to require the payment capture before fulfillment. - * @example ```"true"``` + * @example ```true``` */ require_capture?: boolean | null /** * Send this attribute if you want to automatically place the order upon authorization performed asynchronously. - * @example ```"true"``` + * @example ```true``` */ auto_place?: boolean | null /** @@ -206,12 +206,12 @@ interface PaymentMethodUpdate extends ResourceUpdate { auto_capture_max_amount_cents?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null diff --git a/src/resources/payment_options.ts b/src/resources/payment_options.ts index ce98c65b..79fc747d 100644 --- a/src/resources/payment_options.ts +++ b/src/resources/payment_options.ts @@ -31,7 +31,7 @@ interface PaymentOption extends Resource { payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'credit_cards' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers' /** * The payment options data to be added to the payment source payload. Check payment specific API for more details. - * @example ```"[object Object]"``` + * @example ```{"application_fee_amount":1000,"on_behalf_of":"pm_xxx"}``` */ data: Record @@ -55,7 +55,7 @@ interface PaymentOptionCreate extends ResourceCreate { payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'credit_cards' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers' /** * The payment options data to be added to the payment source payload. Check payment specific API for more details. - * @example ```"[object Object]"``` + * @example ```{"application_fee_amount":1000,"on_behalf_of":"pm_xxx"}``` */ data: Record @@ -73,7 +73,7 @@ interface PaymentOptionUpdate extends ResourceUpdate { name?: string | null /** * The payment options data to be added to the payment source payload. Check payment specific API for more details. - * @example ```"[object Object]"``` + * @example ```{"application_fee_amount":1000,"on_behalf_of":"pm_xxx"}``` */ data?: Record | null diff --git a/src/resources/paypal_payments.ts b/src/resources/paypal_payments.ts index a0c7b7bf..bb29e143 100644 --- a/src/resources/paypal_payments.ts +++ b/src/resources/paypal_payments.ts @@ -66,7 +66,7 @@ interface PaypalPayment extends Resource { mismatched_amounts?: boolean | null /** * Information about the payment instrument used in the transaction. - * @example ```"[object Object]"``` + * @example ```{"issuer":"cl bank","card_type":"visa"}``` */ payment_instrument?: Record | null diff --git a/src/resources/percentage_discount_promotions.ts b/src/resources/percentage_discount_promotions.ts index 61c1b029..69e7f59a 100644 --- a/src/resources/percentage_discount_promotions.ts +++ b/src/resources/percentage_discount_promotions.ts @@ -48,12 +48,12 @@ interface PercentageDiscountPromotion extends Resource { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -68,17 +68,17 @@ interface PercentageDiscountPromotion extends Resource { expires_at: string /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * The number of times this promotion has been applied. - * @example ```"2"``` + * @example ```2``` */ total_usage_count?: number | null /** * Indicates if the promotion is active (enabled and not expired). - * @example ```"true"``` + * @example ```true``` */ active?: boolean | null /** @@ -93,7 +93,7 @@ interface PercentageDiscountPromotion extends Resource { disabled_at?: string | null /** * The discount percentage to be applied. - * @example ```"10"``` + * @example ```10``` */ percentage: number @@ -128,12 +128,12 @@ interface PercentageDiscountPromotionCreate extends ResourceCreate { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -148,22 +148,22 @@ interface PercentageDiscountPromotionCreate extends ResourceCreate { expires_at: string /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null /** * The discount percentage to be applied. - * @example ```"10"``` + * @example ```10``` */ percentage: number @@ -192,12 +192,12 @@ interface PercentageDiscountPromotionUpdate extends ResourceUpdate { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -212,22 +212,22 @@ interface PercentageDiscountPromotionUpdate extends ResourceUpdate { expires_at?: string | null /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null /** * The discount percentage to be applied. - * @example ```"10"``` + * @example ```10``` */ percentage?: number | null diff --git a/src/resources/price_frequency_tiers.ts b/src/resources/price_frequency_tiers.ts index 63fe11ea..c6b6f1a2 100644 --- a/src/resources/price_frequency_tiers.ts +++ b/src/resources/price_frequency_tiers.ts @@ -28,17 +28,17 @@ interface PriceFrequencyTier extends Resource { name: string /** * The tier upper limit, expressed as the line item frequency in days (or frequency label, ie 'monthly'). When 'null' it means infinity (useful to have an always matching tier). - * @example ```"7"``` + * @example ```7``` */ up_to?: number | null /** * The price of this price tier, in cents. - * @example ```"1000"``` + * @example ```1000``` */ price_amount_cents: number /** * The price of this price tier, float. - * @example ```"10"``` + * @example ```10``` */ price_amount_float?: number | null /** @@ -64,12 +64,12 @@ interface PriceFrequencyTierCreate extends ResourceCreate { name: string /** * The tier upper limit, expressed as the line item frequency in days (or frequency label, ie 'monthly'). When 'null' it means infinity (useful to have an always matching tier). - * @example ```"7"``` + * @example ```7``` */ up_to?: number | null /** * The price of this price tier, in cents. - * @example ```"1000"``` + * @example ```1000``` */ price_amount_cents: number @@ -87,12 +87,12 @@ interface PriceFrequencyTierUpdate extends ResourceUpdate { name?: string | null /** * The tier upper limit, expressed as the line item frequency in days (or frequency label, ie 'monthly'). When 'null' it means infinity (useful to have an always matching tier). - * @example ```"7"``` + * @example ```7``` */ up_to?: number | null /** * The price of this price tier, in cents. - * @example ```"1000"``` + * @example ```1000``` */ price_amount_cents?: number | null diff --git a/src/resources/price_list_schedulers.ts b/src/resources/price_list_schedulers.ts index b919709d..e7e29c89 100644 --- a/src/resources/price_list_schedulers.ts +++ b/src/resources/price_list_schedulers.ts @@ -39,7 +39,7 @@ interface PriceListScheduler extends Resource { expires_at: string /** * Indicates if the price list scheduler is active (enabled and not expired). - * @example ```"true"``` + * @example ```true``` */ active?: boolean | null /** @@ -80,12 +80,12 @@ interface PriceListSchedulerCreate extends ResourceCreate { expires_at: string /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null @@ -114,12 +114,12 @@ interface PriceListSchedulerUpdate extends ResourceUpdate { expires_at?: string | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null diff --git a/src/resources/price_lists.ts b/src/resources/price_lists.ts index ed917a4f..7f5b1f0a 100644 --- a/src/resources/price_lists.ts +++ b/src/resources/price_lists.ts @@ -37,22 +37,22 @@ interface PriceList extends Resource { currency_code: string /** * Indicates if the associated prices include taxes. - * @example ```"true"``` + * @example ```true``` */ tax_included?: boolean | null /** * The rules (using Rules Engine) to be applied. - * @example ```"[object Object]"``` + * @example ```{}``` */ rules?: Record | null /** * The rule outcomes. - * @example ```"[object Object]"``` + * @example ```{}``` */ rule_outcomes?: Record | null /** * The payload used to evaluate the rules. - * @example ```"[object Object]"``` + * @example ```{}``` */ resource_payload?: Record | null @@ -83,12 +83,12 @@ interface PriceListCreate extends ResourceCreate { currency_code: string /** * Indicates if the associated prices include taxes. - * @example ```"true"``` + * @example ```true``` */ tax_included?: boolean | null /** * The rules (using Rules Engine) to be applied. - * @example ```"[object Object]"``` + * @example ```{}``` */ rules?: Record | null @@ -114,12 +114,12 @@ interface PriceListUpdate extends ResourceUpdate { currency_code?: string | null /** * Indicates if the associated prices include taxes. - * @example ```"true"``` + * @example ```true``` */ tax_included?: boolean | null /** * The rules (using Rules Engine) to be applied. - * @example ```"[object Object]"``` + * @example ```{}``` */ rules?: Record | null diff --git a/src/resources/price_tiers.ts b/src/resources/price_tiers.ts index 6375e369..b84333d6 100644 --- a/src/resources/price_tiers.ts +++ b/src/resources/price_tiers.ts @@ -26,17 +26,17 @@ interface PriceTier extends Resource { name: string /** * The tier upper limit. When 'null' it means infinity (useful to have an always matching tier). - * @example ```"20.5"``` + * @example ```20.5``` */ up_to?: number | null /** * The price of this price tier, in cents. - * @example ```"1000"``` + * @example ```1000``` */ price_amount_cents: number /** * The price of this price tier, float. - * @example ```"10"``` + * @example ```10``` */ price_amount_float?: number | null /** diff --git a/src/resources/price_volume_tiers.ts b/src/resources/price_volume_tiers.ts index 869b17e9..54826178 100644 --- a/src/resources/price_volume_tiers.ts +++ b/src/resources/price_volume_tiers.ts @@ -28,17 +28,17 @@ interface PriceVolumeTier extends Resource { name: string /** * The tier upper limit, expressed as the line item quantity. When 'null' it means infinity (useful to have an always matching tier). - * @example ```"15"``` + * @example ```15``` */ up_to?: number | null /** * The price of this price tier, in cents. - * @example ```"1000"``` + * @example ```1000``` */ price_amount_cents: number /** * The price of this price tier, float. - * @example ```"10"``` + * @example ```10``` */ price_amount_float?: number | null /** @@ -64,12 +64,12 @@ interface PriceVolumeTierCreate extends ResourceCreate { name: string /** * The tier upper limit, expressed as the line item quantity. When 'null' it means infinity (useful to have an always matching tier). - * @example ```"15"``` + * @example ```15``` */ up_to?: number | null /** * The price of this price tier, in cents. - * @example ```"1000"``` + * @example ```1000``` */ price_amount_cents: number @@ -87,12 +87,12 @@ interface PriceVolumeTierUpdate extends ResourceUpdate { name?: string | null /** * The tier upper limit, expressed as the line item quantity. When 'null' it means infinity (useful to have an always matching tier). - * @example ```"15"``` + * @example ```15``` */ up_to?: number | null /** * The price of this price tier, in cents. - * @example ```"1000"``` + * @example ```1000``` */ price_amount_cents?: number | null diff --git a/src/resources/prices.ts b/src/resources/prices.ts index 989386b4..2bea7031 100644 --- a/src/resources/prices.ts +++ b/src/resources/prices.ts @@ -41,12 +41,12 @@ interface Price extends Resource { sku_code?: string | null /** * The SKU price amount for the associated price list, in cents. - * @example ```"10000"``` + * @example ```10000``` */ amount_cents: number /** * The SKU price amount for the associated price list, float. - * @example ```"100"``` + * @example ```100``` */ amount_float?: number | null /** @@ -56,7 +56,7 @@ interface Price extends Resource { formatted_amount?: string | null /** * The SKU price amount for the associated price list, in cents before any applied rule. - * @example ```"10000"``` + * @example ```10000``` */ original_amount_cents?: number | null /** @@ -66,12 +66,12 @@ interface Price extends Resource { formatted_original_amount?: string | null /** * The compared price amount, in cents. Useful to display a percentage discount. - * @example ```"13000"``` + * @example ```13000``` */ compare_at_amount_cents?: number | null /** * The compared price amount, float. - * @example ```"130"``` + * @example ```130``` */ compare_at_amount_float?: number | null /** @@ -86,22 +86,22 @@ interface Price extends Resource { processed_at?: string | null /** * The rules (using Rules Engine) to be applied. - * @example ```"[object Object]"``` + * @example ```{}``` */ rules?: Record | null /** * The rule outcomes. - * @example ```"[object Object]"``` + * @example ```{}``` */ rule_outcomes?: Record | null /** * The payload used to evaluate the rules. - * @example ```"[object Object]"``` + * @example ```{}``` */ resource_payload?: Record | null /** * The custom_claim attached to the current JWT (if any). - * @example ```"[object Object]"``` + * @example ```{}``` */ jwt_custom_claim?: Record | null @@ -128,17 +128,17 @@ interface PriceCreate extends ResourceCreate { sku_code?: string | null /** * The SKU price amount for the associated price list, in cents. - * @example ```"10000"``` + * @example ```10000``` */ amount_cents: number /** * The compared price amount, in cents. Useful to display a percentage discount. - * @example ```"13000"``` + * @example ```13000``` */ compare_at_amount_cents?: number | null /** * The rules (using Rules Engine) to be applied. - * @example ```"[object Object]"``` + * @example ```{}``` */ rules?: Record | null @@ -158,12 +158,12 @@ interface PriceUpdate extends ResourceUpdate { sku_code?: string | null /** * The SKU price amount for the associated price list, in cents. - * @example ```"10000"``` + * @example ```10000``` */ amount_cents?: number | null /** * The compared price amount, in cents. Useful to display a percentage discount. - * @example ```"13000"``` + * @example ```13000``` */ compare_at_amount_cents?: number | null /** @@ -173,7 +173,7 @@ interface PriceUpdate extends ResourceUpdate { processed_at?: string | null /** * The rules (using Rules Engine) to be applied. - * @example ```"[object Object]"``` + * @example ```{}``` */ rules?: Record | null diff --git a/src/resources/promotions.ts b/src/resources/promotions.ts index d2e91999..83ff69ac 100644 --- a/src/resources/promotions.ts +++ b/src/resources/promotions.ts @@ -40,12 +40,12 @@ interface Promotion extends Resource { currency_code?: string | null /** * Indicates if the promotion will be applied exclusively, based on its priority score. - * @example ```"true"``` + * @example ```true``` */ exclusive?: boolean | null /** * The priority assigned to the promotion (lower means higher priority). - * @example ```"2"``` + * @example ```2``` */ priority?: number | null /** @@ -60,17 +60,17 @@ interface Promotion extends Resource { expires_at: string /** * The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times. - * @example ```"5"``` + * @example ```5``` */ total_usage_limit?: number | null /** * The number of times this promotion has been applied. - * @example ```"2"``` + * @example ```2``` */ total_usage_count?: number | null /** * Indicates if the promotion is active (enabled and not expired). - * @example ```"true"``` + * @example ```true``` */ active?: boolean | null /** diff --git a/src/resources/recurring_order_copies.ts b/src/resources/recurring_order_copies.ts index 0237de11..4671a85d 100644 --- a/src/resources/recurring_order_copies.ts +++ b/src/resources/recurring_order_copies.ts @@ -43,22 +43,22 @@ interface RecurringOrderCopy extends Resource { failed_at?: string | null /** * Contains the order copy errors, if any. - * @example ```"[object Object]"``` + * @example ```{"status":["cannot transition from draft to placed"]}``` */ errors_log?: Record | null /** * Indicates the number of copy errors, if any. - * @example ```"2"``` + * @example ```2``` */ errors_count?: number | null /** * Indicates if the target order must be placed upon copy. - * @example ```"true"``` + * @example ```true``` */ place_target_order?: boolean | null /** * Indicates if the payment source within the source order customer's wallet must be copied. - * @example ```"true"``` + * @example ```true``` */ reuse_wallet?: boolean | null @@ -74,12 +74,12 @@ interface RecurringOrderCopyCreate extends ResourceCreate { /** * Indicates if the target order must be placed upon copy. - * @example ```"true"``` + * @example ```true``` */ place_target_order?: boolean | null /** * Indicates if the payment source within the source order customer's wallet must be copied. - * @example ```"true"``` + * @example ```true``` */ reuse_wallet?: boolean | null diff --git a/src/resources/refunds.ts b/src/resources/refunds.ts index c37acf83..ff03ccbd 100644 --- a/src/resources/refunds.ts +++ b/src/resources/refunds.ts @@ -44,12 +44,12 @@ interface Refund extends Resource { currency_code: string /** * The transaction amount, in cents. - * @example ```"1500"``` + * @example ```1500``` */ amount_cents: number /** * The transaction amount, float. - * @example ```"15"``` + * @example ```15``` */ amount_float: number /** @@ -106,7 +106,7 @@ interface RefundUpdate extends ResourceUpdate { succeeded?: boolean | null /** * Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly. - * @example ```"true"``` + * @example ```true``` */ _forward?: boolean | null diff --git a/src/resources/reserved_stocks.ts b/src/resources/reserved_stocks.ts index 910d2339..1935e7fa 100644 --- a/src/resources/reserved_stocks.ts +++ b/src/resources/reserved_stocks.ts @@ -22,7 +22,7 @@ interface ReservedStock extends Resource { /** * The stock item reserved quantity. - * @example ```"100"``` + * @example ```100``` */ quantity: number diff --git a/src/resources/return_line_items.ts b/src/resources/return_line_items.ts index 09eb0185..a44a257b 100644 --- a/src/resources/return_line_items.ts +++ b/src/resources/return_line_items.ts @@ -32,7 +32,7 @@ interface ReturnLineItem extends Resource { bundle_code?: string | null /** * The return line item quantity. - * @example ```"4"``` + * @example ```4``` */ quantity: number /** @@ -47,12 +47,12 @@ interface ReturnLineItem extends Resource { image_url?: string | null /** * Calculated as line item unit amount x returned quantity and applied discounts, if any. - * @example ```"8800"``` + * @example ```8800``` */ total_amount_cents?: number | null /** * The return line item total amount, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce. - * @example ```"88"``` + * @example ```88``` */ total_amount_float: number /** @@ -62,7 +62,7 @@ interface ReturnLineItem extends Resource { formatted_total_amount?: string | null /** * Set of key-value pairs that you can use to add details about return reason. - * @example ```"[object Object]"``` + * @example ```{"size":"was wrong"}``` */ return_reason?: Record | null /** @@ -81,12 +81,12 @@ interface ReturnLineItemCreate extends ResourceCreate { /** * The return line item quantity. - * @example ```"4"``` + * @example ```4``` */ quantity: number /** * Set of key-value pairs that you can use to add details about return reason. - * @example ```"[object Object]"``` + * @example ```{"size":"was wrong"}``` */ return_reason?: Record | null @@ -100,17 +100,17 @@ interface ReturnLineItemUpdate extends ResourceUpdate { /** * The return line item quantity. - * @example ```"4"``` + * @example ```4``` */ quantity?: number | null /** * Send this attribute if you want to restock the line item. - * @example ```"true"``` + * @example ```true``` */ _restock?: boolean | null /** * Set of key-value pairs that you can use to add details about return reason. - * @example ```"[object Object]"``` + * @example ```{"size":"was wrong"}``` */ return_reason?: Record | null diff --git a/src/resources/returns.ts b/src/resources/returns.ts index bcce7c55..47971b9d 100644 --- a/src/resources/returns.ts +++ b/src/resources/returns.ts @@ -49,7 +49,7 @@ interface Return extends Resource { customer_email?: string | null /** * The total number of SKUs in the return's line items. This can be useful to display a preview of the return content. - * @example ```"2"``` + * @example ```2``` */ skus_count?: number | null /** @@ -89,12 +89,12 @@ interface Return extends Resource { archived_at?: string | null /** * The amount to be refunded, estimated by associated return line items, in cents. - * @example ```"500"``` + * @example ```500``` */ estimated_refund_amount_cents?: number | null /** * The amount to be refunded, estimated by associated return line items, float. - * @example ```"5"``` + * @example ```5``` */ estimated_refund_amount_float?: number | null /** @@ -134,57 +134,57 @@ interface ReturnUpdate extends ResourceUpdate { /** * Send this attribute if you want to activate this return. - * @example ```"true"``` + * @example ```true``` */ _request?: boolean | null /** * Send this attribute if you want to mark this return as approved. - * @example ```"true"``` + * @example ```true``` */ _approve?: boolean | null /** * Send this attribute if you want to mark this return as cancelled. - * @example ```"true"``` + * @example ```true``` */ _cancel?: boolean | null /** * Send this attribute if you want to mark this return as shipped. - * @example ```"true"``` + * @example ```true``` */ _ship?: boolean | null /** * Send this attribute if you want to mark this return as rejected. - * @example ```"true"``` + * @example ```true``` */ _reject?: boolean | null /** * Send this attribute if you want to mark this return as received. - * @example ```"true"``` + * @example ```true``` */ _receive?: boolean | null /** * Send this attribute if you want to restock all of the return line items. - * @example ```"true"``` + * @example ```true``` */ _restock?: boolean | null /** * Send this attribute if you want to archive the return. - * @example ```"true"``` + * @example ```true``` */ _archive?: boolean | null /** * Send this attribute if you want to unarchive the return. - * @example ```"true"``` + * @example ```true``` */ _unarchive?: boolean | null /** * Send this attribute if you want to create a refund for this return. - * @example ```"true"``` + * @example ```true``` */ _refund?: boolean | null /** * Send this attribute as a value in cents to specify the amount to be refunded. - * @example ```"500"``` + * @example ```500``` */ _refund_amount_cents?: number | null diff --git a/src/resources/satispay_payments.ts b/src/resources/satispay_payments.ts index 1ac43fd8..3b07bbeb 100644 --- a/src/resources/satispay_payments.ts +++ b/src/resources/satispay_payments.ts @@ -47,12 +47,12 @@ interface SatispayPayment extends Resource { payment_url?: string | null /** * The Satispay payment response, used to fetch internal data. - * @example ```"[object Object]"``` + * @example ```{"foo":"bar"}``` */ payment_response?: Record | null /** * Information about the payment instrument used in the transaction. - * @example ```"[object Object]"``` + * @example ```{"issuer":"cl bank","card_type":"visa"}``` */ payment_instrument?: Record | null @@ -90,7 +90,7 @@ interface SatispayPaymentUpdate extends ResourceUpdate { redirect_url?: string | null /** * Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic. - * @example ```"true"``` + * @example ```true``` */ _refresh?: boolean | null diff --git a/src/resources/shipments.ts b/src/resources/shipments.ts index 0833ad1d..47f01bf4 100644 --- a/src/resources/shipments.ts +++ b/src/resources/shipments.ts @@ -55,12 +55,12 @@ interface Shipment extends Resource { currency_code?: string | null /** * The cost of this shipment from the selected carrier account, in cents. - * @example ```"1000"``` + * @example ```1000``` */ cost_amount_cents?: number | null /** * The cost of this shipment from the selected carrier account, float. - * @example ```"10"``` + * @example ```10``` */ cost_amount_float?: number | null /** @@ -70,7 +70,7 @@ interface Shipment extends Resource { formatted_cost_amount?: string | null /** * The total number of SKUs in the shipment's line items. This can be useful to display a preview of the shipment content. - * @example ```"2"``` + * @example ```2``` */ skus_count?: number | null /** @@ -80,7 +80,7 @@ interface Shipment extends Resource { selected_rate_id?: string | null /** * The available shipping rates. - * @example ```"[object Object]"``` + * @example ```[{"id":"rate_f89e4663c3ed47ee94d37763f6d21d54","rate":"45.59","carrier":"DHLExpress","service":"MedicalExpress"}]``` */ rates?: Array> | null /** @@ -95,7 +95,7 @@ interface Shipment extends Resource { purchase_error_message?: string | null /** * Any errors collected when fetching shipping rates. - * @example ```"[object Object]"``` + * @example ```[{"carrier":"DHLExpress","message":"to_address.postal_code: Shorter than minimum length 3","type":"rate_error"}]``` */ get_rates_errors?: Array> | null /** @@ -192,62 +192,62 @@ interface ShipmentUpdate extends ResourceUpdate { number?: string | null /** * Send this attribute if you want to mark this shipment as upcoming. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _upcoming?: boolean | null /** * Send this attribute if you want to mark this shipment as cancelled (unless already shipped or delivered). Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _cancel?: boolean | null /** * Send this attribute if you want to put this shipment on hold. - * @example ```"true"``` + * @example ```true``` */ _on_hold?: boolean | null /** * Send this attribute if you want to start picking this shipment. - * @example ```"true"``` + * @example ```true``` */ _picking?: boolean | null /** * Send this attribute if you want to start packing this shipment. - * @example ```"true"``` + * @example ```true``` */ _packing?: boolean | null /** * Send this attribute if you want to mark this shipment as ready to ship. - * @example ```"true"``` + * @example ```true``` */ _ready_to_ship?: boolean | null /** * Send this attribute if you want to mark this shipment as shipped. - * @example ```"true"``` + * @example ```true``` */ _ship?: boolean | null /** * Send this attribute if you want to mark this shipment as delivered. - * @example ```"true"``` + * @example ```true``` */ _deliver?: boolean | null /** * Send this attribute if you want to automatically reserve the stock for each of the associated stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _reserve_stock?: boolean | null /** * Send this attribute if you want to automatically destroy the stock reservations for each of the associated stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _release_stock?: boolean | null /** * Send this attribute if you want to automatically decrement and release the stock for each of the associated stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _decrement_stock?: boolean | null /** * Send this attribute if you want get the shipping rates from the associated carrier accounts. - * @example ```"true"``` + * @example ```true``` */ _get_rates?: boolean | null /** @@ -257,7 +257,7 @@ interface ShipmentUpdate extends ResourceUpdate { selected_rate_id?: string | null /** * Send this attribute if you want to purchase this shipment with the selected rate. - * @example ```"true"``` + * @example ```true``` */ _purchase?: boolean | null diff --git a/src/resources/shipping_method_tiers.ts b/src/resources/shipping_method_tiers.ts index d52b7b7e..1a03ad37 100644 --- a/src/resources/shipping_method_tiers.ts +++ b/src/resources/shipping_method_tiers.ts @@ -26,17 +26,17 @@ interface ShippingMethodTier extends Resource { name: string /** * The tier upper limit. When 'null' it means infinity (useful to have an always matching tier). - * @example ```"20.5"``` + * @example ```20.5``` */ up_to?: number | null /** * The price of this shipping method tier, in cents. - * @example ```"1000"``` + * @example ```1000``` */ price_amount_cents: number /** * The price of this shipping method tier, float. - * @example ```"10"``` + * @example ```10``` */ price_amount_float?: number | null /** diff --git a/src/resources/shipping_methods.ts b/src/resources/shipping_methods.ts index 3125db1e..dfb2a21a 100644 --- a/src/resources/shipping_methods.ts +++ b/src/resources/shipping_methods.ts @@ -53,12 +53,12 @@ interface ShippingMethod extends Resource { external_prices_url?: string | null /** * The price of this shipping method, in cents. - * @example ```"1000"``` + * @example ```1000``` */ price_amount_cents: number /** * The price of this shipping method, float. - * @example ```"10"``` + * @example ```10``` */ price_amount_float?: number | null /** @@ -68,12 +68,12 @@ interface ShippingMethod extends Resource { formatted_price_amount?: string | null /** * Apply free shipping if the order amount is over this value, in cents. - * @example ```"9900"``` + * @example ```9900``` */ free_over_amount_cents?: number | null /** * Apply free shipping if the order amount is over this value, float. - * @example ```"99"``` + * @example ```99``` */ free_over_amount_float?: number | null /** @@ -83,7 +83,7 @@ interface ShippingMethod extends Resource { formatted_free_over_amount?: string | null /** * Send this attribute if you want to compare the free over amount with order's subtotal (excluding discounts, if any). - * @example ```"true"``` + * @example ```true``` */ use_subtotal?: boolean | null /** @@ -101,12 +101,12 @@ interface ShippingMethod extends Resource { formatted_price_amount_for_shipment?: string | null /** * The minimum weight for which this shipping method is available. - * @example ```"3"``` + * @example ```3``` */ min_weight?: number | null /** * The maximum weight for which this shipping method is available. - * @example ```"300"``` + * @example ```300``` */ max_weight?: number | null /** @@ -126,7 +126,7 @@ interface ShippingMethod extends Resource { circuit_state?: string | null /** * The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback. - * @example ```"5"``` + * @example ```5``` */ circuit_failure_count?: number | null @@ -168,27 +168,27 @@ interface ShippingMethodCreate extends ResourceCreate { external_prices_url?: string | null /** * The price of this shipping method, in cents. - * @example ```"1000"``` + * @example ```1000``` */ price_amount_cents: number /** * Apply free shipping if the order amount is over this value, in cents. - * @example ```"9900"``` + * @example ```9900``` */ free_over_amount_cents?: number | null /** * Send this attribute if you want to compare the free over amount with order's subtotal (excluding discounts, if any). - * @example ```"true"``` + * @example ```true``` */ use_subtotal?: boolean | null /** * The minimum weight for which this shipping method is available. - * @example ```"3"``` + * @example ```3``` */ min_weight?: number | null /** * The maximum weight for which this shipping method is available. - * @example ```"300"``` + * @example ```300``` */ max_weight?: number | null /** @@ -198,12 +198,12 @@ interface ShippingMethodCreate extends ResourceCreate { unit_of_weight?: 'gr' | 'oz' | 'lb' | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null @@ -240,27 +240,27 @@ interface ShippingMethodUpdate extends ResourceUpdate { external_prices_url?: string | null /** * The price of this shipping method, in cents. - * @example ```"1000"``` + * @example ```1000``` */ price_amount_cents?: number | null /** * Apply free shipping if the order amount is over this value, in cents. - * @example ```"9900"``` + * @example ```9900``` */ free_over_amount_cents?: number | null /** * Send this attribute if you want to compare the free over amount with order's subtotal (excluding discounts, if any). - * @example ```"true"``` + * @example ```true``` */ use_subtotal?: boolean | null /** * The minimum weight for which this shipping method is available. - * @example ```"3"``` + * @example ```3``` */ min_weight?: number | null /** * The maximum weight for which this shipping method is available. - * @example ```"300"``` + * @example ```300``` */ max_weight?: number | null /** @@ -270,17 +270,17 @@ interface ShippingMethodUpdate extends ResourceUpdate { unit_of_weight?: 'gr' | 'oz' | 'lb' | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null /** * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _reset_circuit?: boolean | null diff --git a/src/resources/shipping_weight_tiers.ts b/src/resources/shipping_weight_tiers.ts index 0112831e..4baaf0c0 100644 --- a/src/resources/shipping_weight_tiers.ts +++ b/src/resources/shipping_weight_tiers.ts @@ -27,17 +27,17 @@ interface ShippingWeightTier extends Resource { name: string /** * The tier upper limit. When 'null' it means infinity (useful to have an always matching tier). - * @example ```"20.5"``` + * @example ```20.5``` */ up_to?: number | null /** * The price of this shipping method tier, in cents. - * @example ```"1000"``` + * @example ```1000``` */ price_amount_cents: number /** * The price of this shipping method tier, float. - * @example ```"10"``` + * @example ```10``` */ price_amount_float?: number | null /** @@ -62,12 +62,12 @@ interface ShippingWeightTierCreate extends ResourceCreate { name: string /** * The tier upper limit. When 'null' it means infinity (useful to have an always matching tier). - * @example ```"20.5"``` + * @example ```20.5``` */ up_to?: number | null /** * The price of this shipping method tier, in cents. - * @example ```"1000"``` + * @example ```1000``` */ price_amount_cents: number @@ -85,12 +85,12 @@ interface ShippingWeightTierUpdate extends ResourceUpdate { name?: string | null /** * The tier upper limit. When 'null' it means infinity (useful to have an always matching tier). - * @example ```"20.5"``` + * @example ```20.5``` */ up_to?: number | null /** * The price of this shipping method tier, in cents. - * @example ```"1000"``` + * @example ```1000``` */ price_amount_cents?: number | null diff --git a/src/resources/sku_list_items.ts b/src/resources/sku_list_items.ts index bd6cb052..020d4cf6 100644 --- a/src/resources/sku_list_items.ts +++ b/src/resources/sku_list_items.ts @@ -23,7 +23,7 @@ interface SkuListItem extends Resource { /** * The SKU list item's position. - * @example ```"2"``` + * @example ```2``` */ position?: number | null /** @@ -33,7 +33,7 @@ interface SkuListItem extends Resource { sku_code?: string | null /** * The SKU quantity for this SKU list item. - * @example ```"1"``` + * @example ```1``` */ quantity?: number | null @@ -48,7 +48,7 @@ interface SkuListItemCreate extends ResourceCreate { /** * The SKU list item's position. - * @example ```"2"``` + * @example ```2``` */ position?: number | null /** @@ -58,7 +58,7 @@ interface SkuListItemCreate extends ResourceCreate { sku_code?: string | null /** * The SKU quantity for this SKU list item. - * @example ```"1"``` + * @example ```1``` */ quantity?: number | null @@ -72,7 +72,7 @@ interface SkuListItemUpdate extends ResourceUpdate { /** * The SKU list item's position. - * @example ```"2"``` + * @example ```2``` */ position?: number | null /** @@ -82,7 +82,7 @@ interface SkuListItemUpdate extends ResourceUpdate { sku_code?: string | null /** * The SKU quantity for this SKU list item. - * @example ```"1"``` + * @example ```1``` */ quantity?: number | null diff --git a/src/resources/sku_list_promotion_rules.ts b/src/resources/sku_list_promotion_rules.ts index 07baf951..15ea9c65 100644 --- a/src/resources/sku_list_promotion_rules.ts +++ b/src/resources/sku_list_promotion_rules.ts @@ -38,12 +38,12 @@ interface SkuListPromotionRule extends Resource { /** * Indicates if the rule is activated only when all of the SKUs of the list is also part of the order. - * @example ```"true"``` + * @example ```true``` */ all_skus?: boolean | null /** * The min quantity of SKUs of the list that must be also part of the order. If positive, overwrites the 'all_skus' option. When the SKU list is manual, its items quantities are honoured. - * @example ```"3"``` + * @example ```3``` */ min_quantity?: number | null @@ -59,12 +59,12 @@ interface SkuListPromotionRuleCreate extends ResourceCreate { /** * Indicates if the rule is activated only when all of the SKUs of the list is also part of the order. - * @example ```"true"``` + * @example ```true``` */ all_skus?: boolean | null /** * The min quantity of SKUs of the list that must be also part of the order. If positive, overwrites the 'all_skus' option. When the SKU list is manual, its items quantities are honoured. - * @example ```"3"``` + * @example ```3``` */ min_quantity?: number | null @@ -78,12 +78,12 @@ interface SkuListPromotionRuleUpdate extends ResourceUpdate { /** * Indicates if the rule is activated only when all of the SKUs of the list is also part of the order. - * @example ```"true"``` + * @example ```true``` */ all_skus?: boolean | null /** * The min quantity of SKUs of the list that must be also part of the order. If positive, overwrites the 'all_skus' option. When the SKU list is manual, its items quantities are honoured. - * @example ```"3"``` + * @example ```3``` */ min_quantity?: number | null diff --git a/src/resources/sku_options.ts b/src/resources/sku_options.ts index 0018c8ea..cf1f4e59 100644 --- a/src/resources/sku_options.ts +++ b/src/resources/sku_options.ts @@ -40,12 +40,12 @@ interface SkuOption extends Resource { description?: string | null /** * The price of this shipping method, in cents. - * @example ```"1000"``` + * @example ```1000``` */ price_amount_cents?: number | null /** * The price of this shipping method, float. - * @example ```"10"``` + * @example ```10``` */ price_amount_float?: number | null /** @@ -55,12 +55,12 @@ interface SkuOption extends Resource { formatted_price_amount?: string | null /** * The delay time (in hours) that should be added to the delivery lead time when this option is purchased. - * @example ```"48"``` + * @example ```48``` */ delay_hours?: number | null /** * The delay time, in days (rounded). - * @example ```"2"``` + * @example ```2``` */ delay_days?: number | null /** @@ -97,12 +97,12 @@ interface SkuOptionCreate extends ResourceCreate { description?: string | null /** * The price of this shipping method, in cents. - * @example ```"1000"``` + * @example ```1000``` */ price_amount_cents?: number | null /** * The delay time (in hours) that should be added to the delivery lead time when this option is purchased. - * @example ```"48"``` + * @example ```48``` */ delay_hours?: number | null /** @@ -136,12 +136,12 @@ interface SkuOptionUpdate extends ResourceUpdate { description?: string | null /** * The price of this shipping method, in cents. - * @example ```"1000"``` + * @example ```1000``` */ price_amount_cents?: number | null /** * The delay time (in hours) that should be added to the delivery lead time when this option is purchased. - * @example ```"48"``` + * @example ```48``` */ delay_hours?: number | null /** diff --git a/src/resources/skus.ts b/src/resources/skus.ts index db5548c2..0e2c2f0c 100644 --- a/src/resources/skus.ts +++ b/src/resources/skus.ts @@ -56,12 +56,12 @@ interface Sku extends Resource { image_url?: string | null /** * The number of pieces that compose the SKU. This is useful to describe sets and bundles. - * @example ```"6"``` + * @example ```6``` */ pieces_per_pack?: number | null /** * The weight of the SKU. If present, it will be used to calculate the shipping rates. - * @example ```"300"``` + * @example ```300``` */ weight?: number | null /** @@ -84,12 +84,12 @@ interface Sku extends Resource { do_not_track?: boolean | null /** * Aggregated information about the SKU's inventory. Returned only when retrieving a single SKU. - * @example ```"[object Object]"``` + * @example ```{"available":true,"quantity":10,"levels":[{"quantity":4,"delivery_lead_times":[{"shipping_method":{"name":"Standard Shipping","reference":null,"price_amount_cents":700,"free_over_amount_cents":9900,"formatted_price_amount":"€7,00","formatted_free_over_amount":"€99,00"},"min":{"hours":72,"days":3},"max":{"hours":120,"days":5}},{"shipping_method":{"name":"Express Delivery","reference":null,"price_amount_cents":1200,"free_over_amount_cents":null,"formatted_price_amount":"€12,00","formatted_free_over_amount":null},"min":{"hours":48,"days":2},"max":{"hours":72,"days":3}}]},{"quantity":6,"delivery_lead_times":[{"shipping_method":{"name":"Standard Shipping","reference":null,"price_amount_cents":700,"free_over_amount_cents":9900,"formatted_price_amount":"€7,00","formatted_free_over_amount":"€99,00"},"min":{"hours":96,"days":4},"max":{"hours":144,"days":6}},{"shipping_method":{"name":"Express Delivery","reference":null,"price_amount_cents":1200,"free_over_amount_cents":null,"formatted_price_amount":"€12,00","formatted_free_over_amount":null},"min":{"hours":72,"days":3},"max":{"hours":96,"days":4}}]}]}``` */ inventory?: Record | null /** * The custom_claim attached to the current JWT (if any). - * @example ```"[object Object]"``` + * @example ```{}``` */ jwt_custom_claim?: Record | null @@ -137,12 +137,12 @@ interface SkuCreate extends ResourceCreate { image_url?: string | null /** * The number of pieces that compose the SKU. This is useful to describe sets and bundles. - * @example ```"6"``` + * @example ```6``` */ pieces_per_pack?: number | null /** * The weight of the SKU. If present, it will be used to calculate the shipping rates. - * @example ```"300"``` + * @example ```300``` */ weight?: number | null /** @@ -194,12 +194,12 @@ interface SkuUpdate extends ResourceUpdate { image_url?: string | null /** * The number of pieces that compose the SKU. This is useful to describe sets and bundles. - * @example ```"6"``` + * @example ```6``` */ pieces_per_pack?: number | null /** * The weight of the SKU. If present, it will be used to calculate the shipping rates. - * @example ```"300"``` + * @example ```300``` */ weight?: number | null /** diff --git a/src/resources/stock_items.ts b/src/resources/stock_items.ts index 660b7390..a5c7907b 100644 --- a/src/resources/stock_items.ts +++ b/src/resources/stock_items.ts @@ -31,7 +31,7 @@ interface StockItem extends Resource { sku_code?: string | null /** * The stock item quantity. - * @example ```"100"``` + * @example ```100``` */ quantity: number @@ -54,7 +54,7 @@ interface StockItemCreate extends ResourceCreate { sku_code?: string | null /** * The stock item quantity. - * @example ```"100"``` + * @example ```100``` */ quantity: number @@ -73,12 +73,12 @@ interface StockItemUpdate extends ResourceUpdate { sku_code?: string | null /** * The stock item quantity. - * @example ```"100"``` + * @example ```100``` */ quantity?: number | null /** * Send this attribute if you want to validate the stock item quantity against the existing reserved stock one, returns an error in case the former is smaller. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _validate?: boolean | null diff --git a/src/resources/stock_line_items.ts b/src/resources/stock_line_items.ts index 804e4986..62a59988 100644 --- a/src/resources/stock_line_items.ts +++ b/src/resources/stock_line_items.ts @@ -38,7 +38,7 @@ interface StockLineItem extends Resource { bundle_code?: string | null /** * The line item quantity. - * @example ```"4"``` + * @example ```4``` */ quantity: number @@ -61,7 +61,7 @@ interface StockLineItemCreate extends ResourceCreate { sku_code?: string | null /** * The line item quantity. - * @example ```"4"``` + * @example ```4``` */ quantity: number @@ -82,22 +82,22 @@ interface StockLineItemUpdate extends ResourceUpdate { sku_code?: string | null /** * The line item quantity. - * @example ```"4"``` + * @example ```4``` */ quantity?: number | null /** * Send this attribute if you want to automatically reserve the stock for this stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _reserve_stock?: boolean | null /** * Send this attribute if you want to automatically destroy the stock reservation for this stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _release_stock?: boolean | null /** * Send this attribute if you want to automatically decrement and release the stock this stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _decrement_stock?: boolean | null diff --git a/src/resources/stock_locations.ts b/src/resources/stock_locations.ts index 02be6603..d6cd3ab9 100644 --- a/src/resources/stock_locations.ts +++ b/src/resources/stock_locations.ts @@ -27,7 +27,7 @@ interface StockLocation extends Resource { /** * Unique identifier for the stock location (numeric). - * @example ```"1234"``` + * @example ```1234``` */ number?: number | null /** diff --git a/src/resources/stock_reservations.ts b/src/resources/stock_reservations.ts index dc36ea1d..ec905942 100644 --- a/src/resources/stock_reservations.ts +++ b/src/resources/stock_reservations.ts @@ -31,7 +31,7 @@ interface StockReservation extends Resource { status: 'draft' | 'pending' /** * The stock reservation quantity. - * @example ```"4"``` + * @example ```4``` */ quantity: number /** @@ -55,7 +55,7 @@ interface StockReservationCreate extends ResourceCreate { /** * The stock reservation quantity. - * @example ```"4"``` + * @example ```4``` */ quantity: number @@ -68,12 +68,12 @@ interface StockReservationUpdate extends ResourceUpdate { /** * The stock reservation quantity. - * @example ```"4"``` + * @example ```4``` */ quantity?: number | null /** * Send this attribute if you want to mark this stock reservation as pending. - * @example ```"true"``` + * @example ```true``` */ _pending?: boolean | null diff --git a/src/resources/stock_transfers.ts b/src/resources/stock_transfers.ts index 38670473..ac32a9b3 100644 --- a/src/resources/stock_transfers.ts +++ b/src/resources/stock_transfers.ts @@ -45,7 +45,7 @@ interface StockTransfer extends Resource { status: 'draft' | 'upcoming' | 'on_hold' | 'picking' | 'in_transit' | 'completed' | 'cancelled' /** * The stock quantity to be transferred from the origin stock location to destination one. Updatable unless stock transfer is completed or cancelled and depending on origin stock availability. - * @example ```"2"``` + * @example ```2``` */ quantity: number /** @@ -101,7 +101,7 @@ interface StockTransferCreate extends ResourceCreate { sku_code?: string | null /** * The stock quantity to be transferred from the origin stock location to destination one. Updatable unless stock transfer is completed or cancelled and depending on origin stock availability. - * @example ```"2"``` + * @example ```2``` */ quantity: number @@ -128,37 +128,37 @@ interface StockTransferUpdate extends ResourceUpdate { sku_code?: string | null /** * The stock quantity to be transferred from the origin stock location to destination one. Updatable unless stock transfer is completed or cancelled and depending on origin stock availability. - * @example ```"2"``` + * @example ```2``` */ quantity?: number | null /** * Send this attribute if you want to mark this stock transfer as upcoming. - * @example ```"true"``` + * @example ```true``` */ _upcoming?: boolean | null /** * Send this attribute if you want to put this stock transfer on hold. - * @example ```"true"``` + * @example ```true``` */ _on_hold?: boolean | null /** * Send this attribute if you want to start picking this stock transfer. - * @example ```"true"``` + * @example ```true``` */ _picking?: boolean | null /** * Send this attribute if you want to mark this stock transfer as in transit. - * @example ```"true"``` + * @example ```true``` */ _in_transit?: boolean | null /** * Send this attribute if you want to complete this stock transfer. - * @example ```"true"``` + * @example ```true``` */ _complete?: boolean | null /** * Send this attribute if you want to cancel this stock transfer. - * @example ```"true"``` + * @example ```true``` */ _cancel?: boolean | null diff --git a/src/resources/stripe_gateways.ts b/src/resources/stripe_gateways.ts index a81076e3..f3a9d426 100644 --- a/src/resources/stripe_gateways.ts +++ b/src/resources/stripe_gateways.ts @@ -31,7 +31,7 @@ interface StripeGateway extends Resource { connected_account?: string | null /** * Indicates if the gateway will accept payment methods enabled in the Stripe dashboard. - * @example ```"true"``` + * @example ```true``` */ auto_payments?: boolean | null /** @@ -81,7 +81,7 @@ interface StripeGatewayCreate extends ResourceCreate { connected_account?: string | null /** * Indicates if the gateway will accept payment methods enabled in the Stripe dashboard. - * @example ```"true"``` + * @example ```true``` */ auto_payments?: boolean | null @@ -102,7 +102,7 @@ interface StripeGatewayUpdate extends ResourceUpdate { connected_account?: string | null /** * Indicates if the gateway will accept payment methods enabled in the Stripe dashboard. - * @example ```"true"``` + * @example ```true``` */ auto_payments?: boolean | null diff --git a/src/resources/stripe_payments.ts b/src/resources/stripe_payments.ts index 683aacea..8b8edef6 100644 --- a/src/resources/stripe_payments.ts +++ b/src/resources/stripe_payments.ts @@ -42,12 +42,12 @@ interface StripePayment extends Resource { publishable_key?: string | null /** * Stripe payment options: 'customer', 'payment_method', 'return_url', etc. Check Stripe payment intent API for more details. - * @example ```"[object Object]"``` + * @example ```{"customer":"cus_xxx","payment_method":"pm_xxx"}``` */ options?: Record | null /** * Stripe 'payment_method', set by webhook. - * @example ```"[object Object]"``` + * @example ```{"id":"pm_xxx"}``` */ payment_method?: Record | null /** @@ -66,7 +66,7 @@ interface StripePayment extends Resource { receipt_email?: string | null /** * Information about the payment instrument used in the transaction. - * @example ```"[object Object]"``` + * @example ```{"issuer":"cl bank","card_type":"visa"}``` */ payment_instrument?: Record | null @@ -91,7 +91,7 @@ interface StripePaymentCreate extends ResourceCreate { client_secret?: string | null /** * Stripe payment options: 'customer', 'payment_method', 'return_url', etc. Check Stripe payment intent API for more details. - * @example ```"[object Object]"``` + * @example ```{"customer":"cus_xxx","payment_method":"pm_xxx"}``` */ options?: Record | null /** @@ -114,7 +114,7 @@ interface StripePaymentUpdate extends ResourceUpdate { /** * Stripe payment options: 'customer', 'payment_method', 'return_url', etc. Check Stripe payment intent API for more details. - * @example ```"[object Object]"``` + * @example ```{"customer":"cus_xxx","payment_method":"pm_xxx"}``` */ options?: Record | null /** @@ -124,12 +124,12 @@ interface StripePaymentUpdate extends ResourceUpdate { return_url?: string | null /** * Send this attribute if you want to update the created payment intent with fresh order data. - * @example ```"true"``` + * @example ```true``` */ _update?: boolean | null /** * Send this attribute if you want to refresh the payment status, can be used as webhooks fallback logic. - * @example ```"true"``` + * @example ```true``` */ _refresh?: boolean | null diff --git a/src/resources/subscription_models.ts b/src/resources/subscription_models.ts index f1a9c500..3211bdc4 100644 --- a/src/resources/subscription_models.ts +++ b/src/resources/subscription_models.ts @@ -31,12 +31,12 @@ interface SubscriptionModel extends Resource { strategy?: string | null /** * An object that contains the frequencies available for this subscription model. Supported ones are 'hourly', 'daily', 'weekly', 'monthly', 'two-month', 'three-month', 'four-month', 'six-month', 'yearly', or your custom crontab expression (min unit is hour). - * @example ```"hourly,10 * * * *,weekly,monthly,two-month"``` + * @example ```["hourly","10 * * * *","weekly","monthly","two-month"]``` */ frequencies: string[] /** * Indicates if the created subscriptions will be activated considering the placed source order as its first run, default to true. - * @example ```"true"``` + * @example ```true``` */ auto_activate?: boolean | null /** @@ -65,12 +65,12 @@ interface SubscriptionModelCreate extends ResourceCreate { strategy?: string | null /** * An object that contains the frequencies available for this subscription model. Supported ones are 'hourly', 'daily', 'weekly', 'monthly', 'two-month', 'three-month', 'four-month', 'six-month', 'yearly', or your custom crontab expression (min unit is hour). - * @example ```"hourly,10 * * * *,weekly,monthly,two-month"``` + * @example ```["hourly","10 * * * *","weekly","monthly","two-month"]``` */ frequencies: string[] /** * Indicates if the created subscriptions will be activated considering the placed source order as its first run, default to true. - * @example ```"true"``` + * @example ```true``` */ auto_activate?: boolean | null /** @@ -95,12 +95,12 @@ interface SubscriptionModelUpdate extends ResourceUpdate { strategy?: string | null /** * An object that contains the frequencies available for this subscription model. Supported ones are 'hourly', 'daily', 'weekly', 'monthly', 'two-month', 'three-month', 'four-month', 'six-month', 'yearly', or your custom crontab expression (min unit is hour). - * @example ```"hourly,10 * * * *,weekly,monthly,two-month"``` + * @example ```["hourly","10 * * * *","weekly","monthly","two-month"]``` */ frequencies?: string[] | null /** * Indicates if the created subscriptions will be activated considering the placed source order as its first run, default to true. - * @example ```"true"``` + * @example ```true``` */ auto_activate?: boolean | null /** diff --git a/src/resources/tax_rules.ts b/src/resources/tax_rules.ts index 9b3cd5df..dc99cc1a 100644 --- a/src/resources/tax_rules.ts +++ b/src/resources/tax_rules.ts @@ -26,7 +26,7 @@ interface TaxRule extends Resource { name: string /** * The tax rate for this rule. - * @example ```"0.22"``` + * @example ```0.22``` */ tax_rate?: number | null /** @@ -47,7 +47,7 @@ interface TaxRule extends Resource { adjustment_taxable?: boolean | null /** * The breakdown for this tax rule (if calculated). - * @example ```"[object Object]"``` + * @example ```{"41":{"tax_rate":0.22}}``` */ breakdown?: Record | null /** @@ -96,7 +96,7 @@ interface TaxRuleCreate extends ResourceCreate { name: string /** * The tax rate for this rule. - * @example ```"0.22"``` + * @example ```0.22``` */ tax_rate?: number | null /** @@ -160,7 +160,7 @@ interface TaxRuleUpdate extends ResourceUpdate { name?: string | null /** * The tax rate for this rule. - * @example ```"0.22"``` + * @example ```0.22``` */ tax_rate?: number | null /** diff --git a/src/resources/transactions.ts b/src/resources/transactions.ts index 2ec51c73..503e0a56 100644 --- a/src/resources/transactions.ts +++ b/src/resources/transactions.ts @@ -42,12 +42,12 @@ interface Transaction extends Resource { currency_code: string /** * The transaction amount, in cents. - * @example ```"1500"``` + * @example ```1500``` */ amount_cents: number /** * The transaction amount, float. - * @example ```"15"``` + * @example ```15``` */ amount_float: number /** diff --git a/src/resources/versions.ts b/src/resources/versions.ts index 8d8085bc..6263a37a 100644 --- a/src/resources/versions.ts +++ b/src/resources/versions.ts @@ -33,12 +33,12 @@ interface Version extends Resource { event?: string | null /** * The object changes payload. - * @example ```"[object Object]"``` + * @example ```{"status":["draft","placed"]}``` */ changes?: Record | null /** * Information about who triggered the change. - * @example ```"[object Object]"``` + * @example ```{"application":{"id":"DNOPYiZYpn","kind":"sales_channel","public":true},"owner":{"id":"yQQrBhLBmQ","type":"Customer"}}``` */ who?: Record | null diff --git a/src/resources/voids.ts b/src/resources/voids.ts index 59670cf8..6ab0b28e 100644 --- a/src/resources/voids.ts +++ b/src/resources/voids.ts @@ -43,12 +43,12 @@ interface Void extends Resource { currency_code: string /** * The transaction amount, in cents. - * @example ```"1500"``` + * @example ```1500``` */ amount_cents: number /** * The transaction amount, float. - * @example ```"15"``` + * @example ```15``` */ amount_float: number /** @@ -104,7 +104,7 @@ interface VoidUpdate extends ResourceUpdate { succeeded?: boolean | null /** * Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly. - * @example ```"true"``` + * @example ```true``` */ _forward?: boolean | null diff --git a/src/resources/webhooks.ts b/src/resources/webhooks.ts index e19b98ef..ccd76abd 100644 --- a/src/resources/webhooks.ts +++ b/src/resources/webhooks.ts @@ -35,7 +35,7 @@ interface Webhook extends Resource { callback_url: string /** * List of related resources that should be included in the webhook body. - * @example ```"customer,shipping_address,billing_address"``` + * @example ```["customer","shipping_address","billing_address"]``` */ include_resources?: string[] | null /** @@ -50,7 +50,7 @@ interface Webhook extends Resource { circuit_state?: string | null /** * The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback. - * @example ```"5"``` + * @example ```5``` */ circuit_failure_count?: number | null /** @@ -84,17 +84,17 @@ interface WebhookCreate extends ResourceCreate { callback_url: string /** * List of related resources that should be included in the webhook body. - * @example ```"customer,shipping_address,billing_address"``` + * @example ```["customer","shipping_address","billing_address"]``` */ include_resources?: string[] | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null @@ -120,22 +120,22 @@ interface WebhookUpdate extends ResourceUpdate { callback_url?: string | null /** * List of related resources that should be included in the webhook body. - * @example ```"customer,shipping_address,billing_address"``` + * @example ```["customer","shipping_address","billing_address"]``` */ include_resources?: string[] | null /** * Send this attribute if you want to mark this resource as disabled. - * @example ```"true"``` + * @example ```true``` */ _disable?: boolean | null /** * Send this attribute if you want to mark this resource as enabled. - * @example ```"true"``` + * @example ```true``` */ _enable?: boolean | null /** * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels. - * @example ```"true"``` + * @example ```true``` */ _reset_circuit?: boolean | null diff --git a/src/resources/wire_transfers.ts b/src/resources/wire_transfers.ts index 30499a39..373a374a 100644 --- a/src/resources/wire_transfers.ts +++ b/src/resources/wire_transfers.ts @@ -21,7 +21,7 @@ interface WireTransfer extends Resource { /** * Information about the payment instrument used in the transaction. - * @example ```"[object Object]"``` + * @example ```{"issuer":"cl bank","card_type":"visa"}``` */ payment_instrument?: Record | null