@seamapi/types 1.1169.0 → 1.1171.0

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.
@@ -56174,7 +56174,40 @@ const openapi = {
56174
56174
  nullable: true,
56175
56175
  type: 'string',
56176
56176
  },
56177
+ pending_upgrade: {
56178
+ nullable: true,
56179
+ properties: {
56180
+ hosted_invoice_url: {
56181
+ nullable: true,
56182
+ type: 'string',
56183
+ },
56184
+ package_quantity: {
56185
+ format: 'float',
56186
+ type: 'number',
56187
+ },
56188
+ },
56189
+ required: [
56190
+ 'package_quantity',
56191
+ 'hosted_invoice_url',
56192
+ ],
56193
+ type: 'object',
56194
+ },
56177
56195
  price_cents: { format: 'float', type: 'number' },
56196
+ scheduled_change_at: {
56197
+ format: 'date-time',
56198
+ nullable: true,
56199
+ type: 'string',
56200
+ },
56201
+ scheduled_package_quantity: {
56202
+ format: 'float',
56203
+ nullable: true,
56204
+ type: 'number',
56205
+ },
56206
+ scheduled_price_cents: {
56207
+ format: 'float',
56208
+ nullable: true,
56209
+ type: 'number',
56210
+ },
56178
56211
  status: { type: 'string' },
56179
56212
  },
56180
56213
  required: [
@@ -56186,10 +56219,52 @@ const openapi = {
56186
56219
  'current_period_ends_at',
56187
56220
  'past_due_since',
56188
56221
  'canceled_at',
56222
+ 'scheduled_package_quantity',
56223
+ 'scheduled_price_cents',
56224
+ 'scheduled_change_at',
56225
+ 'pending_upgrade',
56189
56226
  ],
56190
56227
  type: 'object',
56191
56228
  },
56192
56229
  is_test_mode: { type: 'boolean' },
56230
+ trial: {
56231
+ nullable: true,
56232
+ properties: {
56233
+ is_active: { type: 'boolean' },
56234
+ is_credits_used_up: { type: 'boolean' },
56235
+ is_suspended: { type: 'boolean' },
56236
+ remaining_credits: {
56237
+ format: 'float',
56238
+ nullable: true,
56239
+ type: 'number',
56240
+ },
56241
+ trial_credits: { format: 'float', type: 'number' },
56242
+ trial_ends_at: {
56243
+ format: 'date-time',
56244
+ type: 'string',
56245
+ },
56246
+ trial_started_at: {
56247
+ format: 'date-time',
56248
+ type: 'string',
56249
+ },
56250
+ used_credits: {
56251
+ format: 'float',
56252
+ nullable: true,
56253
+ type: 'number',
56254
+ },
56255
+ },
56256
+ required: [
56257
+ 'trial_started_at',
56258
+ 'trial_ends_at',
56259
+ 'is_active',
56260
+ 'is_suspended',
56261
+ 'trial_credits',
56262
+ 'used_credits',
56263
+ 'remaining_credits',
56264
+ 'is_credits_used_up',
56265
+ ],
56266
+ type: 'object',
56267
+ },
56193
56268
  usage: {
56194
56269
  nullable: true,
56195
56270
  properties: {
@@ -56283,6 +56358,7 @@ const openapi = {
56283
56358
  required: [
56284
56359
  'is_test_mode',
56285
56360
  'credit_subscription',
56361
+ 'trial',
56286
56362
  'usage',
56287
56363
  ],
56288
56364
  type: 'object',
@@ -56456,13 +56532,17 @@ const openapi = {
56456
56532
  },
56457
56533
  recommendation_basis: {
56458
56534
  properties: {
56535
+ is_projected_from_trial: { type: 'boolean' },
56459
56536
  trailing_30_day_tokens: {
56460
56537
  format: 'float',
56461
56538
  nullable: true,
56462
56539
  type: 'number',
56463
56540
  },
56464
56541
  },
56465
- required: ['trailing_30_day_tokens'],
56542
+ required: [
56543
+ 'trailing_30_day_tokens',
56544
+ 'is_projected_from_trial',
56545
+ ],
56466
56546
  type: 'object',
56467
56547
  },
56468
56548
  recommended_package_quantity: {
@@ -56628,7 +56708,37 @@ const openapi = {
56628
56708
  nullable: true,
56629
56709
  type: 'string',
56630
56710
  },
56711
+ pending_upgrade: {
56712
+ nullable: true,
56713
+ properties: {
56714
+ hosted_invoice_url: {
56715
+ nullable: true,
56716
+ type: 'string',
56717
+ },
56718
+ package_quantity: {
56719
+ format: 'float',
56720
+ type: 'number',
56721
+ },
56722
+ },
56723
+ required: ['package_quantity', 'hosted_invoice_url'],
56724
+ type: 'object',
56725
+ },
56631
56726
  price_cents: { format: 'float', type: 'number' },
56727
+ scheduled_change_at: {
56728
+ format: 'date-time',
56729
+ nullable: true,
56730
+ type: 'string',
56731
+ },
56732
+ scheduled_package_quantity: {
56733
+ format: 'float',
56734
+ nullable: true,
56735
+ type: 'number',
56736
+ },
56737
+ scheduled_price_cents: {
56738
+ format: 'float',
56739
+ nullable: true,
56740
+ type: 'number',
56741
+ },
56632
56742
  status: { type: 'string' },
56633
56743
  },
56634
56744
  required: [
@@ -56640,6 +56750,10 @@ const openapi = {
56640
56750
  'current_period_ends_at',
56641
56751
  'past_due_since',
56642
56752
  'canceled_at',
56753
+ 'scheduled_package_quantity',
56754
+ 'scheduled_price_cents',
56755
+ 'scheduled_change_at',
56756
+ 'pending_upgrade',
56643
56757
  ],
56644
56758
  type: 'object',
56645
56759
  },
@@ -56671,6 +56785,296 @@ const openapi = {
56671
56785
  'x-undocumented': 'Internal endpoint for Console',
56672
56786
  },
56673
56787
  },
56788
+ '/seam/console/v1/credits/subscription/change': {
56789
+ post: {
56790
+ description: 'Upgrades to a larger package immediately, charging its full price and carrying the unused credits over, or schedules a downgrade to a smaller package for the end of the current period.',
56791
+ operationId: 'seamConsoleV1CreditsSubscriptionChangePost',
56792
+ requestBody: {
56793
+ content: {
56794
+ 'application/json': {
56795
+ schema: {
56796
+ properties: {
56797
+ organization_id: { format: 'uuid', type: 'string' },
56798
+ package_quantity: {
56799
+ exclusiveMinimum: true,
56800
+ minimum: 0,
56801
+ type: 'integer',
56802
+ },
56803
+ },
56804
+ required: ['organization_id', 'package_quantity'],
56805
+ type: 'object',
56806
+ },
56807
+ },
56808
+ },
56809
+ },
56810
+ responses: {
56811
+ '200': {
56812
+ content: {
56813
+ 'application/json': {
56814
+ schema: {
56815
+ properties: {
56816
+ change: {
56817
+ properties: {
56818
+ carried_credits: {
56819
+ format: 'float',
56820
+ nullable: true,
56821
+ type: 'number',
56822
+ },
56823
+ hosted_invoice_url: { nullable: true, type: 'string' },
56824
+ kind: {
56825
+ enum: ['upgrade', 'downgrade'],
56826
+ type: 'string',
56827
+ },
56828
+ status: {
56829
+ enum: [
56830
+ 'applied',
56831
+ 'scheduled',
56832
+ 'awaiting_authentication',
56833
+ 'processing',
56834
+ ],
56835
+ type: 'string',
56836
+ },
56837
+ },
56838
+ required: [
56839
+ 'kind',
56840
+ 'status',
56841
+ 'hosted_invoice_url',
56842
+ 'carried_credits',
56843
+ ],
56844
+ type: 'object',
56845
+ },
56846
+ credit_subscription: {
56847
+ properties: {
56848
+ canceled_at: {
56849
+ format: 'date-time',
56850
+ nullable: true,
56851
+ type: 'string',
56852
+ },
56853
+ credit_subscription_id: {
56854
+ format: 'uuid',
56855
+ type: 'string',
56856
+ },
56857
+ current_period_ends_at: {
56858
+ format: 'date-time',
56859
+ nullable: true,
56860
+ type: 'string',
56861
+ },
56862
+ current_period_started_at: {
56863
+ format: 'date-time',
56864
+ nullable: true,
56865
+ type: 'string',
56866
+ },
56867
+ package_quantity: { format: 'float', type: 'number' },
56868
+ past_due_since: {
56869
+ format: 'date-time',
56870
+ nullable: true,
56871
+ type: 'string',
56872
+ },
56873
+ pending_upgrade: {
56874
+ nullable: true,
56875
+ properties: {
56876
+ hosted_invoice_url: {
56877
+ nullable: true,
56878
+ type: 'string',
56879
+ },
56880
+ package_quantity: {
56881
+ format: 'float',
56882
+ type: 'number',
56883
+ },
56884
+ },
56885
+ required: ['package_quantity', 'hosted_invoice_url'],
56886
+ type: 'object',
56887
+ },
56888
+ price_cents: { format: 'float', type: 'number' },
56889
+ scheduled_change_at: {
56890
+ format: 'date-time',
56891
+ nullable: true,
56892
+ type: 'string',
56893
+ },
56894
+ scheduled_package_quantity: {
56895
+ format: 'float',
56896
+ nullable: true,
56897
+ type: 'number',
56898
+ },
56899
+ scheduled_price_cents: {
56900
+ format: 'float',
56901
+ nullable: true,
56902
+ type: 'number',
56903
+ },
56904
+ status: { type: 'string' },
56905
+ },
56906
+ required: [
56907
+ 'credit_subscription_id',
56908
+ 'status',
56909
+ 'package_quantity',
56910
+ 'price_cents',
56911
+ 'current_period_started_at',
56912
+ 'current_period_ends_at',
56913
+ 'past_due_since',
56914
+ 'canceled_at',
56915
+ 'scheduled_package_quantity',
56916
+ 'scheduled_price_cents',
56917
+ 'scheduled_change_at',
56918
+ 'pending_upgrade',
56919
+ ],
56920
+ type: 'object',
56921
+ },
56922
+ ok: { type: 'boolean' },
56923
+ },
56924
+ required: ['credit_subscription', 'change', 'ok'],
56925
+ type: 'object',
56926
+ },
56927
+ },
56928
+ },
56929
+ description: 'OK',
56930
+ },
56931
+ '400': { description: 'Bad Request' },
56932
+ '401': { description: 'Unauthorized' },
56933
+ },
56934
+ security: [{ console_session_without_workspace: [] }],
56935
+ summary: '/seam/console/v1/credits/subscription/change',
56936
+ tags: [],
56937
+ 'x-fern-sdk-group-name': [
56938
+ 'seam',
56939
+ 'console',
56940
+ 'v1',
56941
+ 'credits',
56942
+ 'subscription',
56943
+ ],
56944
+ 'x-fern-sdk-method-name': 'change',
56945
+ 'x-response-key': null,
56946
+ 'x-title': "Change a Credit Subscription's Package",
56947
+ 'x-undocumented': 'Internal endpoint for Console',
56948
+ },
56949
+ },
56950
+ '/seam/console/v1/credits/subscription/change/cancel': {
56951
+ post: {
56952
+ description: 'Undoes a package downgrade that has not taken effect yet, so the credit subscription keeps its current package.',
56953
+ operationId: 'seamConsoleV1CreditsSubscriptionChangeCancelPost',
56954
+ requestBody: {
56955
+ content: {
56956
+ 'application/json': {
56957
+ schema: {
56958
+ properties: {
56959
+ organization_id: { format: 'uuid', type: 'string' },
56960
+ },
56961
+ required: ['organization_id'],
56962
+ type: 'object',
56963
+ },
56964
+ },
56965
+ },
56966
+ },
56967
+ responses: {
56968
+ '200': {
56969
+ content: {
56970
+ 'application/json': {
56971
+ schema: {
56972
+ properties: {
56973
+ credit_subscription: {
56974
+ properties: {
56975
+ canceled_at: {
56976
+ format: 'date-time',
56977
+ nullable: true,
56978
+ type: 'string',
56979
+ },
56980
+ credit_subscription_id: {
56981
+ format: 'uuid',
56982
+ type: 'string',
56983
+ },
56984
+ current_period_ends_at: {
56985
+ format: 'date-time',
56986
+ nullable: true,
56987
+ type: 'string',
56988
+ },
56989
+ current_period_started_at: {
56990
+ format: 'date-time',
56991
+ nullable: true,
56992
+ type: 'string',
56993
+ },
56994
+ package_quantity: { format: 'float', type: 'number' },
56995
+ past_due_since: {
56996
+ format: 'date-time',
56997
+ nullable: true,
56998
+ type: 'string',
56999
+ },
57000
+ pending_upgrade: {
57001
+ nullable: true,
57002
+ properties: {
57003
+ hosted_invoice_url: {
57004
+ nullable: true,
57005
+ type: 'string',
57006
+ },
57007
+ package_quantity: {
57008
+ format: 'float',
57009
+ type: 'number',
57010
+ },
57011
+ },
57012
+ required: ['package_quantity', 'hosted_invoice_url'],
57013
+ type: 'object',
57014
+ },
57015
+ price_cents: { format: 'float', type: 'number' },
57016
+ scheduled_change_at: {
57017
+ format: 'date-time',
57018
+ nullable: true,
57019
+ type: 'string',
57020
+ },
57021
+ scheduled_package_quantity: {
57022
+ format: 'float',
57023
+ nullable: true,
57024
+ type: 'number',
57025
+ },
57026
+ scheduled_price_cents: {
57027
+ format: 'float',
57028
+ nullable: true,
57029
+ type: 'number',
57030
+ },
57031
+ status: { type: 'string' },
57032
+ },
57033
+ required: [
57034
+ 'credit_subscription_id',
57035
+ 'status',
57036
+ 'package_quantity',
57037
+ 'price_cents',
57038
+ 'current_period_started_at',
57039
+ 'current_period_ends_at',
57040
+ 'past_due_since',
57041
+ 'canceled_at',
57042
+ 'scheduled_package_quantity',
57043
+ 'scheduled_price_cents',
57044
+ 'scheduled_change_at',
57045
+ 'pending_upgrade',
57046
+ ],
57047
+ type: 'object',
57048
+ },
57049
+ ok: { type: 'boolean' },
57050
+ },
57051
+ required: ['credit_subscription', 'ok'],
57052
+ type: 'object',
57053
+ },
57054
+ },
57055
+ },
57056
+ description: 'OK',
57057
+ },
57058
+ '400': { description: 'Bad Request' },
57059
+ '401': { description: 'Unauthorized' },
57060
+ },
57061
+ security: [{ console_session_without_workspace: [] }],
57062
+ summary: '/seam/console/v1/credits/subscription/change/cancel',
57063
+ tags: [],
57064
+ 'x-fern-sdk-group-name': [
57065
+ 'seam',
57066
+ 'console',
57067
+ 'v1',
57068
+ 'credits',
57069
+ 'subscription',
57070
+ 'change',
57071
+ ],
57072
+ 'x-fern-sdk-method-name': 'cancel',
57073
+ 'x-response-key': null,
57074
+ 'x-title': 'Cancel a Scheduled Credit Package Change',
57075
+ 'x-undocumented': 'Internal endpoint for Console',
57076
+ },
57077
+ },
56674
57078
  '/seam/console/v1/credits/subscription/resume': {
56675
57079
  post: {
56676
57080
  description: 'Undoes a cancellation that has not taken effect yet, so the credit subscription renews at the end of its current period.',
@@ -56721,7 +57125,37 @@ const openapi = {
56721
57125
  nullable: true,
56722
57126
  type: 'string',
56723
57127
  },
57128
+ pending_upgrade: {
57129
+ nullable: true,
57130
+ properties: {
57131
+ hosted_invoice_url: {
57132
+ nullable: true,
57133
+ type: 'string',
57134
+ },
57135
+ package_quantity: {
57136
+ format: 'float',
57137
+ type: 'number',
57138
+ },
57139
+ },
57140
+ required: ['package_quantity', 'hosted_invoice_url'],
57141
+ type: 'object',
57142
+ },
56724
57143
  price_cents: { format: 'float', type: 'number' },
57144
+ scheduled_change_at: {
57145
+ format: 'date-time',
57146
+ nullable: true,
57147
+ type: 'string',
57148
+ },
57149
+ scheduled_package_quantity: {
57150
+ format: 'float',
57151
+ nullable: true,
57152
+ type: 'number',
57153
+ },
57154
+ scheduled_price_cents: {
57155
+ format: 'float',
57156
+ nullable: true,
57157
+ type: 'number',
57158
+ },
56725
57159
  status: { type: 'string' },
56726
57160
  },
56727
57161
  required: [
@@ -56733,6 +57167,10 @@ const openapi = {
56733
57167
  'current_period_ends_at',
56734
57168
  'past_due_since',
56735
57169
  'canceled_at',
57170
+ 'scheduled_package_quantity',
57171
+ 'scheduled_price_cents',
57172
+ 'scheduled_change_at',
57173
+ 'pending_upgrade',
56736
57174
  ],
56737
57175
  type: 'object',
56738
57176
  },