@caraer/client 2.0.413 → 2.0.414

package/docs/AppMeterEventRequest.md

@@ -1,29 +0,0 @@
-# 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

@@ -1,27 +0,0 @@
-# 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

@@ -1,61 +0,0 @@
-# AppPricingDTO
-
-Data transfer object for app pricing (flat or tiered)
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**uuid** | **string** | Unique identifier for the entity | [default to undefined]
-**name** | **string** | The name of the entity | [default to undefined]
-**label** | **string** | Display label for the entity, can be different from name | [optional] [default to undefined]
-**createdAt** | **number** | Unix timestamp when the entity was created | [optional] [default to undefined]
-**createdBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who created the entity | [optional] [default to undefined]
-**updatedAt** | **number** | Unix timestamp when the entity was last updated | [optional] [default to undefined]
-**updatedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who last updated the entity | [optional] [default to undefined]
-**deletedAt** | **number** | Unix timestamp when the entity was deleted (null if not deleted) | [optional] [default to undefined]
-**deletedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who deleted the entity | [optional] [default to undefined]
-**index** | **number** | Index number for ordering entities | [optional] [default to undefined]
-**title** | **string** | Pricing title | [optional] [default to undefined]
-**description** | **string** | Pricing description | [optional] [default to undefined]
-**pricingType** | **string** | Pricing type: TIERED or FLAT | [optional] [default to undefined]
-**pricePerUnit** | **string** | Price per unit (FLAT, e.g. 10.00) | [optional] [default to undefined]
-**unit** | **string** | Unit label (FLAT, e.g. document) | [optional] [default to undefined]
-**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
-
-```typescript
-import { AppPricingDTO } from '@caraer/client';
-
-const instance: AppPricingDTO = {
-    uuid,
-    name,
-    label,
-    createdAt,
-    createdBy,
-    updatedAt,
-    updatedBy,
-    deletedAt,
-    deletedBy,
-    index,
-    title,
-    description,
-    pricingType,
-    pricePerUnit,
-    unit,
-    freeUnits,
-    freeUnitsPeriod,
-    tiers,
-    billingPeriod,
-    commitments,
-    lineItems,
-};
-```
-
-[[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/AppPricingLineItemDTO.md

@@ -1,55 +0,0 @@
-# AppPricingLineItemDTO
-
-Billable line item on an app pricing plan
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**uuid** | **string** | Unique identifier for the entity | [default to undefined]
-**name** | **string** | The name of the entity | [default to undefined]
-**label** | **string** | Display label for the entity, can be different from name | [optional] [default to undefined]
-**createdAt** | **number** | Unix timestamp when the entity was created | [optional] [default to undefined]
-**createdBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who created the entity | [optional] [default to undefined]
-**updatedAt** | **number** | Unix timestamp when the entity was last updated | [optional] [default to undefined]
-**updatedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who last updated the entity | [optional] [default to undefined]
-**deletedAt** | **number** | Unix timestamp when the entity was deleted (null if not deleted) | [optional] [default to undefined]
-**deletedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who deleted the entity | [optional] [default to undefined]
-**index** | **number** | Index number for ordering entities | [optional] [default to undefined]
-**countType** | **string** | Count type: meter or static_query | [optional] [default to undefined]
-**countingSource** | **string** | Event sources for meter line items: WEBHOOK, MANUAL, WEBHOOK_AND_MANUAL | [optional] [default to undefined]
-**unit** | **string** | Unit label (e.g. webhook, document) | [optional] [default to undefined]
-**includedUnits** | **string** | Included units for FLAT line items | [optional] [default to undefined]
-**pricePerUnit** | **string** | Base price covering included units (FLAT) | [optional] [default to undefined]
-**pricePerExtraUnit** | **string** | Price per unit above includedUnits (FLAT) | [optional] [default to undefined]
-**staticQuery** | [**AppStaticQueryDTO**](AppStaticQueryDTO.md) | Scheduled Cypher snapshot for static_query line items | [optional] [default to undefined]
-**tiers** | [**Array<AppTierDTO>**](AppTierDTO.md) | Tiers for TIERED line items | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AppPricingLineItemDTO } from '@caraer/client';
-
-const instance: AppPricingLineItemDTO = {
-    uuid,
-    name,
-    label,
-    createdAt,
-    createdBy,
-    updatedAt,
-    updatedBy,
-    deletedAt,
-    deletedBy,
-    index,
-    countType,
-    countingSource,
-    unit,
-    includedUnits,
-    pricePerUnit,
-    pricePerExtraUnit,
-    staticQuery,
-    tiers,
-};
-```
-
-[[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/AppStaticQueryDTO.md

@@ -1,23 +0,0 @@
-# AppStaticQueryDTO
-
-Read-only Cypher snapshot used by static_query line items
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**schedule** | **string** | When the query runs: period_end (default) or period_start | [optional] [default to undefined]
-**cypher** | **string** | Read-only Cypher that returns count(...) AS count | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AppStaticQueryDTO } from '@caraer/client';
-
-const instance: AppStaticQueryDTO = {
-    schedule,
-    cypher,
-};
-```
-
-[[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/AppSubscriptionChangeRequest.md

@@ -1,23 +0,0 @@
-# AppSubscriptionChangeRequest
-
-Schedule a plan or commitment change
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**targetPlanUuid** | **string** |  | [optional] [default to undefined]
-**targetCommitment** | **string** | MONTHLY or ANNUAL | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AppSubscriptionChangeRequest } from '@caraer/client';
-
-const instance: AppSubscriptionChangeRequest = {
-    targetPlanUuid,
-    targetCommitment,
-};
-```
-
-[[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/AppSubscriptionDTO.md

@@ -1,35 +0,0 @@
-# AppSubscriptionDTO
-
-Current and pending subscription state
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**selectedPricingPlanUuid** | **string** |  | [optional] [default to undefined]
-**billingCommitment** | **string** |  | [optional] [default to undefined]
-**contractStart** | **number** |  | [optional] [default to undefined]
-**contractEnd** | **number** |  | [optional] [default to undefined]
-**pendingPricingPlanUuid** | **string** |  | [optional] [default to undefined]
-**pendingBillingCommitment** | **string** |  | [optional] [default to undefined]
-**pendingEffectiveAt** | **number** |  | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AppSubscriptionDTO } from '@caraer/client';
-
-const instance: AppSubscriptionDTO = {
-    selectedPricingPlanUuid,
-    billingCommitment,
-    contractStart,
-    contractEnd,
-    pendingPricingPlanUuid,
-    pendingBillingCommitment,
-    pendingEffectiveAt,
-    message,
-};
-```
-
-[[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/AppTierDTO.md

@@ -1,49 +0,0 @@
-# AppTierDTO
-
-Data transfer object for a pricing tier (plan) within tiered app pricing
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**uuid** | **string** | Unique identifier for the entity | [default to undefined]
-**name** | **string** | The name of the entity | [default to undefined]
-**label** | **string** | Display label for the entity, can be different from name | [optional] [default to undefined]
-**createdAt** | **number** | Unix timestamp when the entity was created | [optional] [default to undefined]
-**createdBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who created the entity | [optional] [default to undefined]
-**updatedAt** | **number** | Unix timestamp when the entity was last updated | [optional] [default to undefined]
-**updatedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who last updated the entity | [optional] [default to undefined]
-**deletedAt** | **number** | Unix timestamp when the entity was deleted (null if not deleted) | [optional] [default to undefined]
-**deletedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who deleted the entity | [optional] [default to undefined]
-**index** | **number** | Index number for ordering entities | [optional] [default to undefined]
-**startUnits** | **string** | Start of unit range (e.g. 0) | [optional] [default to undefined]
-**endUnits** | **string** | End of unit range (e.g. 1000 or null for unlimited) | [optional] [default to undefined]
-**pricePerMonth** | **string** | Price per month (e.g. 10.00) | [optional] [default to undefined]
-**pricePerYear** | **string** | Price per year (e.g. 100.00) | [optional] [default to undefined]
-**pricePerExtraUnit** | **string** | Price per extra unit beyond tier (e.g. 0.01, typically for last tier) | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AppTierDTO } from '@caraer/client';
-
-const instance: AppTierDTO = {
-    uuid,
-    name,
-    label,
-    createdAt,
-    createdBy,
-    updatedAt,
-    updatedBy,
-    deletedAt,
-    deletedBy,
-    index,
-    startUnits,
-    endUnits,
-    pricePerMonth,
-    pricePerYear,
-    pricePerExtraUnit,
-};
-```
-
-[[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/ShowResponseAppBillingStatusResponse.md

@@ -1,23 +0,0 @@
-# ShowResponseAppBillingStatusResponse
-
-Represents the response for viewing or showing a specific resource.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
-**data** | [**AppBillingStatusResponse**](AppBillingStatusResponse.md) | The data payload of the response, if any. | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShowResponseAppBillingStatusResponse } from '@caraer/client';
-
-const instance: ShowResponseAppBillingStatusResponse = {
-    message,
-    data,
-};
-```
-
-[[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/ShowResponseAppInstallationBillingStatusDTO.md

@@ -1,23 +0,0 @@
-# ShowResponseAppInstallationBillingStatusDTO
-
-Represents the response for viewing or showing a specific resource.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
-**data** | [**AppInstallationBillingStatusDTO**](AppInstallationBillingStatusDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShowResponseAppInstallationBillingStatusDTO } from '@caraer/client';
-
-const instance: ShowResponseAppInstallationBillingStatusDTO = {
-    message,
-    data,
-};
-```
-
-[[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/ShowResponseAppMeterEventResponse.md

@@ -1,23 +0,0 @@
-# ShowResponseAppMeterEventResponse
-
-Represents the response for viewing or showing a specific resource.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
-**data** | [**AppMeterEventResponse**](AppMeterEventResponse.md) | The data payload of the response, if any. | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShowResponseAppMeterEventResponse } from '@caraer/client';
-
-const instance: ShowResponseAppMeterEventResponse = {
-    message,
-    data,
-};
-```
-
-[[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/ShowResponseAppSubscriptionDTO.md

@@ -1,23 +0,0 @@
-# ShowResponseAppSubscriptionDTO
-
-Represents the response for viewing or showing a specific resource.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
-**data** | [**AppSubscriptionDTO**](AppSubscriptionDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShowResponseAppSubscriptionDTO } from '@caraer/client';
-
-const instance: ShowResponseAppSubscriptionDTO = {
-    message,
-    data,
-};
-```
-
-[[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/ShowResponseListAppInstallationBillingStatusDTO.md

@@ -1,23 +0,0 @@
-# ShowResponseListAppInstallationBillingStatusDTO
-
-Represents the response for viewing or showing a specific resource.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
-**data** | [**Array<AppInstallationBillingStatusDTO>**](AppInstallationBillingStatusDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShowResponseListAppInstallationBillingStatusDTO } from '@caraer/client';
-
-const instance: ShowResponseListAppInstallationBillingStatusDTO = {
-    message,
-    data,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)