@teemill/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @teemill/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://api.localhost:8080

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- BillingApi | confirmTransaction | POST /v1/billing/transactions/{id}/confirm | Confirm a transaction BillingApi | createAdminPlan | POST /v1/billing/admin/plans | Create a billing plan BillingApi | createAdminProjectPlan | POST /v1/billing/admin/projects/{projectCode}/plan | Create a dedicated plan for a project BillingApi | createPaymentMethod | POST /v1/billing/payment-methods | Create a project payment method BillingApi | createSummary | POST /v1/billing/summaries | Create a project summary BillingApi | createTransaction | POST /v1/billing/transactions | Create a transaction BillingApi | createWalletStatement | POST /v1/billing/wallets/{id}/statements | Create a wallet statement BillingApi | createWalletTransaction | POST /v1/billing/clients/{client}/wallets/{id}/transactions | Create a wallet transaction BillingApi | deleteAdminPlan | DELETE /v1/billing/admin/plans/{plan} | Delete an unused billing plan BillingApi | deleteAdminPlanDiscount | DELETE /v1/billing/admin/plans/{plan}/discounts/{sku} | Delete a plan discount BillingApi | deleteAdminPlanPriceRule | DELETE /v1/billing/admin/plans/{plan}/price-rules/{sku} | Delete a plan price rule BillingApi | deleteAdminProjectPlan | DELETE /v1/billing/admin/projects/{projectCode}/plan | Revert a project to its parent plan BillingApi | deletePaymentMethod | DELETE /v1/billing/payment-methods/{id} | Delete a project payment method BillingApi | deleteSummary | DELETE /v1/billing/summaries/{id} | Delete a project summary BillingApi | downloadCreditNote | GET /v1/billing/credit-notes/{id}/download | Download a project credit note BillingApi | downloadInvoice | GET /v1/billing/invoices/{id}/download | Download a project invoice BillingApi | downloadSummary | GET /v1/billing/summaries/{id}/download | Download a project summary BillingApi | downloadWalletStatement | GET /v1/billing/wallets/{id}/statements/{statementId}/download | Download a wallet statement BillingApi | exportAdminTransactions | POST /v1/billing/admin/transactions/export | Export all billing charges BillingApi | exportClientInvoices | POST /v1/billing/clients/invoices/export | Export platform client invoices BillingApi | exportInvoiceTransactions | POST /v1/billing/invoices/{id}/transactions/export | Export invoice transactions BillingApi | exportSummaryTransactions | POST /v1/billing/summaries/{id}/transactions/export | Export summary transactions BillingApi | exportTransactions | POST /v1/billing/transactions/export | Export billing charges BillingApi | getAdminPlan | GET /v1/billing/admin/plans/{plan} | Retrieve a billing plan BillingApi | getAdminPlanProduct | GET /v1/billing/admin/plans/{plan}/products/{sku} | Retrieve a plan's resolved product BillingApi | getAdminPlanProducts | GET /v1/billing/admin/plans/{plan}/products | List a plan's resolved products BillingApi | getAdminPlanProjects | GET /v1/billing/admin/plans/{plan}/projects | List a plan's directly-assigned projects BillingApi | getAdminPlans | GET /v1/billing/admin/plans | List billing plans BillingApi | getBillingProject | GET /v1/billing | Retrieve the billing project BillingApi | getClientInvoicePaymentAttempts | GET /v1/billing/clients/{client}/invoices/{id}/payment-attempts | Retrieve a list of client project's invoice payment attempts BillingApi | getClientInvoices | GET /v1/billing/clients/{client}/invoices | Retrieve a list of client project's invoices BillingApi | getClientPaymentMethods | GET /v1/billing/clients/{client}/payment-methods | Retrieve client project payment methods BillingApi | getClientPlan | GET /v1/billing/clients/{client}/plan | Fetch client project's billing plan BillingApi | getClientProject | GET /v1/billing/clients/{client} | Fetch client billing project BillingApi | getCreditNote | GET /v1/billing/credit-notes/{id} | Retrieve a project credit note BillingApi | getCreditNotes | GET /v1/billing/credit-notes | Retrieve a list of project credit notes BillingApi | getFinanceDashboard | GET /v1/billing/admin/finance/dashboard | Retrieve the finance dashboard BillingApi | getInvoice | GET /v1/billing/invoices/{id} | Retrieve a project invoice BillingApi | getInvoicePaymentAttempts | GET /v1/billing/invoices/{id}/payment-attempts | Retrieve a list of project invoice payment attempts BillingApi | getInvoices | GET /v1/billing/invoices | Retrieve a list of project invoices BillingApi | getOverview | GET /v1/billing/overview | Retrieve the billing project overview BillingApi | getPaymentMethod | GET /v1/billing/payment-methods/{id} | Retrieve a project payment method BillingApi | getPaymentMethodPaymentAttempts | GET /v1/billing/payment-methods/{id}/payment-attempts | Retrieve a list of project payment method payment attempts BillingApi | getPaymentMethodVendorSecret | GET /v1/billing/payment-methods/{vendor}/secret | Retrieve a project payment method secret BillingApi | getPaymentMethods | GET /v1/billing/payment-methods | Retrieve a list of project payment methods BillingApi | getPlans | GET /v1/billing/plans | Retrieve a list of project billing plans BillingApi | getSummaries | GET /v1/billing/summaries | Retrieve a list of project summaries BillingApi | getSummary | GET /v1/billing/summaries/{id} | Retrieve a project summary BillingApi | getTransaction | GET /v1/billing/transactions/{id} | Retrieve a project transaction BillingApi | getTransactions | GET /v1/billing/transactions | Retrieve a list of project transactions BillingApi | getWallet | GET /v1/billing/wallets/{id} | Retrieve a project wallet BillingApi | getWalletStatement | GET /v1/billing/wallets/{id}/statements/{statementId} | Retrieve a wallet statement BillingApi | getWalletStatements | GET /v1/billing/wallets/{id}/statements | Retrieve a list of wallet statements BillingApi | getWalletTransactions | GET /v1/billing/wallets/{id}/transactions | Retrieve a list of project wallet transactions for a given wallet BillingApi | getWallets | GET /v1/billing/wallets | Retrieve a list of project wallets BillingApi | listClientProjects | GET /v1/billing/clients | List client billing projects BillingApi | updateAdminPlan | PATCH /v1/billing/admin/plans/{plan} | Update a billing plan BillingApi | updateAdminPlanDiscount | PUT /v1/billing/admin/plans/{plan}/discounts/{sku} | Create or replace a plan discount BillingApi | updateAdminPlanPriceRule | PUT /v1/billing/admin/plans/{plan}/price-rules/{sku} | Create or replace a plan price rule BillingApi | updateBillingProject | PATCH /v1/billing | Update the billing project BillingApi | updateClientPlan | PATCH /v1/billing/clients/{client}/plan | Update client project's billing plan BillingApi | updateClientProject | PATCH /v1/billing/clients/{client} | Update client billing project BillingApi | updatePaymentMethod | PATCH /v1/billing/payment-methods/{id} | Update a project payment method BillingApi | updateWallet | PATCH /v1/billing/wallets/{id} | Update a project wallet

Documentation For Models

• AdminPlan
• AdminPlanDiscountInput
• AdminPlanDiscountInputOneOf
• AdminPlanPriceRuleInput
• AdminPlanPriceRuleInputBulkPricing
• AdminPlanPriceRuleInputOneOf
• AdminPlanPriceRuleInputOneOf1
• AdminPlanProduct
• AdminPlanProductDiscount
• AdminPlanProductPriceRule
• AdminPlanProductPriceRuleBulkPricing
• AdminPlanProject
• ApiError
• BankCard
• BillingCreditSettings
• BillingCreditSettingsControl
• BillingCreditSettingsUpdate
• BillingCurrencyAmount
• BillingOverview
• BillingOverviewCredit
• BillingOverviewInvoices
• BillingProject
• BillingProjectParentProject
• BillingProjectParentProjectSettings
• BillingProjectPlan
• BillingProjectPlatformChargeType
• BillingProjectSettings
• BillingProjectSettingsDocumentForwarding
• BillingProjectSettingsInvoice
• BillingProjectSettingsInvoiceFooter
• BillingProjectSettingsPlatform
• CreateAdminPlanRequest
• CreateAdminProjectPlanRequest
• CreatePaymentMethodRequest
• CreatePaymentMethodRequestDetails
• CreateSummaryRequest
• CreateTransactionRequest
• CreateTransactionRequestItemsInner
• CreateWalletStatementRequest
• CreateWalletTransactionRequest
• CreditNote
• CreditNoteInvoice
• CreditNoteItem
• CreditNoteItemCreditNote
• CreditNoteItemTransactionItem
• CreditNoteItemVat
• CreditNoteSettlement
• CreditNoteStatus
• CreditNoteStatusEnum
• DocumentForwardingRule
• ExportAdminTransactionsRequest
• ExportInvoiceTransactions202Response
• ExportInvoiceTransactionsRequest
• ExportTransactionsRequest
• FinanceDashboard
• FinanceDashboardClient
• FinanceDashboardClientWeek
• FinanceDashboardMonthToDate
• FinanceDashboardPeriod
• FinanceDashboardThisWeek
• FinanceDashboardWeekTotals
• GetAdminPlanProducts200Response
• GetAdminPlanProjects200Response
• GetAdminPlans200Response
• GetCreditNotes200Response
• GetInvoicePaymentAttempts200Response
• GetInvoices200Response
• GetPaymentMethodVendorSecret200Response
• GetPaymentMethods200Response
• GetPlans200Response
• GetSummaries200Response
• GetTransactions200Response
• GetWalletStatements200Response
• GetWalletTransactions200Response
• GetWallets200Response
• Invoice
• InvoiceMetadata
• InvoiceMetadataCache
• InvoiceMetadataOrder
• InvoiceStatus
• InvoiceStatusEnum
• ListClientProjects200Response
• PaymentAttempt
• PaymentMethod
• PaymentMethodDetails
• PaymentMethodPlatform
• Plan
• PlanProductsInner
• PlanProductsInnerPricing
• Summary
• SummaryVat
• Transaction
• TransactionItem
• UpdateAdminPlanRequest
• UpdateBillingProject400Response
• UpdateBillingProjectRequest
• UpdateBillingProjectRequestDocumentForwarding
• UpdateBillingProjectRequestInvoice
• UpdateBillingProjectRequestInvoiceFooter
• UpdateClientPlanRequest
• UpdateClientPlanRequestProductsInner
• UpdateClientPlanRequestProductsInnerDiscountsInner
• UpdateClientPlanRequestProductsInnerPricing
• UpdateClientProjectRequest
• UpdateClientProjectRequestPlatform
• UpdatePaymentMethodRequest
• UpdateWalletRequest
• UpdateWalletRequestAutoTopup
• Wallet
• WalletAutoTopup
• WalletAutoTopupThreshold
• WalletStatement
• WalletStatementLine
• WalletTransaction

Documentation For Authorization

Authentication schemes defined for the API:

api-key

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

session-oauth

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A