@randock/[email protected]

A TypeScript SDK client for the localhost API.

Usage

First, install the SDK from npm.

npm install @randock/cv-subscription-api-client --save

Next, try it out.

import {
  Configuration,
  CustomerApi,
} from '@randock/cv-subscription-api-client';
import type { ListRequest } from '@randock/cv-subscription-api-client';

async function example() {
  console.log("🚀 Testing @randock/cv-subscription-api-client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new CustomerApi(config);

  const body = {
    // number (optional)
    limit: 8.14,
    // Array<SortDto> (optional)
    sort: ...,
    // string | Partially supports LQL (Liqe query language) (optional)
    filter: filter_example,
    // string | Search query (optional)
    search: search_example,
    // string (optional)
    cursor: cursor_example,
  } satisfies ListRequest;

  try {
    const data = await api.list(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to http://localhost

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- CustomerApi | list | GET /customers | SubscriptionApi | cancelSubscription | POST /subscriptions/{subscriptionId}/cancel | SubscriptionApi | createManualBill | POST /subscriptions/{subscriptionId}/bills | SubscriptionApi | get | GET /subscriptions/{subscriptionId} | SubscriptionApi | getBill | GET /subscriptions/{subscriptionId}/bills/{billId} | SubscriptionApi | getByExternalId | GET /subscriptions/by-external-id/{externalId} | SubscriptionApi | getPaymentMethods | GET /subscriptions/{subscriptionId}/payment-methods | SubscriptionApi | getTransaction | GET /subscriptions/{subscriptionId}/bills/{billId}/transactions/{transactionId} | SubscriptionApi | getTransactionBalanceChange | GET /subscriptions/{subscriptionId}/bills/{billId}/transactions/{transactionId}/balance-change/{balanceChangeId} | SubscriptionApi | initializePayment | POST /subscriptions/{subscriptionId}/initialize-payment | SubscriptionApi | list | GET /subscriptions | SubscriptionApi | listBillTransactions | GET /subscriptions/{subscriptionId}/bills/{billId}/transactions | SubscriptionApi | listBills | GET /subscriptions/{subscriptionId}/bills | SubscriptionApi | listTransactionBalanceChanges | GET /subscriptions/{subscriptionId}/bills/{billId}/transactions/{transactionId}/balance-change | SubscriptionApi | removeCancellation | DELETE /subscriptions/{subscriptionId}/cancel | SubscriptionApi | start | POST /subscriptions/start | SubscriptionPlanApi | list | GET /subscription-plans | SubscriptionPlanApi | listPrices | GET /subscription-plans/{subscriptionPlanId}/prices | SvixAppPortalApi | svixAppPortalControllerGetAppPortal | GET /svix/portal |

Models

• AggregatedPaginationResponse
• CancelSubscriptionInput
• CreateManualBillInput
• CreateManualBillResponse
• CursorBasedPageInfo
• CursorBasedPaginationResponse
• CustomerDto
• GetPaymentMethodsForSubscriptionResponse
• GetSubscriptionBillResponse
• GetTransactionBalanceChangeResponse
• GetTransactionResponse
• InitializePaymentInput
• InitializePaymentResponse
• List200Response
• List200Response1
• List200Response2
• ListBillTransactionResponse
• ListBillTransactions200Response
• ListBills200Response
• ListCustomerResponse
• ListPrices200Response
• ListSubscriptionBillResponse
• ListSubscriptionPlanPricePricingResponse
• ListSubscriptionPlanPriceResponse
• ListSubscriptionPlanResponse
• ListSubscriptionPlanResponseSettings
• ListSubscriptionPricingResponse
• ListSubscriptionPricingResponseBillingPeriod
• ListSubscriptionPricingResponseSetupFee
• ListSubscriptionResponse
• ListTransactionBalanceChangeResponse
• ListTransactionBalanceChanges200Response
• MoneyInput
• PageBasedPageInfo
• PageBasedPaginationResponse
• PaymentMethodItem
• PricingInput
• SortDto
• StartSubscriptionInput
• StartSubscriptionInputInput
• StartSubscriptionResponse
• StartSubscriptionWithCustomPricingInput
• StartSubscriptionWithPlanPricingInput
• SubscriptionBillTaxResponse
• SubscriptionDetailPricingResponse
• SubscriptionDetailResponse
• TaxLocationInput
• TimePeriodInput

Authorization

Authentication schemes defined for the API:

api-key

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.0
• Generator version: 7.17.0
• Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

• Environments
  • Node.js
  • Webpack
  • Browserify
• Language levels
  • ES5 - you must have a Promises/A+ library installed
  • ES6
• Module systems
  • CommonJS
  • ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License