@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,19 @@
|
|
|
1
|
+
# UpdateProductRequestRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { UpdateProductRequestRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: UpdateProductRequestRequest = {
|
|
9
|
+
id: "<id>",
|
|
10
|
+
body: {},
|
|
11
|
+
};
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Fields
|
|
15
|
+
|
|
16
|
+
| Field | Type | Required | Description |
|
|
17
|
+
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
|
18
|
+
| `id` | *string* | :heavy_check_mark: | Product ID |
|
|
19
|
+
| `body` | [models.UpdateProductRequest](../../sdk/models/update-product-request.md) | :heavy_check_mark: | Update Product Request |
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# UpdateProductRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { UpdateProductRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: UpdateProductRequest = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
15
|
+
| `description` | *string* | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `name` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# WaterfallCell
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { WaterfallCell } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: WaterfallCell = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
|
15
|
+
| `deferred` | *string* | :heavy_minus_sign: | details: closing deferred_revenue, ended months only |
|
|
16
|
+
| `period` | *string* | :heavy_minus_sign: | YYYY-MM |
|
|
17
|
+
| `revenue` | [models.RevenueBreakdown](../../sdk/models/revenue-breakdown.md) | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `unbilled` | *string* | :heavy_minus_sign: | details: closing unbilled_receivable, ended months only |
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# WaterfallRequest
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { WaterfallRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: WaterfallRequest = {
|
|
9
|
+
currency: "Swiss Franc",
|
|
10
|
+
periodEnd: new Date("2026-06-12T15:56:05.804Z"),
|
|
11
|
+
periodStart: new Date("2024-05-28T02:35:46.087Z"),
|
|
12
|
+
};
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Fields
|
|
16
|
+
|
|
17
|
+
| Field | Type | Required | Description |
|
|
18
|
+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
19
|
+
| `asOf` | *string* | :heavy_minus_sign: | report date: pending and scheduled split here; defaults to now |
|
|
20
|
+
| `contractIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `currency` | *string* | :heavy_check_mark: | N/A |
|
|
22
|
+
| `customerIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `details` | *boolean* | :heavy_minus_sign: | month-end deferred and unbilled balances |
|
|
24
|
+
| `groupBy` | [models.RevenueReportGroupBy](../../sdk/models/revenue-report-group-by.md) | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `limit` | *number* | :heavy_minus_sign: | rows per page; totals are never paged |
|
|
26
|
+
| `offset` | *number* | :heavy_minus_sign: | N/A |
|
|
27
|
+
| `periodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | YYYY-MM, at most 36 months from period_start |
|
|
28
|
+
| `periodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | YYYY-MM |
|
|
29
|
+
| `pobIds` | *string*[] | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# WaterfallResponse
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { WaterfallResponse } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: WaterfallResponse = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
|
15
|
+
| `items` | [models.WaterfallRow](../../sdk/models/waterfall-row.md)[] | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `pagination` | [models.PaginationResponse](../../sdk/models/pagination-response.md) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `totals` | [models.WaterfallCell](../../sdk/models/waterfall-cell.md)[] | :heavy_minus_sign: | per period over all rows, never paged |
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# WaterfallRow
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { WaterfallRow } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: WaterfallRow = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
|
15
|
+
| `cells` | [models.WaterfallCell](../../sdk/models/waterfall-cell.md)[] | :heavy_minus_sign: | one per requested period, in order |
|
|
16
|
+
| `contractId` | *string* | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `customerId` | *string* | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `pobId` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
# AccountingPeriods
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
### Available Operations
|
|
6
|
+
|
|
7
|
+
* [queryAccountingPeriod](#queryaccountingperiod) - Query accounting periods
|
|
8
|
+
|
|
9
|
+
## queryAccountingPeriod
|
|
10
|
+
|
|
11
|
+
Use when listing the monthly accounting periods revenue recognition posts to, by period status or a period start range. Returns a paginated list.
|
|
12
|
+
|
|
13
|
+
### Example Usage
|
|
14
|
+
|
|
15
|
+
<!-- UsageSnippet language="typescript" operationID="queryAccountingPeriod" method="post" path="/accounting_periods/search" -->
|
|
16
|
+
```typescript
|
|
17
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
18
|
+
|
|
19
|
+
const flexprice = new Flexprice({
|
|
20
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
async function run() {
|
|
24
|
+
const result = await flexprice.accountingPeriods.queryAccountingPeriod({});
|
|
25
|
+
|
|
26
|
+
console.log(result);
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
run();
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Standalone function
|
|
33
|
+
|
|
34
|
+
The standalone function version of this method:
|
|
35
|
+
|
|
36
|
+
```typescript
|
|
37
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
38
|
+
import { accountingPeriodsQueryAccountingPeriod } from "@flexprice/sdk/funcs/accounting-periods-query-accounting-period.js";
|
|
39
|
+
|
|
40
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
41
|
+
// You can create one instance of it to use across an application.
|
|
42
|
+
const flexprice = new FlexpriceCore({
|
|
43
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
44
|
+
});
|
|
45
|
+
|
|
46
|
+
async function run() {
|
|
47
|
+
const res = await accountingPeriodsQueryAccountingPeriod(flexprice, {});
|
|
48
|
+
if (res.ok) {
|
|
49
|
+
const { value: result } = res;
|
|
50
|
+
console.log(result);
|
|
51
|
+
} else {
|
|
52
|
+
console.log("accountingPeriodsQueryAccountingPeriod failed:", res.error);
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
run();
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Parameters
|
|
60
|
+
|
|
61
|
+
| Parameter | Type | Required | Description |
|
|
62
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
63
|
+
| `request` | [models.AccountingperiodFilter](../../sdk/models/accountingperiod-filter.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
64
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
65
|
+
| `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. |
|
|
66
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
67
|
+
|
|
68
|
+
### Response
|
|
69
|
+
|
|
70
|
+
**Promise\<[models.ListAccountingPeriodsResponse](../../sdk/models/list-accounting-periods-response.md)\>**
|
|
71
|
+
|
|
72
|
+
### Errors
|
|
73
|
+
|
|
74
|
+
| Error Type | Status Code | Content Type |
|
|
75
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
76
|
+
| models.ErrorsErrorResponse | 400 | application/json |
|
|
77
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
78
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
# Contracts
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
### Available Operations
|
|
6
|
+
|
|
7
|
+
* [queryContract](#querycontract) - Query contracts
|
|
8
|
+
* [getContract](#getcontract) - Get contract
|
|
9
|
+
|
|
10
|
+
## queryContract
|
|
11
|
+
|
|
12
|
+
Use when searching revenue recognition contracts by customer, subscription or contract status. Returns a paginated list.
|
|
13
|
+
|
|
14
|
+
### Example Usage
|
|
15
|
+
|
|
16
|
+
<!-- UsageSnippet language="typescript" operationID="queryContract" method="post" path="/contracts/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.contracts.queryContract({});
|
|
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 { contractsQueryContract } from "@flexprice/sdk/funcs/contracts-query-contract.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 contractsQueryContract(flexprice, {});
|
|
49
|
+
if (res.ok) {
|
|
50
|
+
const { value: result } = res;
|
|
51
|
+
console.log(result);
|
|
52
|
+
} else {
|
|
53
|
+
console.log("contractsQueryContract failed:", res.error);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
run();
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Parameters
|
|
61
|
+
|
|
62
|
+
| Parameter | Type | Required | Description |
|
|
63
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
64
|
+
| `request` | [models.ContractFilter](../../sdk/models/contract-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.ListContractsResponse](../../sdk/models/list-contracts-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
|
+
## getContract
|
|
82
|
+
|
|
83
|
+
Use when you need to load a single revenue recognition contract with the subscriptions it covers. Contracts are derived from subscriptions and are read-only.
|
|
84
|
+
|
|
85
|
+
### Example Usage
|
|
86
|
+
|
|
87
|
+
<!-- UsageSnippet language="typescript" operationID="getContract" method="get" path="/contracts/{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.contracts.getContract("<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 { contractsGetContract } from "@flexprice/sdk/funcs/contracts-get-contract.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 contractsGetContract(flexprice, "<id>");
|
|
120
|
+
if (res.ok) {
|
|
121
|
+
const { value: result } = res;
|
|
122
|
+
console.log(result);
|
|
123
|
+
} else {
|
|
124
|
+
console.log("contractsGetContract 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: | Contract 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.ContractResponse](../../sdk/models/contract-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,150 @@
|
|
|
1
|
+
# JournalEntries
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
### Available Operations
|
|
6
|
+
|
|
7
|
+
* [queryJournalEntry](#queryjournalentry) - Query journal entries
|
|
8
|
+
* [getJournalEntry](#getjournalentry) - Get journal entry
|
|
9
|
+
|
|
10
|
+
## queryJournalEntry
|
|
11
|
+
|
|
12
|
+
Use when listing journal entries by period, event type, account, customer, contract, performance obligation or source. Returns a paginated list with lines.
|
|
13
|
+
|
|
14
|
+
### Example Usage
|
|
15
|
+
|
|
16
|
+
<!-- UsageSnippet language="typescript" operationID="queryJournalEntry" method="post" path="/journal_entries/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.journalEntries.queryJournalEntry({});
|
|
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 { journalEntriesQueryJournalEntry } from "@flexprice/sdk/funcs/journal-entries-query-journal-entry.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 journalEntriesQueryJournalEntry(flexprice, {});
|
|
49
|
+
if (res.ok) {
|
|
50
|
+
const { value: result } = res;
|
|
51
|
+
console.log(result);
|
|
52
|
+
} else {
|
|
53
|
+
console.log("journalEntriesQueryJournalEntry failed:", res.error);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
run();
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Parameters
|
|
61
|
+
|
|
62
|
+
| Parameter | Type | Required | Description |
|
|
63
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
64
|
+
| `request` | [models.JournalFilter](../../sdk/models/journal-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.ListJournalEntriesResponse](../../sdk/models/list-journal-entries-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
|
+
## getJournalEntry
|
|
82
|
+
|
|
83
|
+
Use when you need one revenue recognition journal entry with its debit and credit lines. The journal is derived from billing and recognition and is read-only.
|
|
84
|
+
|
|
85
|
+
### Example Usage
|
|
86
|
+
|
|
87
|
+
<!-- UsageSnippet language="typescript" operationID="getJournalEntry" method="get" path="/journal_entries/{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.journalEntries.getJournalEntry("<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 { journalEntriesGetJournalEntry } from "@flexprice/sdk/funcs/journal-entries-get-journal-entry.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 journalEntriesGetJournalEntry(flexprice, "<id>");
|
|
120
|
+
if (res.ok) {
|
|
121
|
+
const { value: result } = res;
|
|
122
|
+
console.log(result);
|
|
123
|
+
} else {
|
|
124
|
+
console.log("journalEntriesGetJournalEntry 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: | Journal entry 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.JournalEntryResponse](../../sdk/models/journal-entry-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 | \*/\* |
|