@caraer/client 2.0.407 → 2.0.410
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +17 -0
- package/api.ts +948 -2
- package/dist/api.d.ts +602 -2
- package/dist/api.js +617 -3
- package/dist/esm/api.d.ts +602 -2
- package/dist/esm/api.js +610 -0
- package/docs/AppBillingApi.md +429 -0
- package/docs/AppBillingLineItemStatusDTO.md +41 -0
- package/docs/AppBillingPeriodDTO.md +33 -0
- package/docs/AppBillingStatusResponse.md +29 -0
- package/docs/AppBillingSummaryDTO.md +23 -0
- package/docs/AppInstallationBillingStatusDTO.md +49 -0
- package/docs/AppMeterEventRequest.md +29 -0
- package/docs/AppMeterEventResponse.md +27 -0
- package/docs/AppPricingDTO.md +6 -0
- package/docs/AppPricingLineItemDTO.md +55 -0
- package/docs/AppStaticQueryDTO.md +23 -0
- package/docs/AppSubscriptionChangeRequest.md +23 -0
- package/docs/AppSubscriptionDTO.md +35 -0
- package/docs/ExistingWidgetSummary.md +2 -2
- package/docs/HasAppDTO.md +12 -0
- package/docs/Record.md +2 -2
- package/docs/ShowResponseAppBillingStatusResponse.md +23 -0
- package/docs/ShowResponseAppInstallationBillingStatusDTO.md +23 -0
- package/docs/ShowResponseAppMeterEventResponse.md +23 -0
- package/docs/ShowResponseAppSubscriptionDTO.md +23 -0
- package/docs/ShowResponseListAppInstallationBillingStatusDTO.md +23 -0
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -385,6 +385,53 @@ export interface AppBarVisibilityEntry {
|
|
|
385
385
|
'objects'?: Array<string>;
|
|
386
386
|
'suites'?: Array<string>;
|
|
387
387
|
}
|
|
388
|
+
/**
|
|
389
|
+
* Current-period usage for one pricing line item
|
|
390
|
+
*/
|
|
391
|
+
export interface AppBillingLineItemStatusDTO {
|
|
392
|
+
'name'?: string;
|
|
393
|
+
'label'?: string;
|
|
394
|
+
'countType'?: string;
|
|
395
|
+
'countingSource'?: string;
|
|
396
|
+
'usage'?: number;
|
|
397
|
+
'usageBreakdown'?: {
|
|
398
|
+
[key: string]: number;
|
|
399
|
+
};
|
|
400
|
+
'includedUnits'?: number;
|
|
401
|
+
'overageUnits'?: number;
|
|
402
|
+
'projectedCharge'?: number;
|
|
403
|
+
'status'?: string;
|
|
404
|
+
'note'?: string;
|
|
405
|
+
}
|
|
406
|
+
/**
|
|
407
|
+
* UTC calendar-month billing window, with pro-rata fields when the subscription started mid-month
|
|
408
|
+
*/
|
|
409
|
+
export interface AppBillingPeriodDTO {
|
|
410
|
+
'start'?: string;
|
|
411
|
+
'end'?: string;
|
|
412
|
+
'status'?: string;
|
|
413
|
+
'activeStart'?: string;
|
|
414
|
+
'daysActive'?: number;
|
|
415
|
+
'daysInPeriod'?: number;
|
|
416
|
+
'prorationFactor'?: number;
|
|
417
|
+
}
|
|
418
|
+
/**
|
|
419
|
+
* Billing status for one or more app installations
|
|
420
|
+
*/
|
|
421
|
+
export interface AppBillingStatusResponse {
|
|
422
|
+
'appUuid'?: string;
|
|
423
|
+
'appName'?: string;
|
|
424
|
+
'period'?: AppBillingPeriodDTO;
|
|
425
|
+
'installations'?: Array<AppInstallationBillingStatusDTO>;
|
|
426
|
+
'summary'?: AppBillingSummaryDTO;
|
|
427
|
+
}
|
|
428
|
+
/**
|
|
429
|
+
* Rollup of installation billing status
|
|
430
|
+
*/
|
|
431
|
+
export interface AppBillingSummaryDTO {
|
|
432
|
+
'installationCount'?: number;
|
|
433
|
+
'projectedRevenueTotal'?: number;
|
|
434
|
+
}
|
|
388
435
|
export interface AppConnectionStatusDTO {
|
|
389
436
|
'id'?: string;
|
|
390
437
|
'name'?: string;
|
|
@@ -804,6 +851,53 @@ export interface AppInboundRouteDTO {
|
|
|
804
851
|
'sharedSecret'?: string;
|
|
805
852
|
'serverlessFunction'?: ServerlessFunctionRefDTO;
|
|
806
853
|
}
|
|
854
|
+
/**
|
|
855
|
+
* Current-period billing status for one installation
|
|
856
|
+
*/
|
|
857
|
+
export interface AppInstallationBillingStatusDTO {
|
|
858
|
+
'appUuid'?: string;
|
|
859
|
+
'appName'?: string;
|
|
860
|
+
'installationUuid'?: string;
|
|
861
|
+
'companyUuid'?: string;
|
|
862
|
+
'companyName'?: string;
|
|
863
|
+
'selectedPricingPlanUuid'?: string;
|
|
864
|
+
'selectedPricingPlanTitle'?: string;
|
|
865
|
+
'pricingType'?: string;
|
|
866
|
+
'billingCommitment'?: string;
|
|
867
|
+
'pendingPricingPlanUuid'?: string;
|
|
868
|
+
'pendingEffectiveAt'?: number;
|
|
869
|
+
'period'?: AppBillingPeriodDTO;
|
|
870
|
+
'lineItems'?: Array<AppBillingLineItemStatusDTO>;
|
|
871
|
+
'projectedTotal'?: number;
|
|
872
|
+
'subscription'?: AppSubscriptionDTO;
|
|
873
|
+
}
|
|
874
|
+
/**
|
|
875
|
+
* Manual meter event for a billable line item
|
|
876
|
+
*/
|
|
877
|
+
export interface AppMeterEventRequest {
|
|
878
|
+
'lineItemName': string;
|
|
879
|
+
/**
|
|
880
|
+
* Positive unit count; defaults to 1
|
|
881
|
+
*/
|
|
882
|
+
'quantity'?: number;
|
|
883
|
+
'idempotencyKey'?: string;
|
|
884
|
+
/**
|
|
885
|
+
* ISO-8601 timestamp; defaults to now
|
|
886
|
+
*/
|
|
887
|
+
'occurredAt'?: string;
|
|
888
|
+
'metadata'?: {
|
|
889
|
+
[key: string]: any | null;
|
|
890
|
+
};
|
|
891
|
+
}
|
|
892
|
+
/**
|
|
893
|
+
* Recorded meter event
|
|
894
|
+
*/
|
|
895
|
+
export interface AppMeterEventResponse {
|
|
896
|
+
'eventUuid'?: string;
|
|
897
|
+
'lineItemName'?: string;
|
|
898
|
+
'quantity'?: number;
|
|
899
|
+
'periodUsageAfter'?: number;
|
|
900
|
+
}
|
|
807
901
|
export interface AppOAuthStartResponseDTO {
|
|
808
902
|
'authorizeUrl'?: string;
|
|
809
903
|
}
|
|
@@ -883,6 +977,95 @@ export interface AppPricingDTO {
|
|
|
883
977
|
* Tiers for tiered pricing (TIERED)
|
|
884
978
|
*/
|
|
885
979
|
'tiers'?: Array<AppTierDTO>;
|
|
980
|
+
/**
|
|
981
|
+
* Billing period for usage aggregation (default month)
|
|
982
|
+
*/
|
|
983
|
+
'billingPeriod'?: string;
|
|
984
|
+
/**
|
|
985
|
+
* Allowed billing commitments: MONTHLY and/or ANNUAL
|
|
986
|
+
*/
|
|
987
|
+
'commitments'?: Array<string>;
|
|
988
|
+
/**
|
|
989
|
+
* Billable line items (meters and/or static queries)
|
|
990
|
+
*/
|
|
991
|
+
'lineItems'?: Array<AppPricingLineItemDTO>;
|
|
992
|
+
}
|
|
993
|
+
/**
|
|
994
|
+
* Billable line item on an app pricing plan
|
|
995
|
+
*/
|
|
996
|
+
export interface AppPricingLineItemDTO {
|
|
997
|
+
/**
|
|
998
|
+
* Unique identifier for the entity
|
|
999
|
+
*/
|
|
1000
|
+
'uuid': string;
|
|
1001
|
+
/**
|
|
1002
|
+
* The name of the entity
|
|
1003
|
+
*/
|
|
1004
|
+
'name': string;
|
|
1005
|
+
/**
|
|
1006
|
+
* Display label for the entity, can be different from name
|
|
1007
|
+
*/
|
|
1008
|
+
'label'?: string;
|
|
1009
|
+
/**
|
|
1010
|
+
* Unix timestamp when the entity was created
|
|
1011
|
+
*/
|
|
1012
|
+
'createdAt'?: number;
|
|
1013
|
+
/**
|
|
1014
|
+
* Identifier of the user who created the entity
|
|
1015
|
+
*/
|
|
1016
|
+
'createdBy'?: ModelRecord;
|
|
1017
|
+
/**
|
|
1018
|
+
* Unix timestamp when the entity was last updated
|
|
1019
|
+
*/
|
|
1020
|
+
'updatedAt'?: number;
|
|
1021
|
+
/**
|
|
1022
|
+
* Identifier of the user who last updated the entity
|
|
1023
|
+
*/
|
|
1024
|
+
'updatedBy'?: ModelRecord;
|
|
1025
|
+
/**
|
|
1026
|
+
* Unix timestamp when the entity was deleted (null if not deleted)
|
|
1027
|
+
*/
|
|
1028
|
+
'deletedAt'?: number;
|
|
1029
|
+
/**
|
|
1030
|
+
* Identifier of the user who deleted the entity
|
|
1031
|
+
*/
|
|
1032
|
+
'deletedBy'?: ModelRecord;
|
|
1033
|
+
/**
|
|
1034
|
+
* Index number for ordering entities
|
|
1035
|
+
*/
|
|
1036
|
+
'index'?: number;
|
|
1037
|
+
/**
|
|
1038
|
+
* Count type: meter or static_query
|
|
1039
|
+
*/
|
|
1040
|
+
'countType'?: string;
|
|
1041
|
+
/**
|
|
1042
|
+
* Event sources for meter line items: WEBHOOK, MANUAL, WEBHOOK_AND_MANUAL
|
|
1043
|
+
*/
|
|
1044
|
+
'countingSource'?: string;
|
|
1045
|
+
/**
|
|
1046
|
+
* Unit label (e.g. webhook, document)
|
|
1047
|
+
*/
|
|
1048
|
+
'unit'?: string;
|
|
1049
|
+
/**
|
|
1050
|
+
* Included units for FLAT line items
|
|
1051
|
+
*/
|
|
1052
|
+
'includedUnits'?: string;
|
|
1053
|
+
/**
|
|
1054
|
+
* Base price covering included units (FLAT)
|
|
1055
|
+
*/
|
|
1056
|
+
'pricePerUnit'?: string;
|
|
1057
|
+
/**
|
|
1058
|
+
* Price per unit above includedUnits (FLAT)
|
|
1059
|
+
*/
|
|
1060
|
+
'pricePerExtraUnit'?: string;
|
|
1061
|
+
/**
|
|
1062
|
+
* Scheduled Cypher snapshot for static_query line items
|
|
1063
|
+
*/
|
|
1064
|
+
'staticQuery'?: AppStaticQueryDTO;
|
|
1065
|
+
/**
|
|
1066
|
+
* Tiers for TIERED line items
|
|
1067
|
+
*/
|
|
1068
|
+
'tiers'?: Array<AppTierDTO>;
|
|
886
1069
|
}
|
|
887
1070
|
/**
|
|
888
1071
|
* Publish and review state for a public app in the marketplace
|
|
@@ -1058,6 +1241,42 @@ export interface AppSettingsSection {
|
|
|
1058
1241
|
'subtitle'?: string;
|
|
1059
1242
|
'settings'?: Array<string>;
|
|
1060
1243
|
}
|
|
1244
|
+
/**
|
|
1245
|
+
* Read-only Cypher snapshot used by static_query line items
|
|
1246
|
+
*/
|
|
1247
|
+
export interface AppStaticQueryDTO {
|
|
1248
|
+
/**
|
|
1249
|
+
* When the query runs: period_end (default) or period_start
|
|
1250
|
+
*/
|
|
1251
|
+
'schedule'?: string;
|
|
1252
|
+
/**
|
|
1253
|
+
* Read-only Cypher that returns count(...) AS count
|
|
1254
|
+
*/
|
|
1255
|
+
'cypher'?: string;
|
|
1256
|
+
}
|
|
1257
|
+
/**
|
|
1258
|
+
* Schedule a plan or commitment change
|
|
1259
|
+
*/
|
|
1260
|
+
export interface AppSubscriptionChangeRequest {
|
|
1261
|
+
'targetPlanUuid'?: string;
|
|
1262
|
+
/**
|
|
1263
|
+
* MONTHLY or ANNUAL
|
|
1264
|
+
*/
|
|
1265
|
+
'targetCommitment'?: string;
|
|
1266
|
+
}
|
|
1267
|
+
/**
|
|
1268
|
+
* Current and pending subscription state
|
|
1269
|
+
*/
|
|
1270
|
+
export interface AppSubscriptionDTO {
|
|
1271
|
+
'selectedPricingPlanUuid'?: string;
|
|
1272
|
+
'billingCommitment'?: string;
|
|
1273
|
+
'contractStart'?: number;
|
|
1274
|
+
'contractEnd'?: number;
|
|
1275
|
+
'pendingPricingPlanUuid'?: string;
|
|
1276
|
+
'pendingBillingCommitment'?: string;
|
|
1277
|
+
'pendingEffectiveAt'?: number;
|
|
1278
|
+
'message'?: string;
|
|
1279
|
+
}
|
|
1061
1280
|
/**
|
|
1062
1281
|
* Data transfer object for a pricing tier (plan) within tiered app pricing
|
|
1063
1282
|
*/
|
|
@@ -2215,9 +2434,9 @@ export declare const EventRsvpRequestScopeEnum: {
|
|
|
2215
2434
|
};
|
|
2216
2435
|
export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
|
|
2217
2436
|
export interface ExistingWidgetSummary {
|
|
2218
|
-
'yproperty'?: string;
|
|
2219
2437
|
'xproperty'?: string;
|
|
2220
2438
|
'ymetric'?: string;
|
|
2439
|
+
'yproperty'?: string;
|
|
2221
2440
|
'title'?: string;
|
|
2222
2441
|
'chartType'?: string;
|
|
2223
2442
|
'xProperty'?: string;
|
|
@@ -2743,6 +2962,30 @@ export interface HasAppDTO {
|
|
|
2743
2962
|
* UUID of the pricing plan selected for this installation
|
|
2744
2963
|
*/
|
|
2745
2964
|
'selectedPricingPlanUuid'?: string;
|
|
2965
|
+
/**
|
|
2966
|
+
* MONTHLY or ANNUAL billing commitment
|
|
2967
|
+
*/
|
|
2968
|
+
'billingCommitment'?: string;
|
|
2969
|
+
/**
|
|
2970
|
+
* Current contract start (epoch ms)
|
|
2971
|
+
*/
|
|
2972
|
+
'contractStart'?: number;
|
|
2973
|
+
/**
|
|
2974
|
+
* Current contract end / renewal date (epoch ms)
|
|
2975
|
+
*/
|
|
2976
|
+
'contractEnd'?: number;
|
|
2977
|
+
/**
|
|
2978
|
+
* Plan scheduled to become active
|
|
2979
|
+
*/
|
|
2980
|
+
'pendingPricingPlanUuid'?: string;
|
|
2981
|
+
/**
|
|
2982
|
+
* Commitment scheduled to become active
|
|
2983
|
+
*/
|
|
2984
|
+
'pendingBillingCommitment'?: string;
|
|
2985
|
+
/**
|
|
2986
|
+
* When the pending subscription change takes effect (epoch ms)
|
|
2987
|
+
*/
|
|
2988
|
+
'pendingEffectiveAt'?: number;
|
|
2746
2989
|
}
|
|
2747
2990
|
/**
|
|
2748
2991
|
* Optional initial configuration settings
|
|
@@ -2975,11 +3218,11 @@ export interface ModelRecord {
|
|
|
2975
3218
|
'deleted'?: boolean;
|
|
2976
3219
|
'complete'?: boolean;
|
|
2977
3220
|
'uuid': string;
|
|
3221
|
+
'user'?: PublicUserDTO;
|
|
2978
3222
|
'properties'?: Array<FilledProperty>;
|
|
2979
3223
|
'objects'?: {
|
|
2980
3224
|
[key: string]: any | null;
|
|
2981
3225
|
};
|
|
2982
|
-
'user'?: PublicUserDTO;
|
|
2983
3226
|
}
|
|
2984
3227
|
export interface MultiLine extends PropertyFormat {
|
|
2985
3228
|
}
|
|
@@ -4585,6 +4828,19 @@ export interface ShowResponse {
|
|
|
4585
4828
|
'message'?: string;
|
|
4586
4829
|
'data'?: any;
|
|
4587
4830
|
}
|
|
4831
|
+
/**
|
|
4832
|
+
* Represents the response for viewing or showing a specific resource.
|
|
4833
|
+
*/
|
|
4834
|
+
export interface ShowResponseAppBillingStatusResponse {
|
|
4835
|
+
/**
|
|
4836
|
+
* A message detailing the result of the operation.
|
|
4837
|
+
*/
|
|
4838
|
+
'message'?: string;
|
|
4839
|
+
/**
|
|
4840
|
+
* The data payload of the response, if any.
|
|
4841
|
+
*/
|
|
4842
|
+
'data'?: AppBillingStatusResponse;
|
|
4843
|
+
}
|
|
4588
4844
|
/**
|
|
4589
4845
|
* Represents the response for viewing or showing a specific resource.
|
|
4590
4846
|
*/
|
|
@@ -4611,6 +4867,32 @@ export interface ShowResponseAppInboundRouteDTO {
|
|
|
4611
4867
|
*/
|
|
4612
4868
|
'data'?: AppInboundRouteDTO;
|
|
4613
4869
|
}
|
|
4870
|
+
/**
|
|
4871
|
+
* Represents the response for viewing or showing a specific resource.
|
|
4872
|
+
*/
|
|
4873
|
+
export interface ShowResponseAppInstallationBillingStatusDTO {
|
|
4874
|
+
/**
|
|
4875
|
+
* A message detailing the result of the operation.
|
|
4876
|
+
*/
|
|
4877
|
+
'message'?: string;
|
|
4878
|
+
/**
|
|
4879
|
+
* The data payload of the response, if any.
|
|
4880
|
+
*/
|
|
4881
|
+
'data'?: AppInstallationBillingStatusDTO;
|
|
4882
|
+
}
|
|
4883
|
+
/**
|
|
4884
|
+
* Represents the response for viewing or showing a specific resource.
|
|
4885
|
+
*/
|
|
4886
|
+
export interface ShowResponseAppMeterEventResponse {
|
|
4887
|
+
/**
|
|
4888
|
+
* A message detailing the result of the operation.
|
|
4889
|
+
*/
|
|
4890
|
+
'message'?: string;
|
|
4891
|
+
/**
|
|
4892
|
+
* The data payload of the response, if any.
|
|
4893
|
+
*/
|
|
4894
|
+
'data'?: AppMeterEventResponse;
|
|
4895
|
+
}
|
|
4614
4896
|
/**
|
|
4615
4897
|
* Represents the response for viewing or showing a specific resource.
|
|
4616
4898
|
*/
|
|
@@ -4637,6 +4919,19 @@ export interface ShowResponseAppScheduleDTO {
|
|
|
4637
4919
|
*/
|
|
4638
4920
|
'data'?: AppScheduleDTO;
|
|
4639
4921
|
}
|
|
4922
|
+
/**
|
|
4923
|
+
* Represents the response for viewing or showing a specific resource.
|
|
4924
|
+
*/
|
|
4925
|
+
export interface ShowResponseAppSubscriptionDTO {
|
|
4926
|
+
/**
|
|
4927
|
+
* A message detailing the result of the operation.
|
|
4928
|
+
*/
|
|
4929
|
+
'message'?: string;
|
|
4930
|
+
/**
|
|
4931
|
+
* The data payload of the response, if any.
|
|
4932
|
+
*/
|
|
4933
|
+
'data'?: AppSubscriptionDTO;
|
|
4934
|
+
}
|
|
4640
4935
|
/**
|
|
4641
4936
|
* Represents the response for viewing or showing a specific resource.
|
|
4642
4937
|
*/
|
|
@@ -4650,6 +4945,19 @@ export interface ShowResponseListAppConnectionStatusDTO {
|
|
|
4650
4945
|
*/
|
|
4651
4946
|
'data'?: Array<AppConnectionStatusDTO>;
|
|
4652
4947
|
}
|
|
4948
|
+
/**
|
|
4949
|
+
* Represents the response for viewing or showing a specific resource.
|
|
4950
|
+
*/
|
|
4951
|
+
export interface ShowResponseListAppInstallationBillingStatusDTO {
|
|
4952
|
+
/**
|
|
4953
|
+
* A message detailing the result of the operation.
|
|
4954
|
+
*/
|
|
4955
|
+
'message'?: string;
|
|
4956
|
+
/**
|
|
4957
|
+
* The data payload of the response, if any.
|
|
4958
|
+
*/
|
|
4959
|
+
'data'?: Array<AppInstallationBillingStatusDTO>;
|
|
4960
|
+
}
|
|
4653
4961
|
/**
|
|
4654
4962
|
* Represents the response for viewing or showing a specific resource.
|
|
4655
4963
|
*/
|
|
@@ -6538,6 +6846,298 @@ export declare const ListAppBarsLocationEnum: {
|
|
|
6538
6846
|
readonly TraitBar: "TRAIT_BAR";
|
|
6539
6847
|
};
|
|
6540
6848
|
export type ListAppBarsLocationEnum = typeof ListAppBarsLocationEnum[keyof typeof ListAppBarsLocationEnum];
|
|
6849
|
+
/**
|
|
6850
|
+
* AppBillingApi - axios parameter creator
|
|
6851
|
+
*/
|
|
6852
|
+
export declare const AppBillingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
6853
|
+
/**
|
|
6854
|
+
*
|
|
6855
|
+
* @summary Current-period billing for every installation of an app
|
|
6856
|
+
* @param {string} appUuid
|
|
6857
|
+
* @param {*} [options] Override http request option.
|
|
6858
|
+
* @throws {RequiredError}
|
|
6859
|
+
*/
|
|
6860
|
+
appBillingStatus: (appUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6861
|
+
/**
|
|
6862
|
+
*
|
|
6863
|
+
* @summary Cancel a scheduled subscription change
|
|
6864
|
+
* @param {string} appUuid
|
|
6865
|
+
* @param {*} [options] Override http request option.
|
|
6866
|
+
* @throws {RequiredError}
|
|
6867
|
+
*/
|
|
6868
|
+
cancelPendingChange: (appUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6869
|
+
/**
|
|
6870
|
+
*
|
|
6871
|
+
* @summary Current subscription state for the selected company\'s installation
|
|
6872
|
+
* @param {string} appUuid
|
|
6873
|
+
* @param {*} [options] Override http request option.
|
|
6874
|
+
* @throws {RequiredError}
|
|
6875
|
+
*/
|
|
6876
|
+
getSubscription: (appUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6877
|
+
/**
|
|
6878
|
+
*
|
|
6879
|
+
* @summary Current-period billing for the selected company\'s installation
|
|
6880
|
+
* @param {string} appUuid
|
|
6881
|
+
* @param {*} [options] Override http request option.
|
|
6882
|
+
* @throws {RequiredError}
|
|
6883
|
+
*/
|
|
6884
|
+
installationBillingStatus: (appUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6885
|
+
/**
|
|
6886
|
+
*
|
|
6887
|
+
* @summary Platform-wide current-period app usage billing
|
|
6888
|
+
* @param {string} [appUuid]
|
|
6889
|
+
* @param {number} [page]
|
|
6890
|
+
* @param {number} [limit]
|
|
6891
|
+
* @param {*} [options] Override http request option.
|
|
6892
|
+
* @throws {RequiredError}
|
|
6893
|
+
*/
|
|
6894
|
+
platformBillingStatus: (appUuid?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6895
|
+
/**
|
|
6896
|
+
*
|
|
6897
|
+
* @summary Record a manual meter event for the selected company\'s installation
|
|
6898
|
+
* @param {string} appUuid
|
|
6899
|
+
* @param {AppMeterEventRequest} appMeterEventRequest
|
|
6900
|
+
* @param {*} [options] Override http request option.
|
|
6901
|
+
* @throws {RequiredError}
|
|
6902
|
+
*/
|
|
6903
|
+
recordMeterEvent: (appUuid: string, appMeterEventRequest: AppMeterEventRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6904
|
+
/**
|
|
6905
|
+
*
|
|
6906
|
+
* @summary Schedule a plan or commitment change
|
|
6907
|
+
* @param {string} appUuid
|
|
6908
|
+
* @param {AppSubscriptionChangeRequest} appSubscriptionChangeRequest
|
|
6909
|
+
* @param {*} [options] Override http request option.
|
|
6910
|
+
* @throws {RequiredError}
|
|
6911
|
+
*/
|
|
6912
|
+
scheduleSubscriptionChange: (appUuid: string, appSubscriptionChangeRequest: AppSubscriptionChangeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6913
|
+
/**
|
|
6914
|
+
*
|
|
6915
|
+
* @summary Usage periods for the selected company\'s installation
|
|
6916
|
+
* @param {string} appUuid
|
|
6917
|
+
* @param {*} [options] Override http request option.
|
|
6918
|
+
* @throws {RequiredError}
|
|
6919
|
+
*/
|
|
6920
|
+
usagePeriods: (appUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6921
|
+
};
|
|
6922
|
+
/**
|
|
6923
|
+
* AppBillingApi - functional programming interface
|
|
6924
|
+
*/
|
|
6925
|
+
export declare const AppBillingApiFp: (configuration?: Configuration) => {
|
|
6926
|
+
/**
|
|
6927
|
+
*
|
|
6928
|
+
* @summary Current-period billing for every installation of an app
|
|
6929
|
+
* @param {string} appUuid
|
|
6930
|
+
* @param {*} [options] Override http request option.
|
|
6931
|
+
* @throws {RequiredError}
|
|
6932
|
+
*/
|
|
6933
|
+
appBillingStatus(appUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseAppBillingStatusResponse>>;
|
|
6934
|
+
/**
|
|
6935
|
+
*
|
|
6936
|
+
* @summary Cancel a scheduled subscription change
|
|
6937
|
+
* @param {string} appUuid
|
|
6938
|
+
* @param {*} [options] Override http request option.
|
|
6939
|
+
* @throws {RequiredError}
|
|
6940
|
+
*/
|
|
6941
|
+
cancelPendingChange(appUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseAppSubscriptionDTO>>;
|
|
6942
|
+
/**
|
|
6943
|
+
*
|
|
6944
|
+
* @summary Current subscription state for the selected company\'s installation
|
|
6945
|
+
* @param {string} appUuid
|
|
6946
|
+
* @param {*} [options] Override http request option.
|
|
6947
|
+
* @throws {RequiredError}
|
|
6948
|
+
*/
|
|
6949
|
+
getSubscription(appUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseAppSubscriptionDTO>>;
|
|
6950
|
+
/**
|
|
6951
|
+
*
|
|
6952
|
+
* @summary Current-period billing for the selected company\'s installation
|
|
6953
|
+
* @param {string} appUuid
|
|
6954
|
+
* @param {*} [options] Override http request option.
|
|
6955
|
+
* @throws {RequiredError}
|
|
6956
|
+
*/
|
|
6957
|
+
installationBillingStatus(appUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseAppInstallationBillingStatusDTO>>;
|
|
6958
|
+
/**
|
|
6959
|
+
*
|
|
6960
|
+
* @summary Platform-wide current-period app usage billing
|
|
6961
|
+
* @param {string} [appUuid]
|
|
6962
|
+
* @param {number} [page]
|
|
6963
|
+
* @param {number} [limit]
|
|
6964
|
+
* @param {*} [options] Override http request option.
|
|
6965
|
+
* @throws {RequiredError}
|
|
6966
|
+
*/
|
|
6967
|
+
platformBillingStatus(appUuid?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseAppBillingStatusResponse>>;
|
|
6968
|
+
/**
|
|
6969
|
+
*
|
|
6970
|
+
* @summary Record a manual meter event for the selected company\'s installation
|
|
6971
|
+
* @param {string} appUuid
|
|
6972
|
+
* @param {AppMeterEventRequest} appMeterEventRequest
|
|
6973
|
+
* @param {*} [options] Override http request option.
|
|
6974
|
+
* @throws {RequiredError}
|
|
6975
|
+
*/
|
|
6976
|
+
recordMeterEvent(appUuid: string, appMeterEventRequest: AppMeterEventRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseAppMeterEventResponse>>;
|
|
6977
|
+
/**
|
|
6978
|
+
*
|
|
6979
|
+
* @summary Schedule a plan or commitment change
|
|
6980
|
+
* @param {string} appUuid
|
|
6981
|
+
* @param {AppSubscriptionChangeRequest} appSubscriptionChangeRequest
|
|
6982
|
+
* @param {*} [options] Override http request option.
|
|
6983
|
+
* @throws {RequiredError}
|
|
6984
|
+
*/
|
|
6985
|
+
scheduleSubscriptionChange(appUuid: string, appSubscriptionChangeRequest: AppSubscriptionChangeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseAppSubscriptionDTO>>;
|
|
6986
|
+
/**
|
|
6987
|
+
*
|
|
6988
|
+
* @summary Usage periods for the selected company\'s installation
|
|
6989
|
+
* @param {string} appUuid
|
|
6990
|
+
* @param {*} [options] Override http request option.
|
|
6991
|
+
* @throws {RequiredError}
|
|
6992
|
+
*/
|
|
6993
|
+
usagePeriods(appUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseListAppInstallationBillingStatusDTO>>;
|
|
6994
|
+
};
|
|
6995
|
+
/**
|
|
6996
|
+
* AppBillingApi - factory interface
|
|
6997
|
+
*/
|
|
6998
|
+
export declare const AppBillingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
6999
|
+
/**
|
|
7000
|
+
*
|
|
7001
|
+
* @summary Current-period billing for every installation of an app
|
|
7002
|
+
* @param {string} appUuid
|
|
7003
|
+
* @param {*} [options] Override http request option.
|
|
7004
|
+
* @throws {RequiredError}
|
|
7005
|
+
*/
|
|
7006
|
+
appBillingStatus(appUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseAppBillingStatusResponse>;
|
|
7007
|
+
/**
|
|
7008
|
+
*
|
|
7009
|
+
* @summary Cancel a scheduled subscription change
|
|
7010
|
+
* @param {string} appUuid
|
|
7011
|
+
* @param {*} [options] Override http request option.
|
|
7012
|
+
* @throws {RequiredError}
|
|
7013
|
+
*/
|
|
7014
|
+
cancelPendingChange(appUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseAppSubscriptionDTO>;
|
|
7015
|
+
/**
|
|
7016
|
+
*
|
|
7017
|
+
* @summary Current subscription state for the selected company\'s installation
|
|
7018
|
+
* @param {string} appUuid
|
|
7019
|
+
* @param {*} [options] Override http request option.
|
|
7020
|
+
* @throws {RequiredError}
|
|
7021
|
+
*/
|
|
7022
|
+
getSubscription(appUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseAppSubscriptionDTO>;
|
|
7023
|
+
/**
|
|
7024
|
+
*
|
|
7025
|
+
* @summary Current-period billing for the selected company\'s installation
|
|
7026
|
+
* @param {string} appUuid
|
|
7027
|
+
* @param {*} [options] Override http request option.
|
|
7028
|
+
* @throws {RequiredError}
|
|
7029
|
+
*/
|
|
7030
|
+
installationBillingStatus(appUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseAppInstallationBillingStatusDTO>;
|
|
7031
|
+
/**
|
|
7032
|
+
*
|
|
7033
|
+
* @summary Platform-wide current-period app usage billing
|
|
7034
|
+
* @param {string} [appUuid]
|
|
7035
|
+
* @param {number} [page]
|
|
7036
|
+
* @param {number} [limit]
|
|
7037
|
+
* @param {*} [options] Override http request option.
|
|
7038
|
+
* @throws {RequiredError}
|
|
7039
|
+
*/
|
|
7040
|
+
platformBillingStatus(appUuid?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseAppBillingStatusResponse>;
|
|
7041
|
+
/**
|
|
7042
|
+
*
|
|
7043
|
+
* @summary Record a manual meter event for the selected company\'s installation
|
|
7044
|
+
* @param {string} appUuid
|
|
7045
|
+
* @param {AppMeterEventRequest} appMeterEventRequest
|
|
7046
|
+
* @param {*} [options] Override http request option.
|
|
7047
|
+
* @throws {RequiredError}
|
|
7048
|
+
*/
|
|
7049
|
+
recordMeterEvent(appUuid: string, appMeterEventRequest: AppMeterEventRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseAppMeterEventResponse>;
|
|
7050
|
+
/**
|
|
7051
|
+
*
|
|
7052
|
+
* @summary Schedule a plan or commitment change
|
|
7053
|
+
* @param {string} appUuid
|
|
7054
|
+
* @param {AppSubscriptionChangeRequest} appSubscriptionChangeRequest
|
|
7055
|
+
* @param {*} [options] Override http request option.
|
|
7056
|
+
* @throws {RequiredError}
|
|
7057
|
+
*/
|
|
7058
|
+
scheduleSubscriptionChange(appUuid: string, appSubscriptionChangeRequest: AppSubscriptionChangeRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseAppSubscriptionDTO>;
|
|
7059
|
+
/**
|
|
7060
|
+
*
|
|
7061
|
+
* @summary Usage periods for the selected company\'s installation
|
|
7062
|
+
* @param {string} appUuid
|
|
7063
|
+
* @param {*} [options] Override http request option.
|
|
7064
|
+
* @throws {RequiredError}
|
|
7065
|
+
*/
|
|
7066
|
+
usagePeriods(appUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseListAppInstallationBillingStatusDTO>;
|
|
7067
|
+
};
|
|
7068
|
+
/**
|
|
7069
|
+
* AppBillingApi - object-oriented interface
|
|
7070
|
+
*/
|
|
7071
|
+
export declare class AppBillingApi extends BaseAPI {
|
|
7072
|
+
/**
|
|
7073
|
+
*
|
|
7074
|
+
* @summary Current-period billing for every installation of an app
|
|
7075
|
+
* @param {string} appUuid
|
|
7076
|
+
* @param {*} [options] Override http request option.
|
|
7077
|
+
* @throws {RequiredError}
|
|
7078
|
+
*/
|
|
7079
|
+
appBillingStatus(appUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseAppBillingStatusResponse, any, {}>>;
|
|
7080
|
+
/**
|
|
7081
|
+
*
|
|
7082
|
+
* @summary Cancel a scheduled subscription change
|
|
7083
|
+
* @param {string} appUuid
|
|
7084
|
+
* @param {*} [options] Override http request option.
|
|
7085
|
+
* @throws {RequiredError}
|
|
7086
|
+
*/
|
|
7087
|
+
cancelPendingChange(appUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseAppSubscriptionDTO, any, {}>>;
|
|
7088
|
+
/**
|
|
7089
|
+
*
|
|
7090
|
+
* @summary Current subscription state for the selected company\'s installation
|
|
7091
|
+
* @param {string} appUuid
|
|
7092
|
+
* @param {*} [options] Override http request option.
|
|
7093
|
+
* @throws {RequiredError}
|
|
7094
|
+
*/
|
|
7095
|
+
getSubscription(appUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseAppSubscriptionDTO, any, {}>>;
|
|
7096
|
+
/**
|
|
7097
|
+
*
|
|
7098
|
+
* @summary Current-period billing for the selected company\'s installation
|
|
7099
|
+
* @param {string} appUuid
|
|
7100
|
+
* @param {*} [options] Override http request option.
|
|
7101
|
+
* @throws {RequiredError}
|
|
7102
|
+
*/
|
|
7103
|
+
installationBillingStatus(appUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseAppInstallationBillingStatusDTO, any, {}>>;
|
|
7104
|
+
/**
|
|
7105
|
+
*
|
|
7106
|
+
* @summary Platform-wide current-period app usage billing
|
|
7107
|
+
* @param {string} [appUuid]
|
|
7108
|
+
* @param {number} [page]
|
|
7109
|
+
* @param {number} [limit]
|
|
7110
|
+
* @param {*} [options] Override http request option.
|
|
7111
|
+
* @throws {RequiredError}
|
|
7112
|
+
*/
|
|
7113
|
+
platformBillingStatus(appUuid?: string, page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseAppBillingStatusResponse, any, {}>>;
|
|
7114
|
+
/**
|
|
7115
|
+
*
|
|
7116
|
+
* @summary Record a manual meter event for the selected company\'s installation
|
|
7117
|
+
* @param {string} appUuid
|
|
7118
|
+
* @param {AppMeterEventRequest} appMeterEventRequest
|
|
7119
|
+
* @param {*} [options] Override http request option.
|
|
7120
|
+
* @throws {RequiredError}
|
|
7121
|
+
*/
|
|
7122
|
+
recordMeterEvent(appUuid: string, appMeterEventRequest: AppMeterEventRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseAppMeterEventResponse, any, {}>>;
|
|
7123
|
+
/**
|
|
7124
|
+
*
|
|
7125
|
+
* @summary Schedule a plan or commitment change
|
|
7126
|
+
* @param {string} appUuid
|
|
7127
|
+
* @param {AppSubscriptionChangeRequest} appSubscriptionChangeRequest
|
|
7128
|
+
* @param {*} [options] Override http request option.
|
|
7129
|
+
* @throws {RequiredError}
|
|
7130
|
+
*/
|
|
7131
|
+
scheduleSubscriptionChange(appUuid: string, appSubscriptionChangeRequest: AppSubscriptionChangeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseAppSubscriptionDTO, any, {}>>;
|
|
7132
|
+
/**
|
|
7133
|
+
*
|
|
7134
|
+
* @summary Usage periods for the selected company\'s installation
|
|
7135
|
+
* @param {string} appUuid
|
|
7136
|
+
* @param {*} [options] Override http request option.
|
|
7137
|
+
* @throws {RequiredError}
|
|
7138
|
+
*/
|
|
7139
|
+
usagePeriods(appUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseListAppInstallationBillingStatusDTO, any, {}>>;
|
|
7140
|
+
}
|
|
6541
7141
|
/**
|
|
6542
7142
|
* AppInstallationRuntimeApi - axios parameter creator
|
|
6543
7143
|
*/
|