@caraer/client 2.0.408 → 2.0.410

package/docs/AppPricingLineItemDTO.md

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

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

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

@@ -0,0 +1,35 @@
+# 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/HasAppDTO.md

@@ -15,6 +15,12 @@ Name | Type | Description | Notes
 **oauthConnected** | **boolean** | Whether OAuth tokens have been issued for this installation | [optional] [default to undefined]
 **oauthAccessTokenExpiresAt** | **number** | OAuth access token expiry (epoch ms), if connected via OAuth | [optional] [default to undefined]
 **selectedPricingPlanUuid** | **string** | UUID of the pricing plan selected for this installation | [optional] [default to undefined]
+**billingCommitment** | **string** | MONTHLY or ANNUAL billing commitment | [optional] [default to undefined]
+**contractStart** | **number** | Current contract start (epoch ms) | [optional] [default to undefined]
+**contractEnd** | **number** | Current contract end / renewal date (epoch ms) | [optional] [default to undefined]
+**pendingPricingPlanUuid** | **string** | Plan scheduled to become active | [optional] [default to undefined]
+**pendingBillingCommitment** | **string** | Commitment scheduled to become active | [optional] [default to undefined]
+**pendingEffectiveAt** | **number** | When the pending subscription change takes effect (epoch ms) | [optional] [default to undefined]
 
 ## Example
 
@@ -31,6 +37,12 @@ const instance: HasAppDTO = {
     oauthConnected,
     oauthAccessTokenExpiresAt,
     selectedPricingPlanUuid,
+    billingCommitment,
+    contractStart,
+    contractEnd,
+    pendingPricingPlanUuid,
+    pendingBillingCommitment,
+    pendingEffectiveAt,
 };
 ```
 

package/docs/ShowResponseAppBillingStatusResponse.md

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

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

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

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caraer/client",
-  "version": "2.0.408",
+  "version": "2.0.410",
   "description": "Generated TypeScript client for the Caraer API",
   "author": "OpenAPI-Generator Contributors",
   "repository": {