@caraer/client 2.0.408 → 2.0.410

package/docs/AppBillingApi.md

@@ -0,0 +1,429 @@
+# AppBillingApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**appBillingStatus**](#appbillingstatus) | **GET** /api/v2/apps/{appUuid}/billing/status | Current-period billing for every installation of an app|
+|[**cancelPendingChange**](#cancelpendingchange) | **DELETE** /api/v2/apps/{appUuid}/installation/subscription/pending | Cancel a scheduled subscription change|
+|[**getSubscription**](#getsubscription) | **GET** /api/v2/apps/{appUuid}/installation/subscription | Current subscription state for the selected company\'s installation|
+|[**installationBillingStatus**](#installationbillingstatus) | **GET** /api/v2/apps/{appUuid}/installation/billing/status | Current-period billing for the selected company\'s installation|
+|[**platformBillingStatus**](#platformbillingstatus) | **GET** /api/v2/apps/billing/status | Platform-wide current-period app usage billing|
+|[**recordMeterEvent**](#recordmeterevent) | **POST** /api/v2/apps/{appUuid}/installation/meter-events | Record a manual meter event for the selected company\'s installation|
+|[**scheduleSubscriptionChange**](#schedulesubscriptionchange) | **POST** /api/v2/apps/{appUuid}/installation/subscription/change | Schedule a plan or commitment change|
+|[**usagePeriods**](#usageperiods) | **GET** /api/v2/apps/{appUuid}/installation/usage/periods | Usage periods for the selected company\'s installation|
+
+# **appBillingStatus**
+> ShowResponseAppBillingStatusResponse appBillingStatus()
+
+
+### Example
+
+```typescript
+import {
+    AppBillingApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new AppBillingApi(configuration);
+
+let appUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.appBillingStatus(
+    appUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseAppBillingStatusResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **cancelPendingChange**
+> ShowResponseAppSubscriptionDTO cancelPendingChange()
+
+
+### Example
+
+```typescript
+import {
+    AppBillingApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new AppBillingApi(configuration);
+
+let appUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.cancelPendingChange(
+    appUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseAppSubscriptionDTO**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getSubscription**
+> ShowResponseAppSubscriptionDTO getSubscription()
+
+
+### Example
+
+```typescript
+import {
+    AppBillingApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new AppBillingApi(configuration);
+
+let appUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getSubscription(
+    appUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseAppSubscriptionDTO**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **installationBillingStatus**
+> ShowResponseAppInstallationBillingStatusDTO installationBillingStatus()
+
+
+### Example
+
+```typescript
+import {
+    AppBillingApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new AppBillingApi(configuration);
+
+let appUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.installationBillingStatus(
+    appUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseAppInstallationBillingStatusDTO**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **platformBillingStatus**
+> ShowResponseAppBillingStatusResponse platformBillingStatus()
+
+
+### Example
+
+```typescript
+import {
+    AppBillingApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new AppBillingApi(configuration);
+
+let appUuid: string; // (optional) (default to undefined)
+let page: number; // (optional) (default to 1)
+let limit: number; // (optional) (default to 50)
+
+const { status, data } = await apiInstance.platformBillingStatus(
+    appUuid,
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appUuid** | [**string**] |  | (optional) defaults to undefined|
+| **page** | [**number**] |  | (optional) defaults to 1|
+| **limit** | [**number**] |  | (optional) defaults to 50|
+
+
+### Return type
+
+**ShowResponseAppBillingStatusResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **recordMeterEvent**
+> ShowResponseAppMeterEventResponse recordMeterEvent(appMeterEventRequest)
+
+
+### Example
+
+```typescript
+import {
+    AppBillingApi,
+    Configuration,
+    AppMeterEventRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new AppBillingApi(configuration);
+
+let appUuid: string; // (default to undefined)
+let appMeterEventRequest: AppMeterEventRequest; //
+
+const { status, data } = await apiInstance.recordMeterEvent(
+    appUuid,
+    appMeterEventRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appMeterEventRequest** | **AppMeterEventRequest**|  | |
+| **appUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseAppMeterEventResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **scheduleSubscriptionChange**
+> ShowResponseAppSubscriptionDTO scheduleSubscriptionChange(appSubscriptionChangeRequest)
+
+
+### Example
+
+```typescript
+import {
+    AppBillingApi,
+    Configuration,
+    AppSubscriptionChangeRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new AppBillingApi(configuration);
+
+let appUuid: string; // (default to undefined)
+let appSubscriptionChangeRequest: AppSubscriptionChangeRequest; //
+
+const { status, data } = await apiInstance.scheduleSubscriptionChange(
+    appUuid,
+    appSubscriptionChangeRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appSubscriptionChangeRequest** | **AppSubscriptionChangeRequest**|  | |
+| **appUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseAppSubscriptionDTO**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **usagePeriods**
+> ShowResponseListAppInstallationBillingStatusDTO usagePeriods()
+
+
+### Example
+
+```typescript
+import {
+    AppBillingApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new AppBillingApi(configuration);
+
+let appUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.usagePeriods(
+    appUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseListAppInstallationBillingStatusDTO**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/AppBillingLineItemStatusDTO.md

@@ -0,0 +1,41 @@
+# AppBillingLineItemStatusDTO
+
+Current-period usage for one pricing line item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**countType** | **string** |  | [optional] [default to undefined]
+**countingSource** | **string** |  | [optional] [default to undefined]
+**usage** | **number** |  | [optional] [default to undefined]
+**usageBreakdown** | **{ [key: string]: number; }** |  | [optional] [default to undefined]
+**includedUnits** | **number** |  | [optional] [default to undefined]
+**overageUnits** | **number** |  | [optional] [default to undefined]
+**projectedCharge** | **number** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**note** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppBillingLineItemStatusDTO } from '@caraer/client';
+
+const instance: AppBillingLineItemStatusDTO = {
+    name,
+    label,
+    countType,
+    countingSource,
+    usage,
+    usageBreakdown,
+    includedUnits,
+    overageUnits,
+    projectedCharge,
+    status,
+    note,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AppBillingPeriodDTO.md

@@ -0,0 +1,33 @@
+# AppBillingPeriodDTO
+
+UTC calendar-month billing window, with pro-rata fields when the subscription started mid-month
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start** | **string** |  | [optional] [default to undefined]
+**end** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**activeStart** | **string** |  | [optional] [default to undefined]
+**daysActive** | **number** |  | [optional] [default to undefined]
+**daysInPeriod** | **number** |  | [optional] [default to undefined]
+**prorationFactor** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppBillingPeriodDTO } from '@caraer/client';
+
+const instance: AppBillingPeriodDTO = {
+    start,
+    end,
+    status,
+    activeStart,
+    daysActive,
+    daysInPeriod,
+    prorationFactor,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AppBillingStatusResponse.md

@@ -0,0 +1,29 @@
+# AppBillingStatusResponse
+
+Billing status for one or more app installations
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**appUuid** | **string** |  | [optional] [default to undefined]
+**appName** | **string** |  | [optional] [default to undefined]
+**period** | [**AppBillingPeriodDTO**](AppBillingPeriodDTO.md) |  | [optional] [default to undefined]
+**installations** | [**Array<AppInstallationBillingStatusDTO>**](AppInstallationBillingStatusDTO.md) |  | [optional] [default to undefined]
+**summary** | [**AppBillingSummaryDTO**](AppBillingSummaryDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppBillingStatusResponse } from '@caraer/client';
+
+const instance: AppBillingStatusResponse = {
+    appUuid,
+    appName,
+    period,
+    installations,
+    summary,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AppBillingSummaryDTO.md

@@ -0,0 +1,23 @@
+# AppBillingSummaryDTO
+
+Rollup of installation billing status
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**installationCount** | **number** |  | [optional] [default to undefined]
+**projectedRevenueTotal** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppBillingSummaryDTO } from '@caraer/client';
+
+const instance: AppBillingSummaryDTO = {
+    installationCount,
+    projectedRevenueTotal,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AppInstallationBillingStatusDTO.md

@@ -0,0 +1,49 @@
+# AppInstallationBillingStatusDTO
+
+Current-period billing status for one installation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**appUuid** | **string** |  | [optional] [default to undefined]
+**appName** | **string** |  | [optional] [default to undefined]
+**installationUuid** | **string** |  | [optional] [default to undefined]
+**companyUuid** | **string** |  | [optional] [default to undefined]
+**companyName** | **string** |  | [optional] [default to undefined]
+**selectedPricingPlanUuid** | **string** |  | [optional] [default to undefined]
+**selectedPricingPlanTitle** | **string** |  | [optional] [default to undefined]
+**pricingType** | **string** |  | [optional] [default to undefined]
+**billingCommitment** | **string** |  | [optional] [default to undefined]
+**pendingPricingPlanUuid** | **string** |  | [optional] [default to undefined]
+**pendingEffectiveAt** | **number** |  | [optional] [default to undefined]
+**period** | [**AppBillingPeriodDTO**](AppBillingPeriodDTO.md) |  | [optional] [default to undefined]
+**lineItems** | [**Array<AppBillingLineItemStatusDTO>**](AppBillingLineItemStatusDTO.md) |  | [optional] [default to undefined]
+**projectedTotal** | **number** |  | [optional] [default to undefined]
+**subscription** | [**AppSubscriptionDTO**](AppSubscriptionDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppInstallationBillingStatusDTO } from '@caraer/client';
+
+const instance: AppInstallationBillingStatusDTO = {
+    appUuid,
+    appName,
+    installationUuid,
+    companyUuid,
+    companyName,
+    selectedPricingPlanUuid,
+    selectedPricingPlanTitle,
+    pricingType,
+    billingCommitment,
+    pendingPricingPlanUuid,
+    pendingEffectiveAt,
+    period,
+    lineItems,
+    projectedTotal,
+    subscription,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AppMeterEventRequest.md

@@ -0,0 +1,29 @@
+# AppMeterEventRequest
+
+Manual meter event for a billable line item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**lineItemName** | **string** |  | [default to undefined]
+**quantity** | **number** | Positive unit count; defaults to 1 | [optional] [default to undefined]
+**idempotencyKey** | **string** |  | [optional] [default to undefined]
+**occurredAt** | **string** | ISO-8601 timestamp; defaults to now | [optional] [default to undefined]
+**metadata** | **{ [key: string]: any | null; }** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppMeterEventRequest } from '@caraer/client';
+
+const instance: AppMeterEventRequest = {
+    lineItemName,
+    quantity,
+    idempotencyKey,
+    occurredAt,
+    metadata,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AppMeterEventResponse.md

@@ -0,0 +1,27 @@
+# AppMeterEventResponse
+
+Recorded meter event
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**eventUuid** | **string** |  | [optional] [default to undefined]
+**lineItemName** | **string** |  | [optional] [default to undefined]
+**quantity** | **number** |  | [optional] [default to undefined]
+**periodUsageAfter** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppMeterEventResponse } from '@caraer/client';
+
+const instance: AppMeterEventResponse = {
+    eventUuid,
+    lineItemName,
+    quantity,
+    periodUsageAfter,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AppPricingDTO.md

@@ -24,6 +24,9 @@ Name | Type | Description | Notes
 **freeUnits** | **string** | Free units included (FLAT, e.g. 100) | [optional] [default to undefined]
 **freeUnitsPeriod** | **string** | Free units period (FLAT, e.g. month) | [optional] [default to undefined]
 **tiers** | [**Array<AppTierDTO>**](AppTierDTO.md) | Tiers for tiered pricing (TIERED) | [optional] [default to undefined]
+**billingPeriod** | **string** | Billing period for usage aggregation (default month) | [optional] [default to undefined]
+**commitments** | **Array<string>** | Allowed billing commitments: MONTHLY and/or ANNUAL | [optional] [default to undefined]
+**lineItems** | [**Array<AppPricingLineItemDTO>**](AppPricingLineItemDTO.md) | Billable line items (meters and/or static queries) | [optional] [default to undefined]
 
 ## Example
 
@@ -49,6 +52,9 @@ const instance: AppPricingDTO = {
     freeUnits,
     freeUnitsPeriod,
     tiers,
+    billingPeriod,
+    commitments,
+    lineItems,
 };
 ```