@stigmer/protos 3.38.1 → 3.38.2
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/ai/stigmer/billing/subscription/v1/command_connect.d.ts +9 -0
- package/ai/stigmer/billing/subscription/v1/command_connect.js +9 -0
- package/ai/stigmer/billing/subscription/v1/command_pb.d.ts +9 -0
- package/ai/stigmer/billing/subscription/v1/io_pb.d.ts +149 -1
- package/ai/stigmer/billing/subscription/v1/io_pb.js +55 -2
- package/ai/stigmer/billing/subscription/v1/query_connect.d.ts +24 -0
- package/ai/stigmer/billing/subscription/v1/query_connect.js +25 -1
- package/ai/stigmer/billing/subscription/v1/query_pb.d.ts +24 -1
- package/ai/stigmer/billing/subscription/v1/query_pb.js +1 -1
- package/ai/stigmer/iam/team/v1/command_connect.d.ts +7 -0
- package/ai/stigmer/iam/team/v1/command_connect.js +7 -0
- package/ai/stigmer/iam/team/v1/command_pb.d.ts +7 -0
- package/ai/stigmer/tenancy/organization/v1/command_connect.d.ts +9 -0
- package/ai/stigmer/tenancy/organization/v1/command_connect.js +9 -0
- package/ai/stigmer/tenancy/organization/v1/command_pb.d.ts +9 -0
- package/package.json +1 -1
|
@@ -19,6 +19,15 @@ export declare const SubscriptionCommandController: {
|
|
|
19
19
|
* of one that does. The plan must be active and bought through a
|
|
20
20
|
* subscription. Returns the subscription as it stands after the change.
|
|
21
21
|
*
|
|
22
|
+
* Refusals a client should branch on carry a google.rpc.ErrorInfo
|
|
23
|
+
* detail (domain "stigmer.ai") on the standard grpc-status-details-bin
|
|
24
|
+
* trailer, alongside the human-readable FAILED_PRECONDITION message:
|
|
25
|
+
*
|
|
26
|
+
* - PAYMENT_METHOD_REQUIRED — the organization's billing account holds
|
|
27
|
+
* no saved payment method, which every period is collected from;
|
|
28
|
+
* BillingCommandController.createPaymentMethodSetupSession saves one.
|
|
29
|
+
* Metadata: org_id.
|
|
30
|
+
*
|
|
22
31
|
* @generated from rpc ai.stigmer.billing.subscription.v1.SubscriptionCommandController.changePlan
|
|
23
32
|
*/
|
|
24
33
|
readonly changePlan: {
|
|
@@ -26,6 +26,15 @@ export const SubscriptionCommandController = {
|
|
|
26
26
|
* of one that does. The plan must be active and bought through a
|
|
27
27
|
* subscription. Returns the subscription as it stands after the change.
|
|
28
28
|
*
|
|
29
|
+
* Refusals a client should branch on carry a google.rpc.ErrorInfo
|
|
30
|
+
* detail (domain "stigmer.ai") on the standard grpc-status-details-bin
|
|
31
|
+
* trailer, alongside the human-readable FAILED_PRECONDITION message:
|
|
32
|
+
*
|
|
33
|
+
* - PAYMENT_METHOD_REQUIRED — the organization's billing account holds
|
|
34
|
+
* no saved payment method, which every period is collected from;
|
|
35
|
+
* BillingCommandController.createPaymentMethodSetupSession saves one.
|
|
36
|
+
* Metadata: org_id.
|
|
37
|
+
*
|
|
29
38
|
* @generated from rpc ai.stigmer.billing.subscription.v1.SubscriptionCommandController.changePlan
|
|
30
39
|
*/
|
|
31
40
|
changePlan: {
|
|
@@ -24,6 +24,15 @@ export declare const SubscriptionCommandController: GenService<{
|
|
|
24
24
|
* of one that does. The plan must be active and bought through a
|
|
25
25
|
* subscription. Returns the subscription as it stands after the change.
|
|
26
26
|
*
|
|
27
|
+
* Refusals a client should branch on carry a google.rpc.ErrorInfo
|
|
28
|
+
* detail (domain "stigmer.ai") on the standard grpc-status-details-bin
|
|
29
|
+
* trailer, alongside the human-readable FAILED_PRECONDITION message:
|
|
30
|
+
*
|
|
31
|
+
* - PAYMENT_METHOD_REQUIRED — the organization's billing account holds
|
|
32
|
+
* no saved payment method, which every period is collected from;
|
|
33
|
+
* BillingCommandController.createPaymentMethodSetupSession saves one.
|
|
34
|
+
* Metadata: org_id.
|
|
35
|
+
*
|
|
27
36
|
* @generated from rpc ai.stigmer.billing.subscription.v1.SubscriptionCommandController.changePlan
|
|
28
37
|
*/
|
|
29
38
|
changePlan: {
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv1";
|
|
1
|
+
import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv1";
|
|
2
2
|
import type { Entitlements } from "../../../platform/v1/entitlement_pb.js";
|
|
3
|
+
import type { Timestamp } from "@bufbuild/protobuf/wkt";
|
|
3
4
|
import type { Message } from "@bufbuild/protobuf";
|
|
4
5
|
/**
|
|
5
6
|
* Describes the file ai/stigmer/billing/subscription/v1/io.proto.
|
|
@@ -112,3 +113,150 @@ export type CancelSubscriptionInput = Message<"ai.stigmer.billing.subscription.v
|
|
|
112
113
|
* Use `create(CancelSubscriptionInputSchema)` to create a new message.
|
|
113
114
|
*/
|
|
114
115
|
export declare const CancelSubscriptionInputSchema: GenMessage<CancelSubscriptionInput>;
|
|
116
|
+
/**
|
|
117
|
+
* GetPeriodEstimateInput names the organization whose current period is
|
|
118
|
+
* estimated.
|
|
119
|
+
*
|
|
120
|
+
* @generated from message ai.stigmer.billing.subscription.v1.GetPeriodEstimateInput
|
|
121
|
+
*/
|
|
122
|
+
export type GetPeriodEstimateInput = Message<"ai.stigmer.billing.subscription.v1.GetPeriodEstimateInput"> & {
|
|
123
|
+
/**
|
|
124
|
+
* The organization's id.
|
|
125
|
+
*
|
|
126
|
+
* @generated from field: string org_id = 1;
|
|
127
|
+
*/
|
|
128
|
+
orgId: string;
|
|
129
|
+
};
|
|
130
|
+
/**
|
|
131
|
+
* Describes the message ai.stigmer.billing.subscription.v1.GetPeriodEstimateInput.
|
|
132
|
+
* Use `create(GetPeriodEstimateInputSchema)` to create a new message.
|
|
133
|
+
*/
|
|
134
|
+
export declare const GetPeriodEstimateInputSchema: GenMessage<GetPeriodEstimateInput>;
|
|
135
|
+
/**
|
|
136
|
+
* PeriodEstimate is what an organization's current subscription period
|
|
137
|
+
* would be invoiced at its end if no further usage occurred.
|
|
138
|
+
*
|
|
139
|
+
* Money is in micros (1 USD = 1,000,000). Each line is rounded to whole
|
|
140
|
+
* cents the way the invoice rounds it, and total_micros is the sum of the
|
|
141
|
+
* rounded lines, so the estimate and the invoice agree to the cent.
|
|
142
|
+
*
|
|
143
|
+
* @generated from message ai.stigmer.billing.subscription.v1.PeriodEstimate
|
|
144
|
+
*/
|
|
145
|
+
export type PeriodEstimate = Message<"ai.stigmer.billing.subscription.v1.PeriodEstimate"> & {
|
|
146
|
+
/**
|
|
147
|
+
* The id of the Plan the period is on.
|
|
148
|
+
*
|
|
149
|
+
* @generated from field: string plan_id = 1;
|
|
150
|
+
*/
|
|
151
|
+
planId: string;
|
|
152
|
+
/**
|
|
153
|
+
* When the period began.
|
|
154
|
+
*
|
|
155
|
+
* @generated from field: google.protobuf.Timestamp period_start = 2;
|
|
156
|
+
*/
|
|
157
|
+
periodStart?: Timestamp;
|
|
158
|
+
/**
|
|
159
|
+
* When the period ends and is invoiced.
|
|
160
|
+
*
|
|
161
|
+
* @generated from field: google.protobuf.Timestamp period_end = 3;
|
|
162
|
+
*/
|
|
163
|
+
periodEnd?: Timestamp;
|
|
164
|
+
/**
|
|
165
|
+
* What the period's usage has cost in provider charges so far, across
|
|
166
|
+
* the organization and the managed organizations it pays for.
|
|
167
|
+
*
|
|
168
|
+
* @generated from field: int64 provider_cost_micros = 4;
|
|
169
|
+
*/
|
|
170
|
+
providerCostMicros: bigint;
|
|
171
|
+
/**
|
|
172
|
+
* The commission the wallet has already collected on that usage. It
|
|
173
|
+
* counts toward the plan's cost instead of adding to it.
|
|
174
|
+
*
|
|
175
|
+
* @generated from field: int64 commission_collected_micros = 5;
|
|
176
|
+
*/
|
|
177
|
+
commissionCollectedMicros: bigint;
|
|
178
|
+
/**
|
|
179
|
+
* The managed organizations counted against the plan this period.
|
|
180
|
+
*
|
|
181
|
+
* @generated from field: int32 managed_organization_count = 6;
|
|
182
|
+
*/
|
|
183
|
+
managedOrganizationCount: number;
|
|
184
|
+
/**
|
|
185
|
+
* The invoice's lines in the order they print, zero lines omitted.
|
|
186
|
+
*
|
|
187
|
+
* @generated from field: repeated ai.stigmer.billing.subscription.v1.PeriodEstimateLine lines = 7;
|
|
188
|
+
*/
|
|
189
|
+
lines: PeriodEstimateLine[];
|
|
190
|
+
/**
|
|
191
|
+
* The estimated invoice total: the sum of the lines.
|
|
192
|
+
*
|
|
193
|
+
* @generated from field: int64 total_micros = 8;
|
|
194
|
+
*/
|
|
195
|
+
totalMicros: bigint;
|
|
196
|
+
};
|
|
197
|
+
/**
|
|
198
|
+
* Describes the message ai.stigmer.billing.subscription.v1.PeriodEstimate.
|
|
199
|
+
* Use `create(PeriodEstimateSchema)` to create a new message.
|
|
200
|
+
*/
|
|
201
|
+
export declare const PeriodEstimateSchema: GenMessage<PeriodEstimate>;
|
|
202
|
+
/**
|
|
203
|
+
* PeriodEstimateLine is one line of an estimated invoice.
|
|
204
|
+
*
|
|
205
|
+
* @generated from message ai.stigmer.billing.subscription.v1.PeriodEstimateLine
|
|
206
|
+
*/
|
|
207
|
+
export type PeriodEstimateLine = Message<"ai.stigmer.billing.subscription.v1.PeriodEstimateLine"> & {
|
|
208
|
+
/**
|
|
209
|
+
* What the line charges or credits.
|
|
210
|
+
*
|
|
211
|
+
* @generated from field: ai.stigmer.billing.subscription.v1.PeriodEstimateLineKind kind = 1;
|
|
212
|
+
*/
|
|
213
|
+
kind: PeriodEstimateLineKind;
|
|
214
|
+
/**
|
|
215
|
+
* The line's amount in micros, a whole number of cents. The commission
|
|
216
|
+
* credit is negative.
|
|
217
|
+
*
|
|
218
|
+
* @generated from field: int64 amount_micros = 2;
|
|
219
|
+
*/
|
|
220
|
+
amountMicros: bigint;
|
|
221
|
+
};
|
|
222
|
+
/**
|
|
223
|
+
* Describes the message ai.stigmer.billing.subscription.v1.PeriodEstimateLine.
|
|
224
|
+
* Use `create(PeriodEstimateLineSchema)` to create a new message.
|
|
225
|
+
*/
|
|
226
|
+
export declare const PeriodEstimateLineSchema: GenMessage<PeriodEstimateLine>;
|
|
227
|
+
/**
|
|
228
|
+
* PeriodEstimateLineKind names what an estimated invoice line is for.
|
|
229
|
+
*
|
|
230
|
+
* @generated from enum ai.stigmer.billing.subscription.v1.PeriodEstimateLineKind
|
|
231
|
+
*/
|
|
232
|
+
export declare enum PeriodEstimateLineKind {
|
|
233
|
+
/**
|
|
234
|
+
* @generated from enum value: period_estimate_line_kind_unspecified = 0;
|
|
235
|
+
*/
|
|
236
|
+
period_estimate_line_kind_unspecified = 0,
|
|
237
|
+
/**
|
|
238
|
+
* The plan's cost: the greater of its monthly minimum and its usage
|
|
239
|
+
* share of the period's provider cost.
|
|
240
|
+
*
|
|
241
|
+
* @generated from enum value: plan = 1;
|
|
242
|
+
*/
|
|
243
|
+
plan = 1,
|
|
244
|
+
/**
|
|
245
|
+
* The commission already collected on the period's usage, credited
|
|
246
|
+
* against the plan's cost and never more than it.
|
|
247
|
+
*
|
|
248
|
+
* @generated from enum value: commission_credit = 2;
|
|
249
|
+
*/
|
|
250
|
+
commission_credit = 2,
|
|
251
|
+
/**
|
|
252
|
+
* The managed organizations beyond those the plan includes, at the
|
|
253
|
+
* plan's fee for each.
|
|
254
|
+
*
|
|
255
|
+
* @generated from enum value: managed_organizations = 3;
|
|
256
|
+
*/
|
|
257
|
+
managed_organizations = 3
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* Describes the enum ai.stigmer.billing.subscription.v1.PeriodEstimateLineKind.
|
|
261
|
+
*/
|
|
262
|
+
export declare const PeriodEstimateLineKindSchema: GenEnum<PeriodEstimateLineKind>;
|
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
// @generated by protoc-gen-es v2.2.2 with parameter "target=ts,import_extension=js"
|
|
2
2
|
// @generated from file ai/stigmer/billing/subscription/v1/io.proto (package ai.stigmer.billing.subscription.v1, syntax proto3)
|
|
3
3
|
/* eslint-disable */
|
|
4
|
-
import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv1";
|
|
4
|
+
import { enumDesc, fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv1";
|
|
5
5
|
import { file_ai_stigmer_platform_v1_entitlement } from "../../../platform/v1/entitlement_pb.js";
|
|
6
6
|
import { file_buf_validate_validate } from "../../../../../buf/validate/validate_pb.js";
|
|
7
|
+
import { file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
|
|
7
8
|
/**
|
|
8
9
|
* Describes the file ai/stigmer/billing/subscription/v1/io.proto.
|
|
9
10
|
*/
|
|
10
|
-
export const file_ai_stigmer_billing_subscription_v1_io = /*@__PURE__*/ fileDesc("
|
|
11
|
+
export const file_ai_stigmer_billing_subscription_v1_io = /*@__PURE__*/ fileDesc("CithaS9zdGlnbWVyL2JpbGxpbmcvc3Vic2NyaXB0aW9uL3YxL2lvLnByb3RvEiJhaS5zdGlnbWVyLmJpbGxpbmcuc3Vic2NyaXB0aW9uLnYxIj0KI0dldFN1YnNjcmlwdGlvbkZvck9yZ2FuaXphdGlvbklucHV0EhYKBm9yZ19pZBgBIAEoCUIGukgDyAEBIi4KFEdldEVudGl0bGVtZW50c0lucHV0EhYKBm9yZ19pZBgBIAEoCUIGukgDyAEBImQKFUdldEVudGl0bGVtZW50c091dHB1dBI6CgxlbnRpdGxlbWVudHMYASABKAsyJC5haS5zdGlnbWVyLnBsYXRmb3JtLnYxLkVudGl0bGVtZW50cxIPCgdwbGFuX2lkGAIgASgJIkIKD0NoYW5nZVBsYW5JbnB1dBIWCgZvcmdfaWQYASABKAlCBrpIA8gBARIXCgdwbGFuX2lkGAIgASgJQga6SAPIAQEiMQoXQ2FuY2VsU3Vic2NyaXB0aW9uSW5wdXQSFgoGb3JnX2lkGAEgASgJQga6SAPIAQEiMAoWR2V0UGVyaW9kRXN0aW1hdGVJbnB1dBIWCgZvcmdfaWQYASABKAlCBrpIA8gBASLHAgoOUGVyaW9kRXN0aW1hdGUSDwoHcGxhbl9pZBgBIAEoCRIwCgxwZXJpb2Rfc3RhcnQYAiABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wEi4KCnBlcmlvZF9lbmQYAyABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wEhwKFHByb3ZpZGVyX2Nvc3RfbWljcm9zGAQgASgDEiMKG2NvbW1pc3Npb25fY29sbGVjdGVkX21pY3JvcxgFIAEoAxIiChptYW5hZ2VkX29yZ2FuaXphdGlvbl9jb3VudBgGIAEoBRJFCgVsaW5lcxgHIAMoCzI2LmFpLnN0aWdtZXIuYmlsbGluZy5zdWJzY3JpcHRpb24udjEuUGVyaW9kRXN0aW1hdGVMaW5lEhQKDHRvdGFsX21pY3JvcxgIIAEoAyJ1ChJQZXJpb2RFc3RpbWF0ZUxpbmUSSAoEa2luZBgBIAEoDjI6LmFpLnN0aWdtZXIuYmlsbGluZy5zdWJzY3JpcHRpb24udjEuUGVyaW9kRXN0aW1hdGVMaW5lS2luZBIVCg1hbW91bnRfbWljcm9zGAIgASgDKn8KFlBlcmlvZEVzdGltYXRlTGluZUtpbmQSKQolcGVyaW9kX2VzdGltYXRlX2xpbmVfa2luZF91bnNwZWNpZmllZBAAEggKBHBsYW4QARIVChFjb21taXNzaW9uX2NyZWRpdBACEhkKFW1hbmFnZWRfb3JnYW5pemF0aW9ucxADYgZwcm90bzM", [file_ai_stigmer_platform_v1_entitlement, file_buf_validate_validate, file_google_protobuf_timestamp]);
|
|
11
12
|
/**
|
|
12
13
|
* Describes the message ai.stigmer.billing.subscription.v1.GetSubscriptionForOrganizationInput.
|
|
13
14
|
* Use `create(GetSubscriptionForOrganizationInputSchema)` to create a new message.
|
|
@@ -33,4 +34,56 @@ export const ChangePlanInputSchema = /*@__PURE__*/ messageDesc(file_ai_stigmer_b
|
|
|
33
34
|
* Use `create(CancelSubscriptionInputSchema)` to create a new message.
|
|
34
35
|
*/
|
|
35
36
|
export const CancelSubscriptionInputSchema = /*@__PURE__*/ messageDesc(file_ai_stigmer_billing_subscription_v1_io, 4);
|
|
37
|
+
/**
|
|
38
|
+
* Describes the message ai.stigmer.billing.subscription.v1.GetPeriodEstimateInput.
|
|
39
|
+
* Use `create(GetPeriodEstimateInputSchema)` to create a new message.
|
|
40
|
+
*/
|
|
41
|
+
export const GetPeriodEstimateInputSchema = /*@__PURE__*/ messageDesc(file_ai_stigmer_billing_subscription_v1_io, 5);
|
|
42
|
+
/**
|
|
43
|
+
* Describes the message ai.stigmer.billing.subscription.v1.PeriodEstimate.
|
|
44
|
+
* Use `create(PeriodEstimateSchema)` to create a new message.
|
|
45
|
+
*/
|
|
46
|
+
export const PeriodEstimateSchema = /*@__PURE__*/ messageDesc(file_ai_stigmer_billing_subscription_v1_io, 6);
|
|
47
|
+
/**
|
|
48
|
+
* Describes the message ai.stigmer.billing.subscription.v1.PeriodEstimateLine.
|
|
49
|
+
* Use `create(PeriodEstimateLineSchema)` to create a new message.
|
|
50
|
+
*/
|
|
51
|
+
export const PeriodEstimateLineSchema = /*@__PURE__*/ messageDesc(file_ai_stigmer_billing_subscription_v1_io, 7);
|
|
52
|
+
/**
|
|
53
|
+
* PeriodEstimateLineKind names what an estimated invoice line is for.
|
|
54
|
+
*
|
|
55
|
+
* @generated from enum ai.stigmer.billing.subscription.v1.PeriodEstimateLineKind
|
|
56
|
+
*/
|
|
57
|
+
export var PeriodEstimateLineKind;
|
|
58
|
+
(function (PeriodEstimateLineKind) {
|
|
59
|
+
/**
|
|
60
|
+
* @generated from enum value: period_estimate_line_kind_unspecified = 0;
|
|
61
|
+
*/
|
|
62
|
+
PeriodEstimateLineKind[PeriodEstimateLineKind["period_estimate_line_kind_unspecified"] = 0] = "period_estimate_line_kind_unspecified";
|
|
63
|
+
/**
|
|
64
|
+
* The plan's cost: the greater of its monthly minimum and its usage
|
|
65
|
+
* share of the period's provider cost.
|
|
66
|
+
*
|
|
67
|
+
* @generated from enum value: plan = 1;
|
|
68
|
+
*/
|
|
69
|
+
PeriodEstimateLineKind[PeriodEstimateLineKind["plan"] = 1] = "plan";
|
|
70
|
+
/**
|
|
71
|
+
* The commission already collected on the period's usage, credited
|
|
72
|
+
* against the plan's cost and never more than it.
|
|
73
|
+
*
|
|
74
|
+
* @generated from enum value: commission_credit = 2;
|
|
75
|
+
*/
|
|
76
|
+
PeriodEstimateLineKind[PeriodEstimateLineKind["commission_credit"] = 2] = "commission_credit";
|
|
77
|
+
/**
|
|
78
|
+
* The managed organizations beyond those the plan includes, at the
|
|
79
|
+
* plan's fee for each.
|
|
80
|
+
*
|
|
81
|
+
* @generated from enum value: managed_organizations = 3;
|
|
82
|
+
*/
|
|
83
|
+
PeriodEstimateLineKind[PeriodEstimateLineKind["managed_organizations"] = 3] = "managed_organizations";
|
|
84
|
+
})(PeriodEstimateLineKind || (PeriodEstimateLineKind = {}));
|
|
85
|
+
/**
|
|
86
|
+
* Describes the enum ai.stigmer.billing.subscription.v1.PeriodEstimateLineKind.
|
|
87
|
+
*/
|
|
88
|
+
export const PeriodEstimateLineKindSchema = /*@__PURE__*/ enumDesc(file_ai_stigmer_billing_subscription_v1_io, 0);
|
|
36
89
|
//# sourceMappingURL=io_pb.js.map
|
|
@@ -44,5 +44,29 @@ export declare const SubscriptionQueryController: {
|
|
|
44
44
|
readonly O: any;
|
|
45
45
|
readonly kind: any;
|
|
46
46
|
};
|
|
47
|
+
/**
|
|
48
|
+
* Estimate what the organization's current period will be invoiced.
|
|
49
|
+
*
|
|
50
|
+
* The estimate is the invoice the period would close with if no further
|
|
51
|
+
* usage occurred before its end: the plan's cost over the whole period
|
|
52
|
+
* (its minimum is not prorated to the time elapsed), less the commission
|
|
53
|
+
* already collected on the period's usage, plus the managed organizations
|
|
54
|
+
* beyond those the plan includes. It is rated by the same rule the
|
|
55
|
+
* monthly close invoices by, over the same usage, so an estimate read at
|
|
56
|
+
* a period's end equals that period's invoice. Every other read derives
|
|
57
|
+
* it the same way; nothing is stored.
|
|
58
|
+
*
|
|
59
|
+
* NOT_FOUND when the organization has no live subscription: it is on
|
|
60
|
+
* Free, or it is platform-managed and on its integrator's plan, and
|
|
61
|
+
* neither is invoiced a plan of its own.
|
|
62
|
+
*
|
|
63
|
+
* @generated from rpc ai.stigmer.billing.subscription.v1.SubscriptionQueryController.getPeriodEstimate
|
|
64
|
+
*/
|
|
65
|
+
readonly getPeriodEstimate: {
|
|
66
|
+
readonly name: "getPeriodEstimate";
|
|
67
|
+
readonly I: any;
|
|
68
|
+
readonly O: any;
|
|
69
|
+
readonly kind: any;
|
|
70
|
+
};
|
|
47
71
|
};
|
|
48
72
|
};
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// @generated from file ai/stigmer/billing/subscription/v1/query.proto (package ai.stigmer.billing.subscription.v1, syntax proto3)
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
// @ts-nocheck
|
|
5
|
-
import { GetEntitlementsInput, GetEntitlementsOutput, GetSubscriptionForOrganizationInput } from "./io_pbjs";
|
|
5
|
+
import { GetEntitlementsInput, GetEntitlementsOutput, GetPeriodEstimateInput, GetSubscriptionForOrganizationInput, PeriodEstimate } from "./io_pbjs";
|
|
6
6
|
import { Subscription } from "./api_pbjs";
|
|
7
7
|
import { MethodKind } from "@bufbuild/protobuf";
|
|
8
8
|
/**
|
|
@@ -51,6 +51,30 @@ export const SubscriptionQueryController = {
|
|
|
51
51
|
O: GetEntitlementsOutput,
|
|
52
52
|
kind: MethodKind.Unary,
|
|
53
53
|
},
|
|
54
|
+
/**
|
|
55
|
+
* Estimate what the organization's current period will be invoiced.
|
|
56
|
+
*
|
|
57
|
+
* The estimate is the invoice the period would close with if no further
|
|
58
|
+
* usage occurred before its end: the plan's cost over the whole period
|
|
59
|
+
* (its minimum is not prorated to the time elapsed), less the commission
|
|
60
|
+
* already collected on the period's usage, plus the managed organizations
|
|
61
|
+
* beyond those the plan includes. It is rated by the same rule the
|
|
62
|
+
* monthly close invoices by, over the same usage, so an estimate read at
|
|
63
|
+
* a period's end equals that period's invoice. Every other read derives
|
|
64
|
+
* it the same way; nothing is stored.
|
|
65
|
+
*
|
|
66
|
+
* NOT_FOUND when the organization has no live subscription: it is on
|
|
67
|
+
* Free, or it is platform-managed and on its integrator's plan, and
|
|
68
|
+
* neither is invoiced a plan of its own.
|
|
69
|
+
*
|
|
70
|
+
* @generated from rpc ai.stigmer.billing.subscription.v1.SubscriptionQueryController.getPeriodEstimate
|
|
71
|
+
*/
|
|
72
|
+
getPeriodEstimate: {
|
|
73
|
+
name: "getPeriodEstimate",
|
|
74
|
+
I: GetPeriodEstimateInput,
|
|
75
|
+
O: PeriodEstimate,
|
|
76
|
+
kind: MethodKind.Unary,
|
|
77
|
+
},
|
|
54
78
|
}
|
|
55
79
|
};
|
|
56
80
|
//# sourceMappingURL=query_connect.js.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { GenFile, GenService } from "@bufbuild/protobuf/codegenv1";
|
|
2
2
|
import type { SubscriptionSchema } from "./api_pb.js";
|
|
3
|
-
import type { GetEntitlementsInputSchema, GetEntitlementsOutputSchema, GetSubscriptionForOrganizationInputSchema } from "./io_pb.js";
|
|
3
|
+
import type { GetEntitlementsInputSchema, GetEntitlementsOutputSchema, GetPeriodEstimateInputSchema, GetSubscriptionForOrganizationInputSchema, PeriodEstimateSchema } from "./io_pb.js";
|
|
4
4
|
/**
|
|
5
5
|
* Describes the file ai/stigmer/billing/subscription/v1/query.proto.
|
|
6
6
|
*/
|
|
@@ -47,4 +47,27 @@ export declare const SubscriptionQueryController: GenService<{
|
|
|
47
47
|
input: typeof GetEntitlementsInputSchema;
|
|
48
48
|
output: typeof GetEntitlementsOutputSchema;
|
|
49
49
|
};
|
|
50
|
+
/**
|
|
51
|
+
* Estimate what the organization's current period will be invoiced.
|
|
52
|
+
*
|
|
53
|
+
* The estimate is the invoice the period would close with if no further
|
|
54
|
+
* usage occurred before its end: the plan's cost over the whole period
|
|
55
|
+
* (its minimum is not prorated to the time elapsed), less the commission
|
|
56
|
+
* already collected on the period's usage, plus the managed organizations
|
|
57
|
+
* beyond those the plan includes. It is rated by the same rule the
|
|
58
|
+
* monthly close invoices by, over the same usage, so an estimate read at
|
|
59
|
+
* a period's end equals that period's invoice. Every other read derives
|
|
60
|
+
* it the same way; nothing is stored.
|
|
61
|
+
*
|
|
62
|
+
* NOT_FOUND when the organization has no live subscription: it is on
|
|
63
|
+
* Free, or it is platform-managed and on its integrator's plan, and
|
|
64
|
+
* neither is invoiced a plan of its own.
|
|
65
|
+
*
|
|
66
|
+
* @generated from rpc ai.stigmer.billing.subscription.v1.SubscriptionQueryController.getPeriodEstimate
|
|
67
|
+
*/
|
|
68
|
+
getPeriodEstimate: {
|
|
69
|
+
methodKind: "unary";
|
|
70
|
+
input: typeof GetPeriodEstimateInputSchema;
|
|
71
|
+
output: typeof PeriodEstimateSchema;
|
|
72
|
+
};
|
|
50
73
|
}>;
|
|
@@ -9,7 +9,7 @@ import { file_ai_stigmer_commons_rpc_method_options } from "../../../commons/rpc
|
|
|
9
9
|
/**
|
|
10
10
|
* Describes the file ai/stigmer/billing/subscription/v1/query.proto.
|
|
11
11
|
*/
|
|
12
|
-
export const file_ai_stigmer_billing_subscription_v1_query = /*@__PURE__*/ fileDesc("
|
|
12
|
+
export const file_ai_stigmer_billing_subscription_v1_query = /*@__PURE__*/ fileDesc("Ci5haS9zdGlnbWVyL2JpbGxpbmcvc3Vic2NyaXB0aW9uL3YxL3F1ZXJ5LnByb3RvEiJhaS5zdGlnbWVyLmJpbGxpbmcuc3Vic2NyaXB0aW9uLnYxMqIFChtTdWJzY3JpcHRpb25RdWVyeUNvbnRyb2xsZXIS2AEKEmdldEZvck9yZ2FuaXphdGlvbhJHLmFpLnN0aWdtZXIuYmlsbGluZy5zdWJzY3JpcHRpb24udjEuR2V0U3Vic2NyaXB0aW9uRm9yT3JnYW5pemF0aW9uSW5wdXQaMC5haS5zdGlnbWVyLmJpbGxpbmcuc3Vic2NyaXB0aW9uLnYxLlN1YnNjcmlwdGlvbiJHwrgYQwgbEB4iBm9yZ19pZCo1dW5hdXRob3JpemVkIHRvIHZpZXcgdGhpcyBvcmdhbml6YXRpb24ncyBzdWJzY3JpcHRpb24SzwEKD2dldEVudGl0bGVtZW50cxI4LmFpLnN0aWdtZXIuYmlsbGluZy5zdWJzY3JpcHRpb24udjEuR2V0RW50aXRsZW1lbnRzSW5wdXQaOS5haS5zdGlnbWVyLmJpbGxpbmcuc3Vic2NyaXB0aW9uLnYxLkdldEVudGl0bGVtZW50c091dHB1dCJHwrgYQwgbEB4iBm9yZ19pZCo1dW5hdXRob3JpemVkIHRvIHZpZXcgdGhpcyBvcmdhbml6YXRpb24ncyBlbnRpdGxlbWVudHMSzwEKEWdldFBlcmlvZEVzdGltYXRlEjouYWkuc3RpZ21lci5iaWxsaW5nLnN1YnNjcmlwdGlvbi52MS5HZXRQZXJpb2RFc3RpbWF0ZUlucHV0GjIuYWkuc3RpZ21lci5iaWxsaW5nLnN1YnNjcmlwdGlvbi52MS5QZXJpb2RFc3RpbWF0ZSJKwrgYRggbEB4iBm9yZ19pZCo4dW5hdXRob3JpemVkIHRvIHZpZXcgdGhpcyBvcmdhbml6YXRpb24ncyBwZXJpb2QgZXN0aW1hdGUaBKD/K0diBnByb3RvMw", [file_ai_stigmer_billing_subscription_v1_api, file_ai_stigmer_billing_subscription_v1_io, file_ai_stigmer_commons_apiresource_rpc_service_options, file_ai_stigmer_commons_rpc_method_options]);
|
|
13
13
|
/**
|
|
14
14
|
* SubscriptionQueryController provides the read operations on an
|
|
15
15
|
* organization's subscription.
|
|
@@ -12,6 +12,13 @@ export declare const TeamCommandController: {
|
|
|
12
12
|
/**
|
|
13
13
|
* Create a team in an organization.
|
|
14
14
|
*
|
|
15
|
+
* On Stigmer Cloud, teams are a plan feature. An organization whose plan
|
|
16
|
+
* lacks them is refused with FAILED_PRECONDITION carrying a
|
|
17
|
+
* google.rpc.ErrorInfo detail (domain "stigmer.ai"):
|
|
18
|
+
*
|
|
19
|
+
* - PLAN_UPGRADE_REQUIRED — the organization's plan does not include
|
|
20
|
+
* the feature. Metadata: feature ("teams"), org_id.
|
|
21
|
+
*
|
|
15
22
|
* @generated from rpc ai.stigmer.iam.team.v1.TeamCommandController.create
|
|
16
23
|
*/
|
|
17
24
|
readonly create: {
|
|
@@ -19,6 +19,13 @@ export const TeamCommandController = {
|
|
|
19
19
|
/**
|
|
20
20
|
* Create a team in an organization.
|
|
21
21
|
*
|
|
22
|
+
* On Stigmer Cloud, teams are a plan feature. An organization whose plan
|
|
23
|
+
* lacks them is refused with FAILED_PRECONDITION carrying a
|
|
24
|
+
* google.rpc.ErrorInfo detail (domain "stigmer.ai"):
|
|
25
|
+
*
|
|
26
|
+
* - PLAN_UPGRADE_REQUIRED — the organization's plan does not include
|
|
27
|
+
* the feature. Metadata: feature ("teams"), org_id.
|
|
28
|
+
*
|
|
22
29
|
* @generated from rpc ai.stigmer.iam.team.v1.TeamCommandController.create
|
|
23
30
|
*/
|
|
24
31
|
create: {
|
|
@@ -17,6 +17,13 @@ export declare const TeamCommandController: GenService<{
|
|
|
17
17
|
/**
|
|
18
18
|
* Create a team in an organization.
|
|
19
19
|
*
|
|
20
|
+
* On Stigmer Cloud, teams are a plan feature. An organization whose plan
|
|
21
|
+
* lacks them is refused with FAILED_PRECONDITION carrying a
|
|
22
|
+
* google.rpc.ErrorInfo detail (domain "stigmer.ai"):
|
|
23
|
+
*
|
|
24
|
+
* - PLAN_UPGRADE_REQUIRED — the organization's plan does not include
|
|
25
|
+
* the feature. Metadata: feature ("teams"), org_id.
|
|
26
|
+
*
|
|
20
27
|
* @generated from rpc ai.stigmer.iam.team.v1.TeamCommandController.create
|
|
21
28
|
*/
|
|
22
29
|
create: {
|
|
@@ -20,6 +20,15 @@ export declare const OrganizationCommandController: {
|
|
|
20
20
|
/**
|
|
21
21
|
* Create an organization.
|
|
22
22
|
*
|
|
23
|
+
* On Stigmer Cloud, creating a platform-managed organization is a plan
|
|
24
|
+
* feature of its integrator. An integrator whose plan lacks it is refused
|
|
25
|
+
* with FAILED_PRECONDITION carrying a google.rpc.ErrorInfo detail (domain
|
|
26
|
+
* "stigmer.ai"):
|
|
27
|
+
*
|
|
28
|
+
* - PLAN_UPGRADE_REQUIRED — the integrator organization's plan does not
|
|
29
|
+
* include the feature. Metadata: feature ("managed_organizations"),
|
|
30
|
+
* org_id (the integrator organization).
|
|
31
|
+
*
|
|
23
32
|
* @generated from rpc ai.stigmer.tenancy.organization.v1.OrganizationCommandController.create
|
|
24
33
|
*/
|
|
25
34
|
readonly create: {
|
|
@@ -27,6 +27,15 @@ export const OrganizationCommandController = {
|
|
|
27
27
|
/**
|
|
28
28
|
* Create an organization.
|
|
29
29
|
*
|
|
30
|
+
* On Stigmer Cloud, creating a platform-managed organization is a plan
|
|
31
|
+
* feature of its integrator. An integrator whose plan lacks it is refused
|
|
32
|
+
* with FAILED_PRECONDITION carrying a google.rpc.ErrorInfo detail (domain
|
|
33
|
+
* "stigmer.ai"):
|
|
34
|
+
*
|
|
35
|
+
* - PLAN_UPGRADE_REQUIRED — the integrator organization's plan does not
|
|
36
|
+
* include the feature. Metadata: feature ("managed_organizations"),
|
|
37
|
+
* org_id (the integrator organization).
|
|
38
|
+
*
|
|
30
39
|
* @generated from rpc ai.stigmer.tenancy.organization.v1.OrganizationCommandController.create
|
|
31
40
|
*/
|
|
32
41
|
create: {
|
|
@@ -24,6 +24,15 @@ export declare const OrganizationCommandController: GenService<{
|
|
|
24
24
|
/**
|
|
25
25
|
* Create an organization.
|
|
26
26
|
*
|
|
27
|
+
* On Stigmer Cloud, creating a platform-managed organization is a plan
|
|
28
|
+
* feature of its integrator. An integrator whose plan lacks it is refused
|
|
29
|
+
* with FAILED_PRECONDITION carrying a google.rpc.ErrorInfo detail (domain
|
|
30
|
+
* "stigmer.ai"):
|
|
31
|
+
*
|
|
32
|
+
* - PLAN_UPGRADE_REQUIRED — the integrator organization's plan does not
|
|
33
|
+
* include the feature. Metadata: feature ("managed_organizations"),
|
|
34
|
+
* org_id (the integrator organization).
|
|
35
|
+
*
|
|
27
36
|
* @generated from rpc ai.stigmer.tenancy.organization.v1.OrganizationCommandController.create
|
|
28
37
|
*/
|
|
29
38
|
create: {
|