Skip to content

Commit 1b50fd9

Browse files
feat(api): api update
1 parent d5d0cc5 commit 1b50fd9

4 files changed

Lines changed: 86 additions & 2 deletions

File tree

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 139
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb/orb-7f97a69f22372b818e8d24a72f6020bcf2f0c6d6b3ad07abb8395c87ec4a72ee.yml
3-
openapi_spec_hash: a6261e730c54d08ad36f1b946e663fc3
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb/orb-eeb1a619e163d81d19ba1783f731a4b159966371a2c2200d29334a021a90df23.yml
3+
openapi_spec_hash: 611155ef9e528c74675d68a70b86bf03
44
config_hash: c01c1191b1cd696c7ca855ff6d28a8df

orb-java-core/src/main/kotlin/com/withorb/api/models/PlanMigrationCancelResponse.kt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,24 +52,34 @@ private constructor(
5252
) : this(id, effectiveTime, planId, status, mutableMapOf())
5353

5454
/**
55+
* Unique identifier for this plan version change.
56+
*
5557
* @throws OrbInvalidDataException if the JSON field has an unexpected type or is unexpectedly
5658
* missing or null (e.g. if the server responded with an unexpected value).
5759
*/
5860
fun id(): String = id.getRequired("id")
5961

6062
/**
63+
* When the migration takes effect. Can be a specific date/time, or 'end_of_term' when scheduled
64+
* to be at the end of the current billing period.
65+
*
6166
* @throws OrbInvalidDataException if the JSON field has an unexpected type (e.g. if the server
6267
* responded with an unexpected value).
6368
*/
6469
fun effectiveTime(): Optional<EffectiveTime> = effectiveTime.getOptional("effective_time")
6570

6671
/**
72+
* The ID of the plan being migrated.
73+
*
6774
* @throws OrbInvalidDataException if the JSON field has an unexpected type or is unexpectedly
6875
* missing or null (e.g. if the server responded with an unexpected value).
6976
*/
7077
fun planId(): String = planId.getRequired("plan_id")
7178

7279
/**
80+
* Current status of the migration: 'not_started', 'in_progress', 'completed', 'action_needed',
81+
* or 'canceled'.
82+
*
7383
* @throws OrbInvalidDataException if the JSON field has an unexpected type or is unexpectedly
7484
* missing or null (e.g. if the server responded with an unexpected value).
7585
*/
@@ -151,6 +161,7 @@ private constructor(
151161
additionalProperties = planMigrationCancelResponse.additionalProperties.toMutableMap()
152162
}
153163

164+
/** Unique identifier for this plan version change. */
154165
fun id(id: String) = id(JsonField.of(id))
155166

156167
/**
@@ -161,6 +172,10 @@ private constructor(
161172
*/
162173
fun id(id: JsonField<String>) = apply { this.id = id }
163174

175+
/**
176+
* When the migration takes effect. Can be a specific date/time, or 'end_of_term' when
177+
* scheduled to be at the end of the current billing period.
178+
*/
164179
fun effectiveTime(effectiveTime: EffectiveTime?) =
165180
effectiveTime(JsonField.ofNullable(effectiveTime))
166181

@@ -191,6 +206,7 @@ private constructor(
191206
fun effectiveTime(unionMember2: EffectiveTime.UnionMember2) =
192207
effectiveTime(EffectiveTime.ofUnionMember2(unionMember2))
193208

209+
/** The ID of the plan being migrated. */
194210
fun planId(planId: String) = planId(JsonField.of(planId))
195211

196212
/**
@@ -201,6 +217,10 @@ private constructor(
201217
*/
202218
fun planId(planId: JsonField<String>) = apply { this.planId = planId }
203219

220+
/**
221+
* Current status of the migration: 'not_started', 'in_progress', 'completed',
222+
* 'action_needed', or 'canceled'.
223+
*/
204224
fun status(status: Status) = status(JsonField.of(status))
205225

206226
/**
@@ -297,6 +317,10 @@ private constructor(
297317
(if (planId.asKnown().isPresent) 1 else 0) +
298318
(status.asKnown().getOrNull()?.validity() ?: 0)
299319

320+
/**
321+
* When the migration takes effect. Can be a specific date/time, or 'end_of_term' when scheduled
322+
* to be at the end of the current billing period.
323+
*/
300324
@JsonDeserialize(using = EffectiveTime.Deserializer::class)
301325
@JsonSerialize(using = EffectiveTime.Serializer::class)
302326
class EffectiveTime
@@ -668,6 +692,10 @@ private constructor(
668692
}
669693
}
670694

695+
/**
696+
* Current status of the migration: 'not_started', 'in_progress', 'completed', 'action_needed',
697+
* or 'canceled'.
698+
*/
671699
class Status @JsonCreator private constructor(private val value: JsonField<String>) : Enum {
672700

673701
/**

orb-java-core/src/main/kotlin/com/withorb/api/models/PlanMigrationListResponse.kt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,24 +52,34 @@ private constructor(
5252
) : this(id, effectiveTime, planId, status, mutableMapOf())
5353

5454
/**
55+
* Unique identifier for this plan version change.
56+
*
5557
* @throws OrbInvalidDataException if the JSON field has an unexpected type or is unexpectedly
5658
* missing or null (e.g. if the server responded with an unexpected value).
5759
*/
5860
fun id(): String = id.getRequired("id")
5961

6062
/**
63+
* When the migration takes effect. Can be a specific date/time, or 'end_of_term' when scheduled
64+
* to be at the end of the current billing period.
65+
*
6166
* @throws OrbInvalidDataException if the JSON field has an unexpected type (e.g. if the server
6267
* responded with an unexpected value).
6368
*/
6469
fun effectiveTime(): Optional<EffectiveTime> = effectiveTime.getOptional("effective_time")
6570

6671
/**
72+
* The ID of the plan being migrated.
73+
*
6774
* @throws OrbInvalidDataException if the JSON field has an unexpected type or is unexpectedly
6875
* missing or null (e.g. if the server responded with an unexpected value).
6976
*/
7077
fun planId(): String = planId.getRequired("plan_id")
7178

7279
/**
80+
* Current status of the migration: 'not_started', 'in_progress', 'completed', 'action_needed',
81+
* or 'canceled'.
82+
*
7383
* @throws OrbInvalidDataException if the JSON field has an unexpected type or is unexpectedly
7484
* missing or null (e.g. if the server responded with an unexpected value).
7585
*/
@@ -151,6 +161,7 @@ private constructor(
151161
additionalProperties = planMigrationListResponse.additionalProperties.toMutableMap()
152162
}
153163

164+
/** Unique identifier for this plan version change. */
154165
fun id(id: String) = id(JsonField.of(id))
155166

156167
/**
@@ -161,6 +172,10 @@ private constructor(
161172
*/
162173
fun id(id: JsonField<String>) = apply { this.id = id }
163174

175+
/**
176+
* When the migration takes effect. Can be a specific date/time, or 'end_of_term' when
177+
* scheduled to be at the end of the current billing period.
178+
*/
164179
fun effectiveTime(effectiveTime: EffectiveTime?) =
165180
effectiveTime(JsonField.ofNullable(effectiveTime))
166181

@@ -191,6 +206,7 @@ private constructor(
191206
fun effectiveTime(unionMember2: EffectiveTime.UnionMember2) =
192207
effectiveTime(EffectiveTime.ofUnionMember2(unionMember2))
193208

209+
/** The ID of the plan being migrated. */
194210
fun planId(planId: String) = planId(JsonField.of(planId))
195211

196212
/**
@@ -201,6 +217,10 @@ private constructor(
201217
*/
202218
fun planId(planId: JsonField<String>) = apply { this.planId = planId }
203219

220+
/**
221+
* Current status of the migration: 'not_started', 'in_progress', 'completed',
222+
* 'action_needed', or 'canceled'.
223+
*/
204224
fun status(status: Status) = status(JsonField.of(status))
205225

206226
/**
@@ -297,6 +317,10 @@ private constructor(
297317
(if (planId.asKnown().isPresent) 1 else 0) +
298318
(status.asKnown().getOrNull()?.validity() ?: 0)
299319

320+
/**
321+
* When the migration takes effect. Can be a specific date/time, or 'end_of_term' when scheduled
322+
* to be at the end of the current billing period.
323+
*/
300324
@JsonDeserialize(using = EffectiveTime.Deserializer::class)
301325
@JsonSerialize(using = EffectiveTime.Serializer::class)
302326
class EffectiveTime
@@ -668,6 +692,10 @@ private constructor(
668692
}
669693
}
670694

695+
/**
696+
* Current status of the migration: 'not_started', 'in_progress', 'completed', 'action_needed',
697+
* or 'canceled'.
698+
*/
671699
class Status @JsonCreator private constructor(private val value: JsonField<String>) : Enum {
672700

673701
/**

orb-java-core/src/main/kotlin/com/withorb/api/models/PlanMigrationRetrieveResponse.kt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,24 +52,34 @@ private constructor(
5252
) : this(id, effectiveTime, planId, status, mutableMapOf())
5353

5454
/**
55+
* Unique identifier for this plan version change.
56+
*
5557
* @throws OrbInvalidDataException if the JSON field has an unexpected type or is unexpectedly
5658
* missing or null (e.g. if the server responded with an unexpected value).
5759
*/
5860
fun id(): String = id.getRequired("id")
5961

6062
/**
63+
* When the migration takes effect. Can be a specific date/time, or 'end_of_term' when scheduled
64+
* to be at the end of the current billing period.
65+
*
6166
* @throws OrbInvalidDataException if the JSON field has an unexpected type (e.g. if the server
6267
* responded with an unexpected value).
6368
*/
6469
fun effectiveTime(): Optional<EffectiveTime> = effectiveTime.getOptional("effective_time")
6570

6671
/**
72+
* The ID of the plan being migrated.
73+
*
6774
* @throws OrbInvalidDataException if the JSON field has an unexpected type or is unexpectedly
6875
* missing or null (e.g. if the server responded with an unexpected value).
6976
*/
7077
fun planId(): String = planId.getRequired("plan_id")
7178

7279
/**
80+
* Current status of the migration: 'not_started', 'in_progress', 'completed', 'action_needed',
81+
* or 'canceled'.
82+
*
7383
* @throws OrbInvalidDataException if the JSON field has an unexpected type or is unexpectedly
7484
* missing or null (e.g. if the server responded with an unexpected value).
7585
*/
@@ -152,6 +162,7 @@ private constructor(
152162
additionalProperties = planMigrationRetrieveResponse.additionalProperties.toMutableMap()
153163
}
154164

165+
/** Unique identifier for this plan version change. */
155166
fun id(id: String) = id(JsonField.of(id))
156167

157168
/**
@@ -162,6 +173,10 @@ private constructor(
162173
*/
163174
fun id(id: JsonField<String>) = apply { this.id = id }
164175

176+
/**
177+
* When the migration takes effect. Can be a specific date/time, or 'end_of_term' when
178+
* scheduled to be at the end of the current billing period.
179+
*/
165180
fun effectiveTime(effectiveTime: EffectiveTime?) =
166181
effectiveTime(JsonField.ofNullable(effectiveTime))
167182

@@ -192,6 +207,7 @@ private constructor(
192207
fun effectiveTime(unionMember2: EffectiveTime.UnionMember2) =
193208
effectiveTime(EffectiveTime.ofUnionMember2(unionMember2))
194209

210+
/** The ID of the plan being migrated. */
195211
fun planId(planId: String) = planId(JsonField.of(planId))
196212

197213
/**
@@ -202,6 +218,10 @@ private constructor(
202218
*/
203219
fun planId(planId: JsonField<String>) = apply { this.planId = planId }
204220

221+
/**
222+
* Current status of the migration: 'not_started', 'in_progress', 'completed',
223+
* 'action_needed', or 'canceled'.
224+
*/
205225
fun status(status: Status) = status(JsonField.of(status))
206226

207227
/**
@@ -298,6 +318,10 @@ private constructor(
298318
(if (planId.asKnown().isPresent) 1 else 0) +
299319
(status.asKnown().getOrNull()?.validity() ?: 0)
300320

321+
/**
322+
* When the migration takes effect. Can be a specific date/time, or 'end_of_term' when scheduled
323+
* to be at the end of the current billing period.
324+
*/
301325
@JsonDeserialize(using = EffectiveTime.Deserializer::class)
302326
@JsonSerialize(using = EffectiveTime.Serializer::class)
303327
class EffectiveTime
@@ -669,6 +693,10 @@ private constructor(
669693
}
670694
}
671695

696+
/**
697+
* Current status of the migration: 'not_started', 'in_progress', 'completed', 'action_needed',
698+
* or 'canceled'.
699+
*/
672700
class Status @JsonCreator private constructor(private val value: JsonField<String>) : Enum {
673701

674702
/**

0 commit comments

Comments
 (0)