@flexprice/sdk 2.1.44-dev.7 → 2.1.45-dev.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FUNCTIONS.md +3 -3
- package/USAGE.md +1 -1
- package/docs/sdk/models/accounting-period-response.md +21 -0
- package/docs/sdk/models/accounting-period-status.md +17 -0
- package/docs/sdk/models/accountingperiod-filter-order.md +15 -0
- package/docs/sdk/models/accountingperiod-filter.md +25 -0
- package/docs/sdk/models/amortization-method.md +17 -0
- package/docs/sdk/models/contract-association-response.md +18 -0
- package/docs/sdk/models/contract-filter-order.md +15 -0
- package/docs/sdk/models/contract-filter.md +28 -0
- package/docs/sdk/models/contract-response.md +25 -0
- package/docs/sdk/models/contract-status.md +17 -0
- package/docs/sdk/models/create-price-request.md +1 -0
- package/docs/sdk/models/create-product-request.md +20 -0
- package/docs/sdk/models/delete-product-request.md +17 -0
- package/docs/sdk/models/get-contract-request.md +17 -0
- package/docs/sdk/models/get-journal-entry-request.md +17 -0
- package/docs/sdk/models/get-performance-obligation-request.md +17 -0
- package/docs/sdk/models/get-product-request.md +17 -0
- package/docs/sdk/models/invoice-filter.md +1 -0
- package/docs/sdk/models/journal-direction.md +17 -0
- package/docs/sdk/models/journal-entry-response.md +26 -0
- package/docs/sdk/models/journal-event-type.md +17 -0
- package/docs/sdk/models/journal-filter-order.md +15 -0
- package/docs/sdk/models/journal-filter.md +32 -0
- package/docs/sdk/models/journal-line-response.md +19 -0
- package/docs/sdk/models/ledger-account-key.md +17 -0
- package/docs/sdk/models/list-accounting-periods-response.md +16 -0
- package/docs/sdk/models/list-contracts-response.md +16 -0
- package/docs/sdk/models/list-journal-entries-response.md +16 -0
- package/docs/sdk/models/list-payments-request.md +2 -1
- package/docs/sdk/models/list-performance-obligations-response.md +16 -0
- package/docs/sdk/models/list-products-order.md +15 -0
- package/docs/sdk/models/list-products-request.md +23 -0
- package/docs/sdk/models/list-products-response.md +16 -0
- package/docs/sdk/models/list-products-status.md +15 -0
- package/docs/sdk/models/performance-obligation-association-response.md +18 -0
- package/docs/sdk/models/performance-obligation-response.md +26 -0
- package/docs/sdk/models/performance-obligation-status.md +17 -0
- package/docs/sdk/models/pob-filter-order.md +15 -0
- package/docs/sdk/models/pob-filter.md +28 -0
- package/docs/sdk/models/price-filter.md +1 -0
- package/docs/sdk/models/price-price.md +1 -0
- package/docs/sdk/models/price-response.md +1 -0
- package/docs/sdk/models/product-filter-order.md +15 -0
- package/docs/sdk/models/product-filter.md +25 -0
- package/docs/sdk/models/product-response.md +21 -0
- package/docs/sdk/models/recognition-method.md +17 -0
- package/docs/sdk/models/rev-rec-entity-type.md +17 -0
- package/docs/sdk/models/revenue-breakdown.md +18 -0
- package/docs/sdk/models/revenue-report-group-by.md +15 -0
- package/docs/sdk/models/rollforward-request.md +28 -0
- package/docs/sdk/models/rollforward-response.md +17 -0
- package/docs/sdk/models/rollforward-row.md +22 -0
- package/docs/sdk/models/update-price-request.md +1 -0
- package/docs/sdk/models/update-product-request-request.md +19 -0
- package/docs/sdk/models/update-product-request.md +16 -0
- package/docs/sdk/models/waterfall-cell.md +18 -0
- package/docs/sdk/models/waterfall-request.md +29 -0
- package/docs/sdk/models/waterfall-response.md +17 -0
- package/docs/sdk/models/waterfall-row.md +18 -0
- package/docs/sdks/accountingperiods/README.md +78 -0
- package/docs/sdks/contracts/README.md +150 -0
- package/docs/sdks/journalentries/README.md +150 -0
- package/docs/sdks/performanceobligations/README.md +150 -0
- package/docs/sdks/products/README.md +445 -0
- package/docs/sdks/revenuereports/README.md +164 -0
- package/esm/funcs/accounting-periods-query-accounting-period.d.ts +17 -0
- package/esm/funcs/accounting-periods-query-accounting-period.d.ts.map +1 -0
- package/esm/funcs/accounting-periods-query-accounting-period.js +83 -0
- package/esm/funcs/accounting-periods-query-accounting-period.js.map +1 -0
- package/esm/funcs/contracts-get-contract.d.ts +17 -0
- package/esm/funcs/contracts-get-contract.d.ts.map +1 -0
- package/esm/funcs/contracts-get-contract.js +91 -0
- package/esm/funcs/contracts-get-contract.js.map +1 -0
- package/esm/funcs/contracts-query-contract.d.ts +17 -0
- package/esm/funcs/contracts-query-contract.d.ts.map +1 -0
- package/esm/funcs/contracts-query-contract.js +83 -0
- package/esm/funcs/contracts-query-contract.js.map +1 -0
- package/esm/funcs/journal-entries-get-journal-entry.d.ts +17 -0
- package/esm/funcs/journal-entries-get-journal-entry.d.ts.map +1 -0
- package/esm/funcs/journal-entries-get-journal-entry.js +91 -0
- package/esm/funcs/journal-entries-get-journal-entry.js.map +1 -0
- package/esm/funcs/journal-entries-query-journal-entry.d.ts +17 -0
- package/esm/funcs/journal-entries-query-journal-entry.d.ts.map +1 -0
- package/esm/funcs/journal-entries-query-journal-entry.js +83 -0
- package/esm/funcs/journal-entries-query-journal-entry.js.map +1 -0
- package/esm/funcs/payments-list-payments.js +1 -0
- package/esm/funcs/payments-list-payments.js.map +1 -1
- package/esm/funcs/performance-obligations-get-performance-obligation.d.ts +17 -0
- package/esm/funcs/performance-obligations-get-performance-obligation.d.ts.map +1 -0
- package/esm/funcs/performance-obligations-get-performance-obligation.js +91 -0
- package/esm/funcs/performance-obligations-get-performance-obligation.js.map +1 -0
- package/esm/funcs/performance-obligations-query-performance-obligation.d.ts +17 -0
- package/esm/funcs/performance-obligations-query-performance-obligation.d.ts.map +1 -0
- package/esm/funcs/performance-obligations-query-performance-obligation.js +83 -0
- package/esm/funcs/performance-obligations-query-performance-obligation.js.map +1 -0
- package/esm/funcs/products-create-product.d.ts +17 -0
- package/esm/funcs/products-create-product.d.ts.map +1 -0
- package/esm/funcs/products-create-product.js +83 -0
- package/esm/funcs/products-create-product.js.map +1 -0
- package/esm/funcs/products-delete-product.d.ts +17 -0
- package/esm/funcs/products-delete-product.d.ts.map +1 -0
- package/esm/funcs/products-delete-product.js +91 -0
- package/esm/funcs/products-delete-product.js.map +1 -0
- package/esm/funcs/products-get-product.d.ts +17 -0
- package/esm/funcs/products-get-product.d.ts.map +1 -0
- package/esm/funcs/products-get-product.js +91 -0
- package/esm/funcs/products-get-product.js.map +1 -0
- package/esm/funcs/products-list-products.d.ts +17 -0
- package/esm/funcs/products-list-products.d.ts.map +1 -0
- package/esm/funcs/products-list-products.js +95 -0
- package/esm/funcs/products-list-products.js.map +1 -0
- package/esm/funcs/products-query-product.d.ts +17 -0
- package/esm/funcs/products-query-product.d.ts.map +1 -0
- package/esm/funcs/products-query-product.js +83 -0
- package/esm/funcs/products-query-product.js.map +1 -0
- package/esm/funcs/products-update-product.d.ts +17 -0
- package/esm/funcs/products-update-product.d.ts.map +1 -0
- package/esm/funcs/products-update-product.js +93 -0
- package/esm/funcs/products-update-product.js.map +1 -0
- package/esm/funcs/revenue-reports-get-revenue-rollforward.d.ts +17 -0
- package/esm/funcs/revenue-reports-get-revenue-rollforward.d.ts.map +1 -0
- package/esm/funcs/revenue-reports-get-revenue-rollforward.js +83 -0
- package/esm/funcs/revenue-reports-get-revenue-rollforward.js.map +1 -0
- package/esm/funcs/revenue-reports-get-revenue-waterfall.d.ts +17 -0
- package/esm/funcs/revenue-reports-get-revenue-waterfall.d.ts.map +1 -0
- package/esm/funcs/revenue-reports-get-revenue-waterfall.js +83 -0
- package/esm/funcs/revenue-reports-get-revenue-waterfall.js.map +1 -0
- package/esm/lib/config.d.ts +2 -2
- package/esm/lib/config.d.ts.map +1 -1
- package/esm/lib/config.js +2 -2
- package/esm/lib/config.js.map +1 -1
- package/esm/sdk/accounting-periods.d.ts +12 -0
- package/esm/sdk/accounting-periods.d.ts.map +1 -0
- package/esm/sdk/accounting-periods.js +18 -0
- package/esm/sdk/accounting-periods.js.map +1 -0
- package/esm/sdk/contracts.d.ts +19 -0
- package/esm/sdk/contracts.d.ts.map +1 -0
- package/esm/sdk/contracts.js +28 -0
- package/esm/sdk/contracts.js.map +1 -0
- package/esm/sdk/journal-entries.d.ts +19 -0
- package/esm/sdk/journal-entries.d.ts.map +1 -0
- package/esm/sdk/journal-entries.js +28 -0
- package/esm/sdk/journal-entries.js.map +1 -0
- package/esm/sdk/models/accounting-period-response.d.ts +18 -0
- package/esm/sdk/models/accounting-period-response.d.ts.map +1 -0
- package/esm/sdk/models/accounting-period-response.js +31 -0
- package/esm/sdk/models/accounting-period-response.js.map +1 -0
- package/esm/sdk/models/accounting-period-status.d.ts +12 -0
- package/esm/sdk/models/accounting-period-status.d.ts.map +1 -0
- package/esm/sdk/models/accounting-period-status.js +13 -0
- package/esm/sdk/models/accounting-period-status.js.map +1 -0
- package/esm/sdk/models/accountingperiod-filter.d.ts +44 -0
- package/esm/sdk/models/accountingperiod-filter.d.ts.map +1 -0
- package/esm/sdk/models/accountingperiod-filter.js +40 -0
- package/esm/sdk/models/accountingperiod-filter.js.map +1 -0
- package/esm/sdk/models/amortization-method.d.ts +11 -0
- package/esm/sdk/models/amortization-method.d.ts.map +1 -0
- package/esm/sdk/models/amortization-method.js +12 -0
- package/esm/sdk/models/amortization-method.js.map +1 -0
- package/esm/sdk/models/contract-association-response.d.ts +14 -0
- package/esm/sdk/models/contract-association-response.d.ts.map +1 -0
- package/esm/sdk/models/contract-association-response.js +25 -0
- package/esm/sdk/models/contract-association-response.js.map +1 -0
- package/esm/sdk/models/contract-filter.d.ts +50 -0
- package/esm/sdk/models/contract-filter.d.ts.map +1 -0
- package/esm/sdk/models/contract-filter.js +46 -0
- package/esm/sdk/models/contract-filter.js.map +1 -0
- package/esm/sdk/models/contract-response.d.ts +23 -0
- package/esm/sdk/models/contract-response.d.ts.map +1 -0
- package/esm/sdk/models/contract-response.js +38 -0
- package/esm/sdk/models/contract-response.js.map +1 -0
- package/esm/sdk/models/contract-status.d.ts +14 -0
- package/esm/sdk/models/contract-status.d.ts.map +1 -0
- package/esm/sdk/models/contract-status.js +15 -0
- package/esm/sdk/models/contract-status.js.map +1 -0
- package/esm/sdk/models/create-price-request.d.ts +2 -0
- package/esm/sdk/models/create-price-request.d.ts.map +1 -1
- package/esm/sdk/models/create-price-request.js +2 -0
- package/esm/sdk/models/create-price-request.js.map +1 -1
- package/esm/sdk/models/create-product-request.d.ts +16 -0
- package/esm/sdk/models/create-product-request.d.ts.map +1 -0
- package/esm/sdk/models/create-product-request.js +19 -0
- package/esm/sdk/models/create-product-request.js.map +1 -0
- package/esm/sdk/models/delete-product-op.d.ts +15 -0
- package/esm/sdk/models/delete-product-op.d.ts.map +1 -0
- package/esm/sdk/models/delete-product-op.js +12 -0
- package/esm/sdk/models/delete-product-op.js.map +1 -0
- package/esm/sdk/models/get-contract-op.d.ts +15 -0
- package/esm/sdk/models/get-contract-op.d.ts.map +1 -0
- package/esm/sdk/models/get-contract-op.js +12 -0
- package/esm/sdk/models/get-contract-op.js.map +1 -0
- package/esm/sdk/models/get-journal-entry-op.d.ts +15 -0
- package/esm/sdk/models/get-journal-entry-op.d.ts.map +1 -0
- package/esm/sdk/models/get-journal-entry-op.js +12 -0
- package/esm/sdk/models/get-journal-entry-op.js.map +1 -0
- package/esm/sdk/models/get-performance-obligation-op.d.ts +15 -0
- package/esm/sdk/models/get-performance-obligation-op.d.ts.map +1 -0
- package/esm/sdk/models/get-performance-obligation-op.js +12 -0
- package/esm/sdk/models/get-performance-obligation-op.js.map +1 -0
- package/esm/sdk/models/get-product-op.d.ts +15 -0
- package/esm/sdk/models/get-product-op.d.ts.map +1 -0
- package/esm/sdk/models/get-product-op.js +12 -0
- package/esm/sdk/models/get-product-op.js.map +1 -0
- package/esm/sdk/models/index.d.ts +45 -0
- package/esm/sdk/models/index.d.ts.map +1 -1
- package/esm/sdk/models/index.js +45 -0
- package/esm/sdk/models/index.js.map +1 -1
- package/esm/sdk/models/invoice-filter.d.ts +5 -0
- package/esm/sdk/models/invoice-filter.d.ts.map +1 -1
- package/esm/sdk/models/invoice-filter.js +2 -0
- package/esm/sdk/models/invoice-filter.js.map +1 -1
- package/esm/sdk/models/journal-direction.d.ts +10 -0
- package/esm/sdk/models/journal-direction.d.ts.map +1 -0
- package/esm/sdk/models/journal-direction.js +11 -0
- package/esm/sdk/models/journal-direction.js.map +1 -0
- package/esm/sdk/models/journal-entry-response.d.ts +24 -0
- package/esm/sdk/models/journal-entry-response.d.ts.map +1 -0
- package/esm/sdk/models/journal-entry-response.js +41 -0
- package/esm/sdk/models/journal-entry-response.js.map +1 -0
- package/esm/sdk/models/journal-event-type.d.ts +19 -0
- package/esm/sdk/models/journal-event-type.d.ts.map +1 -0
- package/esm/sdk/models/journal-event-type.js +20 -0
- package/esm/sdk/models/journal-event-type.js.map +1 -0
- package/esm/sdk/models/journal-filter.d.ts +60 -0
- package/esm/sdk/models/journal-filter.d.ts.map +1 -0
- package/esm/sdk/models/journal-filter.js +55 -0
- package/esm/sdk/models/journal-filter.js.map +1 -0
- package/esm/sdk/models/journal-line-response.d.ts +16 -0
- package/esm/sdk/models/journal-line-response.d.ts.map +1 -0
- package/esm/sdk/models/journal-line-response.js +25 -0
- package/esm/sdk/models/journal-line-response.js.map +1 -0
- package/esm/sdk/models/ledger-account-key.d.ts +18 -0
- package/esm/sdk/models/ledger-account-key.d.ts.map +1 -0
- package/esm/sdk/models/ledger-account-key.js +19 -0
- package/esm/sdk/models/ledger-account-key.js.map +1 -0
- package/esm/sdk/models/list-accounting-periods-response.d.ts +13 -0
- package/esm/sdk/models/list-accounting-periods-response.d.ts.map +1 -0
- package/esm/sdk/models/list-accounting-periods-response.js +17 -0
- package/esm/sdk/models/list-accounting-periods-response.js.map +1 -0
- package/esm/sdk/models/list-contracts-response.d.ts +13 -0
- package/esm/sdk/models/list-contracts-response.d.ts.map +1 -0
- package/esm/sdk/models/list-contracts-response.js +17 -0
- package/esm/sdk/models/list-contracts-response.js.map +1 -0
- package/esm/sdk/models/list-journal-entries-response.d.ts +13 -0
- package/esm/sdk/models/list-journal-entries-response.d.ts.map +1 -0
- package/esm/sdk/models/list-journal-entries-response.js +17 -0
- package/esm/sdk/models/list-journal-entries-response.js.map +1 -0
- package/esm/sdk/models/list-payments-op.d.ts +5 -0
- package/esm/sdk/models/list-payments-op.d.ts.map +1 -1
- package/esm/sdk/models/list-payments-op.js +2 -0
- package/esm/sdk/models/list-payments-op.js.map +1 -1
- package/esm/sdk/models/list-performance-obligations-response.d.ts +13 -0
- package/esm/sdk/models/list-performance-obligations-response.d.ts.map +1 -0
- package/esm/sdk/models/list-performance-obligations-response.js +17 -0
- package/esm/sdk/models/list-performance-obligations-response.js.map +1 -0
- package/esm/sdk/models/list-products-op.d.ts +44 -0
- package/esm/sdk/models/list-products-op.d.ts.map +1 -0
- package/esm/sdk/models/list-products-op.js +41 -0
- package/esm/sdk/models/list-products-op.js.map +1 -0
- package/esm/sdk/models/list-products-response.d.ts +13 -0
- package/esm/sdk/models/list-products-response.d.ts.map +1 -0
- package/esm/sdk/models/list-products-response.js +17 -0
- package/esm/sdk/models/list-products-response.js.map +1 -0
- package/esm/sdk/models/performance-obligation-association-response.d.ts +14 -0
- package/esm/sdk/models/performance-obligation-association-response.d.ts.map +1 -0
- package/esm/sdk/models/performance-obligation-association-response.js +25 -0
- package/esm/sdk/models/performance-obligation-association-response.js.map +1 -0
- package/esm/sdk/models/performance-obligation-response.d.ts +26 -0
- package/esm/sdk/models/performance-obligation-response.d.ts.map +1 -0
- package/esm/sdk/models/performance-obligation-response.js +42 -0
- package/esm/sdk/models/performance-obligation-response.js.map +1 -0
- package/esm/sdk/models/performance-obligation-status.d.ts +14 -0
- package/esm/sdk/models/performance-obligation-status.d.ts.map +1 -0
- package/esm/sdk/models/performance-obligation-status.js +15 -0
- package/esm/sdk/models/performance-obligation-status.js.map +1 -0
- package/esm/sdk/models/pob-filter.d.ts +51 -0
- package/esm/sdk/models/pob-filter.d.ts.map +1 -0
- package/esm/sdk/models/pob-filter.js +47 -0
- package/esm/sdk/models/pob-filter.js.map +1 -0
- package/esm/sdk/models/price-filter.d.ts +2 -0
- package/esm/sdk/models/price-filter.d.ts.map +1 -1
- package/esm/sdk/models/price-filter.js +2 -0
- package/esm/sdk/models/price-filter.js.map +1 -1
- package/esm/sdk/models/price-price.d.ts +1 -0
- package/esm/sdk/models/price-price.d.ts.map +1 -1
- package/esm/sdk/models/price-price.js +2 -0
- package/esm/sdk/models/price-price.js.map +1 -1
- package/esm/sdk/models/price-response.d.ts +1 -0
- package/esm/sdk/models/price-response.d.ts.map +1 -1
- package/esm/sdk/models/price-response.js +2 -0
- package/esm/sdk/models/price-response.js.map +1 -1
- package/esm/sdk/models/product-filter.d.ts +43 -0
- package/esm/sdk/models/product-filter.d.ts.map +1 -0
- package/esm/sdk/models/product-filter.js +39 -0
- package/esm/sdk/models/product-filter.js.map +1 -0
- package/esm/sdk/models/product-response.d.ts +17 -0
- package/esm/sdk/models/product-response.d.ts.map +1 -0
- package/esm/sdk/models/product-response.js +28 -0
- package/esm/sdk/models/product-response.js.map +1 -0
- package/esm/sdk/models/recognition-method.d.ts +13 -0
- package/esm/sdk/models/recognition-method.d.ts.map +1 -0
- package/esm/sdk/models/recognition-method.js +14 -0
- package/esm/sdk/models/recognition-method.js.map +1 -0
- package/esm/sdk/models/rev-rec-entity-type.d.ts +17 -0
- package/esm/sdk/models/rev-rec-entity-type.d.ts.map +1 -0
- package/esm/sdk/models/rev-rec-entity-type.js +18 -0
- package/esm/sdk/models/rev-rec-entity-type.js.map +1 -0
- package/esm/sdk/models/revenue-breakdown.d.ts +16 -0
- package/esm/sdk/models/revenue-breakdown.d.ts.map +1 -0
- package/esm/sdk/models/revenue-breakdown.js +17 -0
- package/esm/sdk/models/revenue-breakdown.js.map +1 -0
- package/esm/sdk/models/revenue-report-group-by.d.ts +11 -0
- package/esm/sdk/models/revenue-report-group-by.d.ts.map +1 -0
- package/esm/sdk/models/revenue-report-group-by.js +12 -0
- package/esm/sdk/models/revenue-report-group-by.js.map +1 -0
- package/esm/sdk/models/rollforward-request.d.ts +49 -0
- package/esm/sdk/models/rollforward-request.d.ts.map +1 -0
- package/esm/sdk/models/rollforward-request.js +35 -0
- package/esm/sdk/models/rollforward-request.js.map +1 -0
- package/esm/sdk/models/rollforward-response.d.ts +20 -0
- package/esm/sdk/models/rollforward-response.d.ts.map +1 -0
- package/esm/sdk/models/rollforward-response.js +18 -0
- package/esm/sdk/models/rollforward-response.js.map +1 -0
- package/esm/sdk/models/rollforward-row.d.ts +26 -0
- package/esm/sdk/models/rollforward-row.d.ts.map +1 -0
- package/esm/sdk/models/rollforward-row.js +29 -0
- package/esm/sdk/models/rollforward-row.js.map +1 -0
- package/esm/sdk/models/update-price-request.d.ts +5 -0
- package/esm/sdk/models/update-price-request.d.ts.map +1 -1
- package/esm/sdk/models/update-price-request.js +2 -0
- package/esm/sdk/models/update-price-request.js.map +1 -1
- package/esm/sdk/models/update-product-op.d.ts +21 -0
- package/esm/sdk/models/update-product-op.d.ts.map +1 -0
- package/esm/sdk/models/update-product-op.js +14 -0
- package/esm/sdk/models/update-product-op.js.map +1 -0
- package/esm/sdk/models/update-product-request.d.ts +14 -0
- package/esm/sdk/models/update-product-request.d.ts.map +1 -0
- package/esm/sdk/models/update-product-request.js +13 -0
- package/esm/sdk/models/update-product-request.js.map +1 -0
- package/esm/sdk/models/waterfall-cell.d.ts +23 -0
- package/esm/sdk/models/waterfall-cell.d.ts.map +1 -0
- package/esm/sdk/models/waterfall-cell.js +18 -0
- package/esm/sdk/models/waterfall-cell.js.map +1 -0
- package/esm/sdk/models/waterfall-request.d.ts +48 -0
- package/esm/sdk/models/waterfall-request.d.ts.map +1 -0
- package/esm/sdk/models/waterfall-request.js +34 -0
- package/esm/sdk/models/waterfall-request.js.map +1 -0
- package/esm/sdk/models/waterfall-response.d.ts +18 -0
- package/esm/sdk/models/waterfall-response.d.ts.map +1 -0
- package/esm/sdk/models/waterfall-response.js +19 -0
- package/esm/sdk/models/waterfall-response.js.map +1 -0
- package/esm/sdk/models/waterfall-row.d.ts +17 -0
- package/esm/sdk/models/waterfall-row.d.ts.map +1 -0
- package/esm/sdk/models/waterfall-row.js +25 -0
- package/esm/sdk/models/waterfall-row.js.map +1 -0
- package/esm/sdk/performance-obligations.d.ts +19 -0
- package/esm/sdk/performance-obligations.d.ts.map +1 -0
- package/esm/sdk/performance-obligations.js +28 -0
- package/esm/sdk/performance-obligations.js.map +1 -0
- package/esm/sdk/products.d.ts +47 -0
- package/esm/sdk/products.d.ts.map +1 -0
- package/esm/sdk/products.js +68 -0
- package/esm/sdk/products.js.map +1 -0
- package/esm/sdk/revenue-reports.d.ts +19 -0
- package/esm/sdk/revenue-reports.d.ts.map +1 -0
- package/esm/sdk/revenue-reports.js +28 -0
- package/esm/sdk/revenue-reports.js.map +1 -0
- package/esm/sdk/sdk.d.ts +18 -0
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +30 -0
- package/esm/sdk/sdk.js.map +1 -1
- package/examples/{activityListActivity.example.ts → accountingPeriodsQueryAccountingPeriod.example.ts} +2 -2
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/accounting-periods-query-accounting-period.ts +172 -0
- package/src/funcs/contracts-get-contract.ts +181 -0
- package/src/funcs/contracts-query-contract.ts +172 -0
- package/src/funcs/journal-entries-get-journal-entry.ts +181 -0
- package/src/funcs/journal-entries-query-journal-entry.ts +172 -0
- package/src/funcs/payments-list-payments.ts +1 -0
- package/src/funcs/performance-obligations-get-performance-obligation.ts +182 -0
- package/src/funcs/performance-obligations-query-performance-obligation.ts +172 -0
- package/src/funcs/products-create-product.ts +172 -0
- package/src/funcs/products-delete-product.ts +181 -0
- package/src/funcs/products-get-product.ts +181 -0
- package/src/funcs/products-list-products.ts +189 -0
- package/src/funcs/products-query-product.ts +172 -0
- package/src/funcs/products-update-product.ts +187 -0
- package/src/funcs/revenue-reports-get-revenue-rollforward.ts +172 -0
- package/src/funcs/revenue-reports-get-revenue-waterfall.ts +172 -0
- package/src/lib/config.ts +3 -2
- package/src/sdk/accounting-periods.ts +27 -0
- package/src/sdk/contracts.ts +45 -0
- package/src/sdk/journal-entries.ts +45 -0
- package/src/sdk/models/accounting-period-response.ts +60 -0
- package/src/sdk/models/accounting-period-status.ts +24 -0
- package/src/sdk/models/accountingperiod-filter.ts +100 -0
- package/src/sdk/models/amortization-method.ts +20 -0
- package/src/sdk/models/contract-association-response.ts +51 -0
- package/src/sdk/models/contract-filter.ts +106 -0
- package/src/sdk/models/contract-response.ts +76 -0
- package/src/sdk/models/contract-status.ts +26 -0
- package/src/sdk/models/create-price-request.ts +4 -0
- package/src/sdk/models/create-product-request.ts +44 -0
- package/src/sdk/models/delete-product-op.ts +33 -0
- package/src/sdk/models/get-contract-op.ts +33 -0
- package/src/sdk/models/get-journal-entry-op.ts +33 -0
- package/src/sdk/models/get-performance-obligation-op.ts +35 -0
- package/src/sdk/models/get-product-op.ts +33 -0
- package/src/sdk/models/index.ts +45 -0
- package/src/sdk/models/invoice-filter.ts +9 -0
- package/src/sdk/models/journal-direction.ts +19 -0
- package/src/sdk/models/journal-entry-response.ts +81 -0
- package/src/sdk/models/journal-event-type.ts +31 -0
- package/src/sdk/models/journal-filter.ts +129 -0
- package/src/sdk/models/journal-line-response.ts +55 -0
- package/src/sdk/models/ledger-account-key.ts +30 -0
- package/src/sdk/models/list-accounting-periods-response.ts +41 -0
- package/src/sdk/models/list-contracts-response.ts +41 -0
- package/src/sdk/models/list-journal-entries-response.ts +41 -0
- package/src/sdk/models/list-payments-op.ts +7 -0
- package/src/sdk/models/list-performance-obligations-response.ts +42 -0
- package/src/sdk/models/list-products-op.ts +89 -0
- package/src/sdk/models/list-products-response.ts +41 -0
- package/src/sdk/models/performance-obligation-association-response.ts +55 -0
- package/src/sdk/models/performance-obligation-response.ts +87 -0
- package/src/sdk/models/performance-obligation-status.ts +28 -0
- package/src/sdk/models/pob-filter.ts +112 -0
- package/src/sdk/models/price-filter.ts +4 -0
- package/src/sdk/models/price-price.ts +3 -0
- package/src/sdk/models/price-response.ts +3 -0
- package/src/sdk/models/product-filter.ts +90 -0
- package/src/sdk/models/product-response.ts +54 -0
- package/src/sdk/models/recognition-method.ts +25 -0
- package/src/sdk/models/rev-rec-entity-type.ts +29 -0
- package/src/sdk/models/revenue-breakdown.ts +40 -0
- package/src/sdk/models/revenue-report-group-by.ts +18 -0
- package/src/sdk/models/rollforward-request.ts +97 -0
- package/src/sdk/models/rollforward-response.ts +49 -0
- package/src/sdk/models/rollforward-row.ts +65 -0
- package/src/sdk/models/update-price-request.ts +7 -0
- package/src/sdk/models/update-product-op.ts +46 -0
- package/src/sdk/models/update-product-request.ts +33 -0
- package/src/sdk/models/waterfall-cell.ts +50 -0
- package/src/sdk/models/waterfall-request.ts +93 -0
- package/src/sdk/models/waterfall-response.ts +47 -0
- package/src/sdk/models/waterfall-row.ts +52 -0
- package/src/sdk/performance-obligations.ts +45 -0
- package/src/sdk/products.ts +119 -0
- package/src/sdk/revenue-reports.ts +45 -0
- package/src/sdk/sdk.ts +38 -0
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
# PerformanceObligations
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
### Available Operations
|
|
6
|
+
|
|
7
|
+
* [queryPerformanceObligation](#queryperformanceobligation) - Query performance obligations
|
|
8
|
+
* [getPerformanceObligation](#getperformanceobligation) - Get performance obligation
|
|
9
|
+
|
|
10
|
+
## queryPerformanceObligation
|
|
11
|
+
|
|
12
|
+
Use when searching performance obligations by contract, customer, status or recognition method. Returns a paginated list.
|
|
13
|
+
|
|
14
|
+
### Example Usage
|
|
15
|
+
|
|
16
|
+
<!-- UsageSnippet language="typescript" operationID="queryPerformanceObligation" method="post" path="/performance_obligations/search" -->
|
|
17
|
+
```typescript
|
|
18
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
19
|
+
|
|
20
|
+
const flexprice = new Flexprice({
|
|
21
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
async function run() {
|
|
25
|
+
const result = await flexprice.performanceObligations.queryPerformanceObligation({});
|
|
26
|
+
|
|
27
|
+
console.log(result);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
run();
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Standalone function
|
|
34
|
+
|
|
35
|
+
The standalone function version of this method:
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
39
|
+
import { performanceObligationsQueryPerformanceObligation } from "@flexprice/sdk/funcs/performance-obligations-query-performance-obligation.js";
|
|
40
|
+
|
|
41
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
42
|
+
// You can create one instance of it to use across an application.
|
|
43
|
+
const flexprice = new FlexpriceCore({
|
|
44
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
async function run() {
|
|
48
|
+
const res = await performanceObligationsQueryPerformanceObligation(flexprice, {});
|
|
49
|
+
if (res.ok) {
|
|
50
|
+
const { value: result } = res;
|
|
51
|
+
console.log(result);
|
|
52
|
+
} else {
|
|
53
|
+
console.log("performanceObligationsQueryPerformanceObligation failed:", res.error);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
run();
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Parameters
|
|
61
|
+
|
|
62
|
+
| Parameter | Type | Required | Description |
|
|
63
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
64
|
+
| `request` | [models.PobFilter](../../sdk/models/pob-filter.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
65
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
66
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
67
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
68
|
+
|
|
69
|
+
### Response
|
|
70
|
+
|
|
71
|
+
**Promise\<[models.ListPerformanceObligationsResponse](../../sdk/models/list-performance-obligations-response.md)\>**
|
|
72
|
+
|
|
73
|
+
### Errors
|
|
74
|
+
|
|
75
|
+
| Error Type | Status Code | Content Type |
|
|
76
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
77
|
+
| models.ErrorsErrorResponse | 400 | application/json |
|
|
78
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
79
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
80
|
+
|
|
81
|
+
## getPerformanceObligation
|
|
82
|
+
|
|
83
|
+
Use when you need to load a single performance obligation with the subscription line items it covers. Performance obligations are derived from subscriptions and are read-only.
|
|
84
|
+
|
|
85
|
+
### Example Usage
|
|
86
|
+
|
|
87
|
+
<!-- UsageSnippet language="typescript" operationID="getPerformanceObligation" method="get" path="/performance_obligations/{id}" -->
|
|
88
|
+
```typescript
|
|
89
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
90
|
+
|
|
91
|
+
const flexprice = new Flexprice({
|
|
92
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
async function run() {
|
|
96
|
+
const result = await flexprice.performanceObligations.getPerformanceObligation("<id>");
|
|
97
|
+
|
|
98
|
+
console.log(result);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
run();
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Standalone function
|
|
105
|
+
|
|
106
|
+
The standalone function version of this method:
|
|
107
|
+
|
|
108
|
+
```typescript
|
|
109
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
110
|
+
import { performanceObligationsGetPerformanceObligation } from "@flexprice/sdk/funcs/performance-obligations-get-performance-obligation.js";
|
|
111
|
+
|
|
112
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
113
|
+
// You can create one instance of it to use across an application.
|
|
114
|
+
const flexprice = new FlexpriceCore({
|
|
115
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
116
|
+
});
|
|
117
|
+
|
|
118
|
+
async function run() {
|
|
119
|
+
const res = await performanceObligationsGetPerformanceObligation(flexprice, "<id>");
|
|
120
|
+
if (res.ok) {
|
|
121
|
+
const { value: result } = res;
|
|
122
|
+
console.log(result);
|
|
123
|
+
} else {
|
|
124
|
+
console.log("performanceObligationsGetPerformanceObligation failed:", res.error);
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
run();
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### Parameters
|
|
132
|
+
|
|
133
|
+
| Parameter | Type | Required | Description |
|
|
134
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
135
|
+
| `id` | *string* | :heavy_check_mark: | Performance obligation ID |
|
|
136
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
137
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
138
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
139
|
+
|
|
140
|
+
### Response
|
|
141
|
+
|
|
142
|
+
**Promise\<[models.PerformanceObligationResponse](../../sdk/models/performance-obligation-response.md)\>**
|
|
143
|
+
|
|
144
|
+
### Errors
|
|
145
|
+
|
|
146
|
+
| Error Type | Status Code | Content Type |
|
|
147
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
148
|
+
| models.ErrorsErrorResponse | 400, 404 | application/json |
|
|
149
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
150
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -0,0 +1,445 @@
|
|
|
1
|
+
# Products
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
### Available Operations
|
|
6
|
+
|
|
7
|
+
* [listProducts](#listproducts) - List products
|
|
8
|
+
* [createProduct](#createproduct) - Create product
|
|
9
|
+
* [queryProduct](#queryproduct) - Query products
|
|
10
|
+
* [getProduct](#getproduct) - Get product
|
|
11
|
+
* [updateProduct](#updateproduct) - Update product
|
|
12
|
+
* [deleteProduct](#deleteproduct) - Delete product
|
|
13
|
+
|
|
14
|
+
## listProducts
|
|
15
|
+
|
|
16
|
+
Use when listing products. Returns a paginated list.
|
|
17
|
+
|
|
18
|
+
### Example Usage
|
|
19
|
+
|
|
20
|
+
<!-- UsageSnippet language="typescript" operationID="listProducts" method="get" path="/products" -->
|
|
21
|
+
```typescript
|
|
22
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
23
|
+
|
|
24
|
+
const flexprice = new Flexprice({
|
|
25
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
async function run() {
|
|
29
|
+
const result = await flexprice.products.listProducts();
|
|
30
|
+
|
|
31
|
+
console.log(result);
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
run();
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Standalone function
|
|
38
|
+
|
|
39
|
+
The standalone function version of this method:
|
|
40
|
+
|
|
41
|
+
```typescript
|
|
42
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
43
|
+
import { productsListProducts } from "@flexprice/sdk/funcs/products-list-products.js";
|
|
44
|
+
|
|
45
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
46
|
+
// You can create one instance of it to use across an application.
|
|
47
|
+
const flexprice = new FlexpriceCore({
|
|
48
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
async function run() {
|
|
52
|
+
const res = await productsListProducts(flexprice);
|
|
53
|
+
if (res.ok) {
|
|
54
|
+
const { value: result } = res;
|
|
55
|
+
console.log(result);
|
|
56
|
+
} else {
|
|
57
|
+
console.log("productsListProducts failed:", res.error);
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
run();
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Parameters
|
|
65
|
+
|
|
66
|
+
| Parameter | Type | Required | Description |
|
|
67
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
68
|
+
| `request` | [models.ListProductsRequest](../../sdk/models/list-products-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
69
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
70
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
71
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
72
|
+
|
|
73
|
+
### Response
|
|
74
|
+
|
|
75
|
+
**Promise\<[models.ListProductsResponse](../../sdk/models/list-products-response.md)\>**
|
|
76
|
+
|
|
77
|
+
### Errors
|
|
78
|
+
|
|
79
|
+
| Error Type | Status Code | Content Type |
|
|
80
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
81
|
+
| models.ErrorsErrorResponse | 400 | application/json |
|
|
82
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
83
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
84
|
+
|
|
85
|
+
## createProduct
|
|
86
|
+
|
|
87
|
+
Use when defining a reusable commercial identity for what you sell. Prices can reference it through product_id.
|
|
88
|
+
|
|
89
|
+
### Example Usage
|
|
90
|
+
|
|
91
|
+
<!-- UsageSnippet language="typescript" operationID="createProduct" method="post" path="/products" -->
|
|
92
|
+
```typescript
|
|
93
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
94
|
+
|
|
95
|
+
const flexprice = new Flexprice({
|
|
96
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
97
|
+
});
|
|
98
|
+
|
|
99
|
+
async function run() {
|
|
100
|
+
const result = await flexprice.products.createProduct({
|
|
101
|
+
lookupKey: "<value>",
|
|
102
|
+
name: "<value>",
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
console.log(result);
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
run();
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### Standalone function
|
|
112
|
+
|
|
113
|
+
The standalone function version of this method:
|
|
114
|
+
|
|
115
|
+
```typescript
|
|
116
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
117
|
+
import { productsCreateProduct } from "@flexprice/sdk/funcs/products-create-product.js";
|
|
118
|
+
|
|
119
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
120
|
+
// You can create one instance of it to use across an application.
|
|
121
|
+
const flexprice = new FlexpriceCore({
|
|
122
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
123
|
+
});
|
|
124
|
+
|
|
125
|
+
async function run() {
|
|
126
|
+
const res = await productsCreateProduct(flexprice, {
|
|
127
|
+
lookupKey: "<value>",
|
|
128
|
+
name: "<value>",
|
|
129
|
+
});
|
|
130
|
+
if (res.ok) {
|
|
131
|
+
const { value: result } = res;
|
|
132
|
+
console.log(result);
|
|
133
|
+
} else {
|
|
134
|
+
console.log("productsCreateProduct failed:", res.error);
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
run();
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### Parameters
|
|
142
|
+
|
|
143
|
+
| Parameter | Type | Required | Description |
|
|
144
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
145
|
+
| `request` | [models.CreateProductRequest](../../sdk/models/create-product-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
146
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
147
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
148
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
149
|
+
|
|
150
|
+
### Response
|
|
151
|
+
|
|
152
|
+
**Promise\<[models.ProductResponse](../../sdk/models/product-response.md)\>**
|
|
153
|
+
|
|
154
|
+
### Errors
|
|
155
|
+
|
|
156
|
+
| Error Type | Status Code | Content Type |
|
|
157
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
158
|
+
| models.ErrorsErrorResponse | 400 | application/json |
|
|
159
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
160
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
161
|
+
|
|
162
|
+
## queryProduct
|
|
163
|
+
|
|
164
|
+
Use when searching products by ids, lookup keys, filters and sorts. Returns a paginated list.
|
|
165
|
+
|
|
166
|
+
### Example Usage
|
|
167
|
+
|
|
168
|
+
<!-- UsageSnippet language="typescript" operationID="queryProduct" method="post" path="/products/search" -->
|
|
169
|
+
```typescript
|
|
170
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
171
|
+
|
|
172
|
+
const flexprice = new Flexprice({
|
|
173
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
174
|
+
});
|
|
175
|
+
|
|
176
|
+
async function run() {
|
|
177
|
+
const result = await flexprice.products.queryProduct({});
|
|
178
|
+
|
|
179
|
+
console.log(result);
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
run();
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### Standalone function
|
|
186
|
+
|
|
187
|
+
The standalone function version of this method:
|
|
188
|
+
|
|
189
|
+
```typescript
|
|
190
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
191
|
+
import { productsQueryProduct } from "@flexprice/sdk/funcs/products-query-product.js";
|
|
192
|
+
|
|
193
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
194
|
+
// You can create one instance of it to use across an application.
|
|
195
|
+
const flexprice = new FlexpriceCore({
|
|
196
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
197
|
+
});
|
|
198
|
+
|
|
199
|
+
async function run() {
|
|
200
|
+
const res = await productsQueryProduct(flexprice, {});
|
|
201
|
+
if (res.ok) {
|
|
202
|
+
const { value: result } = res;
|
|
203
|
+
console.log(result);
|
|
204
|
+
} else {
|
|
205
|
+
console.log("productsQueryProduct failed:", res.error);
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
run();
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Parameters
|
|
213
|
+
|
|
214
|
+
| Parameter | Type | Required | Description |
|
|
215
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
216
|
+
| `request` | [models.ProductFilter](../../sdk/models/product-filter.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
217
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
218
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
219
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
220
|
+
|
|
221
|
+
### Response
|
|
222
|
+
|
|
223
|
+
**Promise\<[models.ListProductsResponse](../../sdk/models/list-products-response.md)\>**
|
|
224
|
+
|
|
225
|
+
### Errors
|
|
226
|
+
|
|
227
|
+
| Error Type | Status Code | Content Type |
|
|
228
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
229
|
+
| models.ErrorsErrorResponse | 400 | application/json |
|
|
230
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
231
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
232
|
+
|
|
233
|
+
## getProduct
|
|
234
|
+
|
|
235
|
+
Use when you need to load a single product.
|
|
236
|
+
|
|
237
|
+
### Example Usage
|
|
238
|
+
|
|
239
|
+
<!-- UsageSnippet language="typescript" operationID="getProduct" method="get" path="/products/{id}" -->
|
|
240
|
+
```typescript
|
|
241
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
242
|
+
|
|
243
|
+
const flexprice = new Flexprice({
|
|
244
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
245
|
+
});
|
|
246
|
+
|
|
247
|
+
async function run() {
|
|
248
|
+
const result = await flexprice.products.getProduct("<id>");
|
|
249
|
+
|
|
250
|
+
console.log(result);
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
run();
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
### Standalone function
|
|
257
|
+
|
|
258
|
+
The standalone function version of this method:
|
|
259
|
+
|
|
260
|
+
```typescript
|
|
261
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
262
|
+
import { productsGetProduct } from "@flexprice/sdk/funcs/products-get-product.js";
|
|
263
|
+
|
|
264
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
265
|
+
// You can create one instance of it to use across an application.
|
|
266
|
+
const flexprice = new FlexpriceCore({
|
|
267
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
268
|
+
});
|
|
269
|
+
|
|
270
|
+
async function run() {
|
|
271
|
+
const res = await productsGetProduct(flexprice, "<id>");
|
|
272
|
+
if (res.ok) {
|
|
273
|
+
const { value: result } = res;
|
|
274
|
+
console.log(result);
|
|
275
|
+
} else {
|
|
276
|
+
console.log("productsGetProduct failed:", res.error);
|
|
277
|
+
}
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
run();
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
### Parameters
|
|
284
|
+
|
|
285
|
+
| Parameter | Type | Required | Description |
|
|
286
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
287
|
+
| `id` | *string* | :heavy_check_mark: | Product ID |
|
|
288
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
289
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
290
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
291
|
+
|
|
292
|
+
### Response
|
|
293
|
+
|
|
294
|
+
**Promise\<[models.ProductResponse](../../sdk/models/product-response.md)\>**
|
|
295
|
+
|
|
296
|
+
### Errors
|
|
297
|
+
|
|
298
|
+
| Error Type | Status Code | Content Type |
|
|
299
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
300
|
+
| models.ErrorsErrorResponse | 400, 404 | application/json |
|
|
301
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
302
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
303
|
+
|
|
304
|
+
## updateProduct
|
|
305
|
+
|
|
306
|
+
Use when changing a product's name or description. The lookup key never changes.
|
|
307
|
+
|
|
308
|
+
### Example Usage
|
|
309
|
+
|
|
310
|
+
<!-- UsageSnippet language="typescript" operationID="updateProduct" method="put" path="/products/{id}" -->
|
|
311
|
+
```typescript
|
|
312
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
313
|
+
|
|
314
|
+
const flexprice = new Flexprice({
|
|
315
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
316
|
+
});
|
|
317
|
+
|
|
318
|
+
async function run() {
|
|
319
|
+
const result = await flexprice.products.updateProduct("<id>", {});
|
|
320
|
+
|
|
321
|
+
console.log(result);
|
|
322
|
+
}
|
|
323
|
+
|
|
324
|
+
run();
|
|
325
|
+
```
|
|
326
|
+
|
|
327
|
+
### Standalone function
|
|
328
|
+
|
|
329
|
+
The standalone function version of this method:
|
|
330
|
+
|
|
331
|
+
```typescript
|
|
332
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
333
|
+
import { productsUpdateProduct } from "@flexprice/sdk/funcs/products-update-product.js";
|
|
334
|
+
|
|
335
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
336
|
+
// You can create one instance of it to use across an application.
|
|
337
|
+
const flexprice = new FlexpriceCore({
|
|
338
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
339
|
+
});
|
|
340
|
+
|
|
341
|
+
async function run() {
|
|
342
|
+
const res = await productsUpdateProduct(flexprice, "<id>", {});
|
|
343
|
+
if (res.ok) {
|
|
344
|
+
const { value: result } = res;
|
|
345
|
+
console.log(result);
|
|
346
|
+
} else {
|
|
347
|
+
console.log("productsUpdateProduct failed:", res.error);
|
|
348
|
+
}
|
|
349
|
+
}
|
|
350
|
+
|
|
351
|
+
run();
|
|
352
|
+
```
|
|
353
|
+
|
|
354
|
+
### Parameters
|
|
355
|
+
|
|
356
|
+
| Parameter | Type | Required | Description |
|
|
357
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
358
|
+
| `id` | *string* | :heavy_check_mark: | Product ID |
|
|
359
|
+
| `body` | [models.UpdateProductRequest](../../sdk/models/update-product-request.md) | :heavy_check_mark: | Update Product Request |
|
|
360
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
361
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
362
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
363
|
+
|
|
364
|
+
### Response
|
|
365
|
+
|
|
366
|
+
**Promise\<[models.ProductResponse](../../sdk/models/product-response.md)\>**
|
|
367
|
+
|
|
368
|
+
### Errors
|
|
369
|
+
|
|
370
|
+
| Error Type | Status Code | Content Type |
|
|
371
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
372
|
+
| models.ErrorsErrorResponse | 400, 404 | application/json |
|
|
373
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
374
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
375
|
+
|
|
376
|
+
## deleteProduct
|
|
377
|
+
|
|
378
|
+
Use when retiring a product. Fails while any published price references it.
|
|
379
|
+
|
|
380
|
+
### Example Usage
|
|
381
|
+
|
|
382
|
+
<!-- UsageSnippet language="typescript" operationID="deleteProduct" method="delete" path="/products/{id}" -->
|
|
383
|
+
```typescript
|
|
384
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
385
|
+
|
|
386
|
+
const flexprice = new Flexprice({
|
|
387
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
388
|
+
});
|
|
389
|
+
|
|
390
|
+
async function run() {
|
|
391
|
+
const result = await flexprice.products.deleteProduct("<id>");
|
|
392
|
+
|
|
393
|
+
console.log(result);
|
|
394
|
+
}
|
|
395
|
+
|
|
396
|
+
run();
|
|
397
|
+
```
|
|
398
|
+
|
|
399
|
+
### Standalone function
|
|
400
|
+
|
|
401
|
+
The standalone function version of this method:
|
|
402
|
+
|
|
403
|
+
```typescript
|
|
404
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
405
|
+
import { productsDeleteProduct } from "@flexprice/sdk/funcs/products-delete-product.js";
|
|
406
|
+
|
|
407
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
408
|
+
// You can create one instance of it to use across an application.
|
|
409
|
+
const flexprice = new FlexpriceCore({
|
|
410
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
411
|
+
});
|
|
412
|
+
|
|
413
|
+
async function run() {
|
|
414
|
+
const res = await productsDeleteProduct(flexprice, "<id>");
|
|
415
|
+
if (res.ok) {
|
|
416
|
+
const { value: result } = res;
|
|
417
|
+
console.log(result);
|
|
418
|
+
} else {
|
|
419
|
+
console.log("productsDeleteProduct failed:", res.error);
|
|
420
|
+
}
|
|
421
|
+
}
|
|
422
|
+
|
|
423
|
+
run();
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
### Parameters
|
|
427
|
+
|
|
428
|
+
| Parameter | Type | Required | Description |
|
|
429
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
430
|
+
| `id` | *string* | :heavy_check_mark: | Product ID |
|
|
431
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
432
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
433
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
434
|
+
|
|
435
|
+
### Response
|
|
436
|
+
|
|
437
|
+
**Promise\<[models.SuccessResponse](../../sdk/models/success-response.md)\>**
|
|
438
|
+
|
|
439
|
+
### Errors
|
|
440
|
+
|
|
441
|
+
| Error Type | Status Code | Content Type |
|
|
442
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
443
|
+
| models.ErrorsErrorResponse | 400, 404 | application/json |
|
|
444
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
445
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|