stigg-api-client 2.448.1 → 2.451.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.
@@ -20,55 +20,55 @@
20
20
  "enumValues": [
21
21
  {
22
22
  "name": "BudgetExceeded",
23
- "description": null,
23
+ "description": "The customer has exceeded their usage budget for the feature.",
24
24
  "isDeprecated": false,
25
25
  "deprecationReason": null
26
26
  },
27
27
  {
28
28
  "name": "CustomerIsArchived",
29
- "description": null,
29
+ "description": "The customer is archived and no longer eligible for entitlements.",
30
30
  "isDeprecated": false,
31
31
  "deprecationReason": null
32
32
  },
33
33
  {
34
34
  "name": "CustomerNotFound",
35
- "description": null,
35
+ "description": "The customer making the request could not be found.",
36
36
  "isDeprecated": false,
37
37
  "deprecationReason": null
38
38
  },
39
39
  {
40
40
  "name": "CustomerResourceNotFound",
41
- "description": null,
41
+ "description": "The resource associated with the customer could not be found.",
42
42
  "isDeprecated": false,
43
43
  "deprecationReason": null
44
44
  },
45
45
  {
46
46
  "name": "FeatureNotFound",
47
- "description": null,
47
+ "description": "The requested feature does not exist or is not defined in the current environment.",
48
48
  "isDeprecated": false,
49
49
  "deprecationReason": null
50
50
  },
51
51
  {
52
52
  "name": "NoActiveSubscription",
53
- "description": null,
53
+ "description": "The customer does not have any active subscription linked to the feature.",
54
54
  "isDeprecated": false,
55
55
  "deprecationReason": null
56
56
  },
57
57
  {
58
58
  "name": "NoFeatureEntitlementInSubscription",
59
- "description": null,
59
+ "description": "The current subscription does not include entitlement to the requested feature.",
60
60
  "isDeprecated": false,
61
61
  "deprecationReason": null
62
62
  },
63
63
  {
64
64
  "name": "RequestedUsageExceedingLimit",
65
- "description": null,
65
+ "description": "The customers usage request exceeds their entitled limit.",
66
66
  "isDeprecated": false,
67
67
  "deprecationReason": null
68
68
  },
69
69
  {
70
70
  "name": "Unknown",
71
- "description": null,
71
+ "description": "The access denial occurred for an unknown or unexpected reason.",
72
72
  "isDeprecated": false,
73
73
  "deprecationReason": null
74
74
  }
@@ -3182,19 +3182,19 @@
3182
3182
  "enumValues": [
3183
3183
  {
3184
3184
  "name": "CENTER",
3185
- "description": null,
3185
+ "description": "Align content to the horizontal center of the container.",
3186
3186
  "isDeprecated": false,
3187
3187
  "deprecationReason": null
3188
3188
  },
3189
3189
  {
3190
3190
  "name": "LEFT",
3191
- "description": null,
3191
+ "description": "Align content to the left edge of the container.",
3192
3192
  "isDeprecated": false,
3193
3193
  "deprecationReason": null
3194
3194
  },
3195
3195
  {
3196
3196
  "name": "RIGHT",
3197
- "description": null,
3197
+ "description": "Align content to the right edge of the container.",
3198
3198
  "isDeprecated": false,
3199
3199
  "deprecationReason": null
3200
3200
  }
@@ -6807,11 +6807,11 @@
6807
6807
  {
6808
6808
  "kind": "OBJECT",
6809
6809
  "name": "CheckoutColorPalette",
6810
- "description": null,
6810
+ "description": "Color settings for the checkout widget.",
6811
6811
  "fields": [
6812
6812
  {
6813
6813
  "name": "backgroundColor",
6814
- "description": null,
6814
+ "description": "Main background color of the checkout UI.",
6815
6815
  "args": [],
6816
6816
  "type": {
6817
6817
  "kind": "SCALAR",
@@ -6823,7 +6823,7 @@
6823
6823
  },
6824
6824
  {
6825
6825
  "name": "borderColor",
6826
- "description": null,
6826
+ "description": "Color used for borders and dividers in the checkout widget.",
6827
6827
  "args": [],
6828
6828
  "type": {
6829
6829
  "kind": "SCALAR",
@@ -6835,7 +6835,7 @@
6835
6835
  },
6836
6836
  {
6837
6837
  "name": "primary",
6838
- "description": null,
6838
+ "description": "Primary accent color used in the checkout UI.",
6839
6839
  "args": [],
6840
6840
  "type": {
6841
6841
  "kind": "SCALAR",
@@ -6847,7 +6847,7 @@
6847
6847
  },
6848
6848
  {
6849
6849
  "name": "summaryBackgroundColor",
6850
- "description": null,
6850
+ "description": "Background color for the order summary section.",
6851
6851
  "args": [],
6852
6852
  "type": {
6853
6853
  "kind": "SCALAR",
@@ -6859,7 +6859,7 @@
6859
6859
  },
6860
6860
  {
6861
6861
  "name": "textColor",
6862
- "description": null,
6862
+ "description": "Text color used throughout the checkout widget.",
6863
6863
  "args": [],
6864
6864
  "type": {
6865
6865
  "kind": "SCALAR",
@@ -6878,11 +6878,11 @@
6878
6878
  {
6879
6879
  "kind": "OBJECT",
6880
6880
  "name": "CheckoutConfiguration",
6881
- "description": null,
6881
+ "description": "Checkout-specific widget configuration.",
6882
6882
  "fields": [
6883
6883
  {
6884
6884
  "name": "content",
6885
- "description": null,
6885
+ "description": "Dynamic content configuration like optional data fields.",
6886
6886
  "args": [],
6887
6887
  "type": {
6888
6888
  "kind": "OBJECT",
@@ -6894,7 +6894,7 @@
6894
6894
  },
6895
6895
  {
6896
6896
  "name": "customCss",
6897
- "description": null,
6897
+ "description": "Custom CSS styles to override default checkout UI styles.",
6898
6898
  "args": [],
6899
6899
  "type": {
6900
6900
  "kind": "SCALAR",
@@ -6906,7 +6906,7 @@
6906
6906
  },
6907
6907
  {
6908
6908
  "name": "palette",
6909
- "description": null,
6909
+ "description": "Custom color palette used in the checkout UI.",
6910
6910
  "args": [],
6911
6911
  "type": {
6912
6912
  "kind": "OBJECT",
@@ -6918,7 +6918,7 @@
6918
6918
  },
6919
6919
  {
6920
6920
  "name": "typography",
6921
- "description": null,
6921
+ "description": "Font and text styling used in the checkout widget.",
6922
6922
  "args": [],
6923
6923
  "type": {
6924
6924
  "kind": "OBJECT",
@@ -6937,12 +6937,12 @@
6937
6937
  {
6938
6938
  "kind": "INPUT_OBJECT",
6939
6939
  "name": "CheckoutConfigurationInput",
6940
- "description": null,
6940
+ "description": "Input for setting up the checkout widget’s design.",
6941
6941
  "fields": null,
6942
6942
  "inputFields": [
6943
6943
  {
6944
6944
  "name": "content",
6945
- "description": null,
6945
+ "description": "Additional content settings such as form fields.",
6946
6946
  "type": {
6947
6947
  "kind": "INPUT_OBJECT",
6948
6948
  "name": "CheckoutContentInput",
@@ -6954,7 +6954,7 @@
6954
6954
  },
6955
6955
  {
6956
6956
  "name": "customCss",
6957
- "description": null,
6957
+ "description": "Custom styles to override default checkout appearance.",
6958
6958
  "type": {
6959
6959
  "kind": "SCALAR",
6960
6960
  "name": "String",
@@ -6966,7 +6966,7 @@
6966
6966
  },
6967
6967
  {
6968
6968
  "name": "palette",
6969
- "description": null,
6969
+ "description": "Color palette settings for the checkout process.",
6970
6970
  "type": {
6971
6971
  "kind": "INPUT_OBJECT",
6972
6972
  "name": "CheckoutPaletteInput",
@@ -6978,7 +6978,7 @@
6978
6978
  },
6979
6979
  {
6980
6980
  "name": "typography",
6981
- "description": null,
6981
+ "description": "Typography options for headings and text in checkout.",
6982
6982
  "type": {
6983
6983
  "kind": "INPUT_OBJECT",
6984
6984
  "name": "TypographyConfigurationInput",
@@ -6996,11 +6996,11 @@
6996
6996
  {
6997
6997
  "kind": "OBJECT",
6998
6998
  "name": "CheckoutContent",
6999
- "description": null,
6999
+ "description": "Content-related settings for the checkout experience.",
7000
7000
  "fields": [
7001
7001
  {
7002
7002
  "name": "collectPhoneNumber",
7003
- "description": null,
7003
+ "description": "Specifies whether the customers phone number should be collected during checkout.",
7004
7004
  "args": [],
7005
7005
  "type": {
7006
7006
  "kind": "SCALAR",
@@ -7019,12 +7019,12 @@
7019
7019
  {
7020
7020
  "kind": "INPUT_OBJECT",
7021
7021
  "name": "CheckoutContentInput",
7022
- "description": null,
7022
+ "description": "Input for content customization in the checkout process.",
7023
7023
  "fields": null,
7024
7024
  "inputFields": [
7025
7025
  {
7026
7026
  "name": "collectPhoneNumber",
7027
- "description": null,
7027
+ "description": "Indicates whether the checkout form should ask for a phone number.",
7028
7028
  "type": {
7029
7029
  "kind": "SCALAR",
7030
7030
  "name": "Boolean",
@@ -7188,12 +7188,12 @@
7188
7188
  {
7189
7189
  "kind": "INPUT_OBJECT",
7190
7190
  "name": "CheckoutPaletteInput",
7191
- "description": null,
7191
+ "description": "Input for customizing checkout color scheme.",
7192
7192
  "fields": null,
7193
7193
  "inputFields": [
7194
7194
  {
7195
7195
  "name": "backgroundColor",
7196
- "description": null,
7196
+ "description": "Background color of the widget.",
7197
7197
  "type": {
7198
7198
  "kind": "SCALAR",
7199
7199
  "name": "String",
@@ -7205,7 +7205,7 @@
7205
7205
  },
7206
7206
  {
7207
7207
  "name": "borderColor",
7208
- "description": null,
7208
+ "description": "Color applied to widget borders or separators.",
7209
7209
  "type": {
7210
7210
  "kind": "SCALAR",
7211
7211
  "name": "String",
@@ -7217,7 +7217,7 @@
7217
7217
  },
7218
7218
  {
7219
7219
  "name": "primary",
7220
- "description": null,
7220
+ "description": "Primary accent color used throughout the widget.",
7221
7221
  "type": {
7222
7222
  "kind": "SCALAR",
7223
7223
  "name": "String",
@@ -7229,7 +7229,7 @@
7229
7229
  },
7230
7230
  {
7231
7231
  "name": "summaryBackgroundColor",
7232
- "description": null,
7232
+ "description": "Background color for the order summary section during checkout.",
7233
7233
  "type": {
7234
7234
  "kind": "SCALAR",
7235
7235
  "name": "String",
@@ -7241,7 +7241,7 @@
7241
7241
  },
7242
7242
  {
7243
7243
  "name": "textColor",
7244
- "description": null,
7244
+ "description": "Default color used for text content.",
7245
7245
  "type": {
7246
7246
  "kind": "SCALAR",
7247
7247
  "name": "String",
@@ -7449,12 +7449,12 @@
7449
7449
  {
7450
7450
  "kind": "INPUT_OBJECT",
7451
7451
  "name": "ClearCustomerPersistentCacheInput",
7452
- "description": null,
7452
+ "description": "Input for clearing a customers persistent cache.",
7453
7453
  "fields": null,
7454
7454
  "inputFields": [
7455
7455
  {
7456
7456
  "name": "customerId",
7457
- "description": null,
7457
+ "description": "The unique identifier of the customer whose cache should be cleared.",
7458
7458
  "type": {
7459
7459
  "kind": "NON_NULL",
7460
7460
  "name": null,
@@ -7482,7 +7482,7 @@
7482
7482
  },
7483
7483
  {
7484
7484
  "name": "resourceId",
7485
- "description": null,
7485
+ "description": "The resource ID scoped to the customer.",
7486
7486
  "type": {
7487
7487
  "kind": "SCALAR",
7488
7488
  "name": "String",
@@ -11059,697 +11059,697 @@
11059
11059
  "enumValues": [
11060
11060
  {
11061
11061
  "name": "AED",
11062
- "description": null,
11062
+ "description": "UAE Dirham",
11063
11063
  "isDeprecated": false,
11064
11064
  "deprecationReason": null
11065
11065
  },
11066
11066
  {
11067
11067
  "name": "ALL",
11068
- "description": null,
11068
+ "description": "Lek",
11069
11069
  "isDeprecated": false,
11070
11070
  "deprecationReason": null
11071
11071
  },
11072
11072
  {
11073
11073
  "name": "AMD",
11074
- "description": null,
11074
+ "description": "Armenian Dram",
11075
11075
  "isDeprecated": false,
11076
11076
  "deprecationReason": null
11077
11077
  },
11078
11078
  {
11079
11079
  "name": "ANG",
11080
- "description": null,
11080
+ "description": "Netherlands Antillean Guilder",
11081
11081
  "isDeprecated": false,
11082
11082
  "deprecationReason": null
11083
11083
  },
11084
11084
  {
11085
11085
  "name": "AUD",
11086
- "description": null,
11086
+ "description": "Australian Dollar",
11087
11087
  "isDeprecated": false,
11088
11088
  "deprecationReason": null
11089
11089
  },
11090
11090
  {
11091
11091
  "name": "AWG",
11092
- "description": null,
11092
+ "description": "Aruban Florin",
11093
11093
  "isDeprecated": false,
11094
11094
  "deprecationReason": null
11095
11095
  },
11096
11096
  {
11097
11097
  "name": "AZN",
11098
- "description": null,
11098
+ "description": "Azerbaijanian Manat",
11099
11099
  "isDeprecated": false,
11100
11100
  "deprecationReason": null
11101
11101
  },
11102
11102
  {
11103
11103
  "name": "BAM",
11104
- "description": null,
11104
+ "description": "Convertible Mark",
11105
11105
  "isDeprecated": false,
11106
11106
  "deprecationReason": null
11107
11107
  },
11108
11108
  {
11109
11109
  "name": "BBD",
11110
- "description": null,
11110
+ "description": "Barbados Dollar",
11111
11111
  "isDeprecated": false,
11112
11112
  "deprecationReason": null
11113
11113
  },
11114
11114
  {
11115
11115
  "name": "BDT",
11116
- "description": null,
11116
+ "description": "Taka",
11117
11117
  "isDeprecated": false,
11118
11118
  "deprecationReason": null
11119
11119
  },
11120
11120
  {
11121
11121
  "name": "BGN",
11122
- "description": null,
11122
+ "description": "Bulgarian Lev",
11123
11123
  "isDeprecated": false,
11124
11124
  "deprecationReason": null
11125
11125
  },
11126
11126
  {
11127
11127
  "name": "BIF",
11128
- "description": null,
11128
+ "description": "Burundi Franc",
11129
11129
  "isDeprecated": false,
11130
11130
  "deprecationReason": null
11131
11131
  },
11132
11132
  {
11133
11133
  "name": "BMD",
11134
- "description": null,
11134
+ "description": "Bermudian Dollar",
11135
11135
  "isDeprecated": false,
11136
11136
  "deprecationReason": null
11137
11137
  },
11138
11138
  {
11139
11139
  "name": "BND",
11140
- "description": null,
11140
+ "description": "Brunei Dollar",
11141
11141
  "isDeprecated": false,
11142
11142
  "deprecationReason": null
11143
11143
  },
11144
11144
  {
11145
11145
  "name": "BRL",
11146
- "description": null,
11146
+ "description": "Brazilian Real",
11147
11147
  "isDeprecated": false,
11148
11148
  "deprecationReason": null
11149
11149
  },
11150
11150
  {
11151
11151
  "name": "BSD",
11152
- "description": null,
11152
+ "description": "Bahamian Dollar",
11153
11153
  "isDeprecated": false,
11154
11154
  "deprecationReason": null
11155
11155
  },
11156
11156
  {
11157
11157
  "name": "BWP",
11158
- "description": null,
11158
+ "description": "Pula",
11159
11159
  "isDeprecated": false,
11160
11160
  "deprecationReason": null
11161
11161
  },
11162
11162
  {
11163
11163
  "name": "BYN",
11164
- "description": null,
11164
+ "description": "Belarusian Ruble",
11165
11165
  "isDeprecated": false,
11166
11166
  "deprecationReason": null
11167
11167
  },
11168
11168
  {
11169
11169
  "name": "BZD",
11170
- "description": null,
11170
+ "description": "Belize Dollar",
11171
11171
  "isDeprecated": false,
11172
11172
  "deprecationReason": null
11173
11173
  },
11174
11174
  {
11175
11175
  "name": "CAD",
11176
- "description": null,
11176
+ "description": "Canadian Dollar",
11177
11177
  "isDeprecated": false,
11178
11178
  "deprecationReason": null
11179
11179
  },
11180
11180
  {
11181
11181
  "name": "CDF",
11182
- "description": null,
11182
+ "description": "Congolese Franc",
11183
11183
  "isDeprecated": false,
11184
11184
  "deprecationReason": null
11185
11185
  },
11186
11186
  {
11187
11187
  "name": "CHF",
11188
- "description": null,
11188
+ "description": "Swiss Franc",
11189
11189
  "isDeprecated": false,
11190
11190
  "deprecationReason": null
11191
11191
  },
11192
11192
  {
11193
11193
  "name": "CLP",
11194
- "description": null,
11194
+ "description": "Chilean Peso",
11195
11195
  "isDeprecated": false,
11196
11196
  "deprecationReason": null
11197
11197
  },
11198
11198
  {
11199
11199
  "name": "CNY",
11200
- "description": null,
11200
+ "description": "Yuan Renminbi",
11201
11201
  "isDeprecated": false,
11202
11202
  "deprecationReason": null
11203
11203
  },
11204
11204
  {
11205
11205
  "name": "CZK",
11206
- "description": null,
11206
+ "description": "Czech Koruna",
11207
11207
  "isDeprecated": false,
11208
11208
  "deprecationReason": null
11209
11209
  },
11210
11210
  {
11211
11211
  "name": "DJF",
11212
- "description": null,
11212
+ "description": "Djibouti Franc",
11213
11213
  "isDeprecated": false,
11214
11214
  "deprecationReason": null
11215
11215
  },
11216
11216
  {
11217
11217
  "name": "DKK",
11218
- "description": null,
11218
+ "description": "Danish Krone",
11219
11219
  "isDeprecated": false,
11220
11220
  "deprecationReason": null
11221
11221
  },
11222
11222
  {
11223
11223
  "name": "DOP",
11224
- "description": null,
11224
+ "description": "Dominican Peso",
11225
11225
  "isDeprecated": false,
11226
11226
  "deprecationReason": null
11227
11227
  },
11228
11228
  {
11229
11229
  "name": "DZD",
11230
- "description": null,
11230
+ "description": "Algerian Dinar",
11231
11231
  "isDeprecated": false,
11232
11232
  "deprecationReason": null
11233
11233
  },
11234
11234
  {
11235
11235
  "name": "EGP",
11236
- "description": null,
11236
+ "description": "Egyptian Pound",
11237
11237
  "isDeprecated": false,
11238
11238
  "deprecationReason": null
11239
11239
  },
11240
11240
  {
11241
11241
  "name": "ETB",
11242
- "description": null,
11242
+ "description": "Ethiopian Birr",
11243
11243
  "isDeprecated": false,
11244
11244
  "deprecationReason": null
11245
11245
  },
11246
11246
  {
11247
11247
  "name": "EUR",
11248
- "description": null,
11248
+ "description": "Euro",
11249
11249
  "isDeprecated": false,
11250
11250
  "deprecationReason": null
11251
11251
  },
11252
11252
  {
11253
11253
  "name": "FJD",
11254
- "description": null,
11254
+ "description": "Fiji Dollar",
11255
11255
  "isDeprecated": false,
11256
11256
  "deprecationReason": null
11257
11257
  },
11258
11258
  {
11259
11259
  "name": "GBP",
11260
- "description": null,
11260
+ "description": "Pound Sterling",
11261
11261
  "isDeprecated": false,
11262
11262
  "deprecationReason": null
11263
11263
  },
11264
11264
  {
11265
11265
  "name": "GEL",
11266
- "description": null,
11266
+ "description": "Lari",
11267
11267
  "isDeprecated": false,
11268
11268
  "deprecationReason": null
11269
11269
  },
11270
11270
  {
11271
11271
  "name": "GIP",
11272
- "description": null,
11272
+ "description": "Gibraltar Pound",
11273
11273
  "isDeprecated": false,
11274
11274
  "deprecationReason": null
11275
11275
  },
11276
11276
  {
11277
11277
  "name": "GMD",
11278
- "description": null,
11278
+ "description": "Dalasi",
11279
11279
  "isDeprecated": false,
11280
11280
  "deprecationReason": null
11281
11281
  },
11282
11282
  {
11283
11283
  "name": "GNF",
11284
- "description": null,
11284
+ "description": "Guinea Franc",
11285
11285
  "isDeprecated": false,
11286
11286
  "deprecationReason": null
11287
11287
  },
11288
11288
  {
11289
11289
  "name": "GYD",
11290
- "description": null,
11290
+ "description": "Guyana Dollar",
11291
11291
  "isDeprecated": false,
11292
11292
  "deprecationReason": null
11293
11293
  },
11294
11294
  {
11295
11295
  "name": "HKD",
11296
- "description": null,
11296
+ "description": "Hong Kong Dollar",
11297
11297
  "isDeprecated": false,
11298
11298
  "deprecationReason": null
11299
11299
  },
11300
11300
  {
11301
11301
  "name": "HRK",
11302
- "description": null,
11302
+ "description": "Kuna",
11303
11303
  "isDeprecated": false,
11304
11304
  "deprecationReason": null
11305
11305
  },
11306
11306
  {
11307
11307
  "name": "HTG",
11308
- "description": null,
11308
+ "description": "Gourde",
11309
11309
  "isDeprecated": false,
11310
11310
  "deprecationReason": null
11311
11311
  },
11312
11312
  {
11313
11313
  "name": "IDR",
11314
- "description": null,
11314
+ "description": "Rupiah",
11315
11315
  "isDeprecated": false,
11316
11316
  "deprecationReason": null
11317
11317
  },
11318
11318
  {
11319
11319
  "name": "ILS",
11320
- "description": null,
11320
+ "description": "New Israeli Sheqel",
11321
11321
  "isDeprecated": false,
11322
11322
  "deprecationReason": null
11323
11323
  },
11324
11324
  {
11325
11325
  "name": "INR",
11326
- "description": null,
11326
+ "description": "Indian Rupee",
11327
11327
  "isDeprecated": false,
11328
11328
  "deprecationReason": null
11329
11329
  },
11330
11330
  {
11331
11331
  "name": "ISK",
11332
- "description": null,
11332
+ "description": "Iceland Krona",
11333
11333
  "isDeprecated": false,
11334
11334
  "deprecationReason": null
11335
11335
  },
11336
11336
  {
11337
11337
  "name": "JMD",
11338
- "description": null,
11338
+ "description": "Jamaican Dollar",
11339
11339
  "isDeprecated": false,
11340
11340
  "deprecationReason": null
11341
11341
  },
11342
11342
  {
11343
11343
  "name": "JPY",
11344
- "description": null,
11344
+ "description": "Yen",
11345
11345
  "isDeprecated": false,
11346
11346
  "deprecationReason": null
11347
11347
  },
11348
11348
  {
11349
11349
  "name": "KES",
11350
- "description": null,
11350
+ "description": "Kenyan Shilling",
11351
11351
  "isDeprecated": false,
11352
11352
  "deprecationReason": null
11353
11353
  },
11354
11354
  {
11355
11355
  "name": "KGS",
11356
- "description": null,
11356
+ "description": "Som",
11357
11357
  "isDeprecated": false,
11358
11358
  "deprecationReason": null
11359
11359
  },
11360
11360
  {
11361
11361
  "name": "KHR",
11362
- "description": null,
11362
+ "description": "Riel",
11363
11363
  "isDeprecated": false,
11364
11364
  "deprecationReason": null
11365
11365
  },
11366
11366
  {
11367
11367
  "name": "KMF",
11368
- "description": null,
11368
+ "description": "Comoro Franc",
11369
11369
  "isDeprecated": false,
11370
11370
  "deprecationReason": null
11371
11371
  },
11372
11372
  {
11373
11373
  "name": "KRW",
11374
- "description": null,
11374
+ "description": "Won",
11375
11375
  "isDeprecated": false,
11376
11376
  "deprecationReason": null
11377
11377
  },
11378
11378
  {
11379
11379
  "name": "KYD",
11380
- "description": null,
11380
+ "description": "Cayman Islands Dollar",
11381
11381
  "isDeprecated": false,
11382
11382
  "deprecationReason": null
11383
11383
  },
11384
11384
  {
11385
11385
  "name": "KZT",
11386
- "description": null,
11386
+ "description": "Tenge",
11387
11387
  "isDeprecated": false,
11388
11388
  "deprecationReason": null
11389
11389
  },
11390
11390
  {
11391
11391
  "name": "LBP",
11392
- "description": null,
11392
+ "description": "Lebanese Pound",
11393
11393
  "isDeprecated": false,
11394
11394
  "deprecationReason": null
11395
11395
  },
11396
11396
  {
11397
11397
  "name": "LKR",
11398
- "description": null,
11398
+ "description": "Sri Lanka Rupee",
11399
11399
  "isDeprecated": false,
11400
11400
  "deprecationReason": null
11401
11401
  },
11402
11402
  {
11403
11403
  "name": "LRD",
11404
- "description": null,
11404
+ "description": "Liberian Dollar",
11405
11405
  "isDeprecated": false,
11406
11406
  "deprecationReason": null
11407
11407
  },
11408
11408
  {
11409
11409
  "name": "LSL",
11410
- "description": null,
11410
+ "description": "Loti",
11411
11411
  "isDeprecated": false,
11412
11412
  "deprecationReason": null
11413
11413
  },
11414
11414
  {
11415
11415
  "name": "MAD",
11416
- "description": null,
11416
+ "description": "Moroccan Dirham",
11417
11417
  "isDeprecated": false,
11418
11418
  "deprecationReason": null
11419
11419
  },
11420
11420
  {
11421
11421
  "name": "MDL",
11422
- "description": null,
11422
+ "description": "Moldovan Leu",
11423
11423
  "isDeprecated": false,
11424
11424
  "deprecationReason": null
11425
11425
  },
11426
11426
  {
11427
11427
  "name": "MGA",
11428
- "description": null,
11428
+ "description": "Malagasy Ariary",
11429
11429
  "isDeprecated": false,
11430
11430
  "deprecationReason": null
11431
11431
  },
11432
11432
  {
11433
11433
  "name": "MKD",
11434
- "description": null,
11434
+ "description": "Denar",
11435
11435
  "isDeprecated": false,
11436
11436
  "deprecationReason": null
11437
11437
  },
11438
11438
  {
11439
11439
  "name": "MMK",
11440
- "description": null,
11440
+ "description": "Kyat",
11441
11441
  "isDeprecated": false,
11442
11442
  "deprecationReason": null
11443
11443
  },
11444
11444
  {
11445
11445
  "name": "MNT",
11446
- "description": null,
11446
+ "description": "Tugrik",
11447
11447
  "isDeprecated": false,
11448
11448
  "deprecationReason": null
11449
11449
  },
11450
11450
  {
11451
11451
  "name": "MOP",
11452
- "description": null,
11452
+ "description": "Pataca",
11453
11453
  "isDeprecated": false,
11454
11454
  "deprecationReason": null
11455
11455
  },
11456
11456
  {
11457
11457
  "name": "MRO",
11458
- "description": null,
11458
+ "description": "Ouguiya",
11459
11459
  "isDeprecated": false,
11460
11460
  "deprecationReason": null
11461
11461
  },
11462
11462
  {
11463
11463
  "name": "MVR",
11464
- "description": null,
11464
+ "description": "Rufiyaa",
11465
11465
  "isDeprecated": false,
11466
11466
  "deprecationReason": null
11467
11467
  },
11468
11468
  {
11469
11469
  "name": "MWK",
11470
- "description": null,
11470
+ "description": "Malawi Kwacha",
11471
11471
  "isDeprecated": false,
11472
11472
  "deprecationReason": null
11473
11473
  },
11474
11474
  {
11475
11475
  "name": "MXN",
11476
- "description": null,
11476
+ "description": "Mexican Peso",
11477
11477
  "isDeprecated": false,
11478
11478
  "deprecationReason": null
11479
11479
  },
11480
11480
  {
11481
11481
  "name": "MYR",
11482
- "description": null,
11482
+ "description": "Malaysian Ringgit",
11483
11483
  "isDeprecated": false,
11484
11484
  "deprecationReason": null
11485
11485
  },
11486
11486
  {
11487
11487
  "name": "MZN",
11488
- "description": null,
11488
+ "description": "Mozambique Metical",
11489
11489
  "isDeprecated": false,
11490
11490
  "deprecationReason": null
11491
11491
  },
11492
11492
  {
11493
11493
  "name": "NAD",
11494
- "description": null,
11494
+ "description": "Namibia Dollar",
11495
11495
  "isDeprecated": false,
11496
11496
  "deprecationReason": null
11497
11497
  },
11498
11498
  {
11499
11499
  "name": "NGN",
11500
- "description": null,
11500
+ "description": "Naira",
11501
11501
  "isDeprecated": false,
11502
11502
  "deprecationReason": null
11503
11503
  },
11504
11504
  {
11505
11505
  "name": "NOK",
11506
- "description": null,
11506
+ "description": "Norwegian Krone",
11507
11507
  "isDeprecated": false,
11508
11508
  "deprecationReason": null
11509
11509
  },
11510
11510
  {
11511
11511
  "name": "NPR",
11512
- "description": null,
11512
+ "description": "Nepalese Rupee",
11513
11513
  "isDeprecated": false,
11514
11514
  "deprecationReason": null
11515
11515
  },
11516
11516
  {
11517
11517
  "name": "NZD",
11518
- "description": null,
11518
+ "description": "New Zealand Dollar",
11519
11519
  "isDeprecated": false,
11520
11520
  "deprecationReason": null
11521
11521
  },
11522
11522
  {
11523
11523
  "name": "PGK",
11524
- "description": null,
11524
+ "description": "Kina",
11525
11525
  "isDeprecated": false,
11526
11526
  "deprecationReason": null
11527
11527
  },
11528
11528
  {
11529
11529
  "name": "PHP",
11530
- "description": null,
11530
+ "description": "Philippine Peso",
11531
11531
  "isDeprecated": false,
11532
11532
  "deprecationReason": null
11533
11533
  },
11534
11534
  {
11535
11535
  "name": "PKR",
11536
- "description": null,
11536
+ "description": "Pakistan Rupee",
11537
11537
  "isDeprecated": false,
11538
11538
  "deprecationReason": null
11539
11539
  },
11540
11540
  {
11541
11541
  "name": "PLN",
11542
- "description": null,
11542
+ "description": "Zloty",
11543
11543
  "isDeprecated": false,
11544
11544
  "deprecationReason": null
11545
11545
  },
11546
11546
  {
11547
11547
  "name": "PYG",
11548
- "description": null,
11548
+ "description": "Guarani",
11549
11549
  "isDeprecated": false,
11550
11550
  "deprecationReason": null
11551
11551
  },
11552
11552
  {
11553
11553
  "name": "QAR",
11554
- "description": null,
11554
+ "description": "Qatari Rial",
11555
11555
  "isDeprecated": false,
11556
11556
  "deprecationReason": null
11557
11557
  },
11558
11558
  {
11559
11559
  "name": "RON",
11560
- "description": null,
11560
+ "description": "Romanian Leu",
11561
11561
  "isDeprecated": false,
11562
11562
  "deprecationReason": null
11563
11563
  },
11564
11564
  {
11565
11565
  "name": "RSD",
11566
- "description": null,
11566
+ "description": "Serbian Dinar",
11567
11567
  "isDeprecated": false,
11568
11568
  "deprecationReason": null
11569
11569
  },
11570
11570
  {
11571
11571
  "name": "RUB",
11572
- "description": null,
11572
+ "description": "Russian Ruble",
11573
11573
  "isDeprecated": false,
11574
11574
  "deprecationReason": null
11575
11575
  },
11576
11576
  {
11577
11577
  "name": "RWF",
11578
- "description": null,
11578
+ "description": "Rwanda Franc",
11579
11579
  "isDeprecated": false,
11580
11580
  "deprecationReason": null
11581
11581
  },
11582
11582
  {
11583
11583
  "name": "SAR",
11584
- "description": null,
11584
+ "description": "Saudi Riyal",
11585
11585
  "isDeprecated": false,
11586
11586
  "deprecationReason": null
11587
11587
  },
11588
11588
  {
11589
11589
  "name": "SBD",
11590
- "description": null,
11590
+ "description": "Solomon Islands Dollar",
11591
11591
  "isDeprecated": false,
11592
11592
  "deprecationReason": null
11593
11593
  },
11594
11594
  {
11595
11595
  "name": "SCR",
11596
- "description": null,
11596
+ "description": "Seychelles Rupee",
11597
11597
  "isDeprecated": false,
11598
11598
  "deprecationReason": null
11599
11599
  },
11600
11600
  {
11601
11601
  "name": "SEK",
11602
- "description": null,
11602
+ "description": "Swedish Krona",
11603
11603
  "isDeprecated": false,
11604
11604
  "deprecationReason": null
11605
11605
  },
11606
11606
  {
11607
11607
  "name": "SGD",
11608
- "description": null,
11608
+ "description": "Singapore Dollar",
11609
11609
  "isDeprecated": false,
11610
11610
  "deprecationReason": null
11611
11611
  },
11612
11612
  {
11613
11613
  "name": "SLE",
11614
- "description": null,
11614
+ "description": "Unknown or special currency code",
11615
11615
  "isDeprecated": false,
11616
11616
  "deprecationReason": null
11617
11617
  },
11618
11618
  {
11619
11619
  "name": "SLL",
11620
- "description": null,
11620
+ "description": "Leone",
11621
11621
  "isDeprecated": false,
11622
11622
  "deprecationReason": null
11623
11623
  },
11624
11624
  {
11625
11625
  "name": "SOS",
11626
- "description": null,
11626
+ "description": "Somali Shilling",
11627
11627
  "isDeprecated": false,
11628
11628
  "deprecationReason": null
11629
11629
  },
11630
11630
  {
11631
11631
  "name": "SZL",
11632
- "description": null,
11632
+ "description": "Lilangeni",
11633
11633
  "isDeprecated": false,
11634
11634
  "deprecationReason": null
11635
11635
  },
11636
11636
  {
11637
11637
  "name": "THB",
11638
- "description": null,
11638
+ "description": "Baht",
11639
11639
  "isDeprecated": false,
11640
11640
  "deprecationReason": null
11641
11641
  },
11642
11642
  {
11643
11643
  "name": "TJS",
11644
- "description": null,
11644
+ "description": "Somoni",
11645
11645
  "isDeprecated": false,
11646
11646
  "deprecationReason": null
11647
11647
  },
11648
11648
  {
11649
11649
  "name": "TOP",
11650
- "description": null,
11650
+ "description": "Paanga",
11651
11651
  "isDeprecated": false,
11652
11652
  "deprecationReason": null
11653
11653
  },
11654
11654
  {
11655
11655
  "name": "TRY",
11656
- "description": null,
11656
+ "description": "Turkish Lira",
11657
11657
  "isDeprecated": false,
11658
11658
  "deprecationReason": null
11659
11659
  },
11660
11660
  {
11661
11661
  "name": "TTD",
11662
- "description": null,
11662
+ "description": "Trinidad and Tobago Dollar",
11663
11663
  "isDeprecated": false,
11664
11664
  "deprecationReason": null
11665
11665
  },
11666
11666
  {
11667
11667
  "name": "TZS",
11668
- "description": null,
11668
+ "description": "Tanzanian Shilling",
11669
11669
  "isDeprecated": false,
11670
11670
  "deprecationReason": null
11671
11671
  },
11672
11672
  {
11673
11673
  "name": "UAH",
11674
- "description": null,
11674
+ "description": "Hryvnia",
11675
11675
  "isDeprecated": false,
11676
11676
  "deprecationReason": null
11677
11677
  },
11678
11678
  {
11679
11679
  "name": "UGX",
11680
- "description": null,
11680
+ "description": "Uganda Shilling",
11681
11681
  "isDeprecated": false,
11682
11682
  "deprecationReason": null
11683
11683
  },
11684
11684
  {
11685
11685
  "name": "USD",
11686
- "description": null,
11686
+ "description": "US Dollar",
11687
11687
  "isDeprecated": false,
11688
11688
  "deprecationReason": null
11689
11689
  },
11690
11690
  {
11691
11691
  "name": "UZS",
11692
- "description": null,
11692
+ "description": "Uzbekistan Sum",
11693
11693
  "isDeprecated": false,
11694
11694
  "deprecationReason": null
11695
11695
  },
11696
11696
  {
11697
11697
  "name": "VND",
11698
- "description": null,
11698
+ "description": "Dong",
11699
11699
  "isDeprecated": false,
11700
11700
  "deprecationReason": null
11701
11701
  },
11702
11702
  {
11703
11703
  "name": "VUV",
11704
- "description": null,
11704
+ "description": "Vatu",
11705
11705
  "isDeprecated": false,
11706
11706
  "deprecationReason": null
11707
11707
  },
11708
11708
  {
11709
11709
  "name": "WST",
11710
- "description": null,
11710
+ "description": "Tala",
11711
11711
  "isDeprecated": false,
11712
11712
  "deprecationReason": null
11713
11713
  },
11714
11714
  {
11715
11715
  "name": "XAF",
11716
- "description": null,
11716
+ "description": "CFA Franc BEAC",
11717
11717
  "isDeprecated": false,
11718
11718
  "deprecationReason": null
11719
11719
  },
11720
11720
  {
11721
11721
  "name": "XCD",
11722
- "description": null,
11722
+ "description": "East Caribbean Dollar",
11723
11723
  "isDeprecated": false,
11724
11724
  "deprecationReason": null
11725
11725
  },
11726
11726
  {
11727
11727
  "name": "XOF",
11728
- "description": null,
11728
+ "description": "CFA Franc BCEAO",
11729
11729
  "isDeprecated": false,
11730
11730
  "deprecationReason": null
11731
11731
  },
11732
11732
  {
11733
11733
  "name": "XPF",
11734
- "description": null,
11734
+ "description": "CFP Franc",
11735
11735
  "isDeprecated": false,
11736
11736
  "deprecationReason": null
11737
11737
  },
11738
11738
  {
11739
11739
  "name": "YER",
11740
- "description": null,
11740
+ "description": "Yemeni Rial",
11741
11741
  "isDeprecated": false,
11742
11742
  "deprecationReason": null
11743
11743
  },
11744
11744
  {
11745
11745
  "name": "ZAR",
11746
- "description": null,
11746
+ "description": "Rand",
11747
11747
  "isDeprecated": false,
11748
11748
  "deprecationReason": null
11749
11749
  },
11750
11750
  {
11751
11751
  "name": "ZMW",
11752
- "description": null,
11752
+ "description": "Zambian Kwacha",
11753
11753
  "isDeprecated": false,
11754
11754
  "deprecationReason": null
11755
11755
  }
@@ -14529,11 +14529,11 @@
14529
14529
  {
14530
14530
  "kind": "OBJECT",
14531
14531
  "name": "CustomerPortal",
14532
- "description": null,
14532
+ "description": "A brief explanation of the specific customer portal session.",
14533
14533
  "fields": [
14534
14534
  {
14535
14535
  "name": "billingInformation",
14536
- "description": null,
14536
+ "description": "The customers billing contact and payment method details.",
14537
14537
  "args": [],
14538
14538
  "type": {
14539
14539
  "kind": "NON_NULL",
@@ -14549,7 +14549,7 @@
14549
14549
  },
14550
14550
  {
14551
14551
  "name": "billingPortalUrl",
14552
- "description": null,
14552
+ "description": "A link to the external billing portal.",
14553
14553
  "args": [],
14554
14554
  "type": {
14555
14555
  "kind": "SCALAR",
@@ -14561,7 +14561,7 @@
14561
14561
  },
14562
14562
  {
14563
14563
  "name": "canUpgradeSubscription",
14564
- "description": null,
14564
+ "description": "Indicates whether the customer is allowed to upgrade their subscription.",
14565
14565
  "args": [],
14566
14566
  "type": {
14567
14567
  "kind": "NON_NULL",
@@ -14577,7 +14577,7 @@
14577
14577
  },
14578
14578
  {
14579
14579
  "name": "configuration",
14580
- "description": null,
14580
+ "description": "Optional configuration object for customizing how the customer portal behaves or appears",
14581
14581
  "args": [],
14582
14582
  "type": {
14583
14583
  "kind": "OBJECT",
@@ -14589,7 +14589,7 @@
14589
14589
  },
14590
14590
  {
14591
14591
  "name": "entitlements",
14592
- "description": null,
14592
+ "description": "All effective entitlements granted through the customers subscription.",
14593
14593
  "args": [],
14594
14594
  "type": {
14595
14595
  "kind": "NON_NULL",
@@ -14613,7 +14613,7 @@
14613
14613
  },
14614
14614
  {
14615
14615
  "name": "promotionalEntitlements",
14616
- "description": null,
14616
+ "description": "A list of promotional entitlements granted directly to the customer. These provide bonus or trial access to features.",
14617
14617
  "args": [],
14618
14618
  "type": {
14619
14619
  "kind": "NON_NULL",
@@ -14637,7 +14637,7 @@
14637
14637
  },
14638
14638
  {
14639
14639
  "name": "resource",
14640
- "description": null,
14640
+ "description": "The ID of the resource that the portal session is scoped to.",
14641
14641
  "args": [],
14642
14642
  "type": {
14643
14643
  "kind": "OBJECT",
@@ -14649,7 +14649,7 @@
14649
14649
  },
14650
14650
  {
14651
14651
  "name": "showWatermark",
14652
- "description": null,
14652
+ "description": "Indicates whether to show the Stigg watermark on the checkout widget.",
14653
14653
  "args": [],
14654
14654
  "type": {
14655
14655
  "kind": "NON_NULL",
@@ -14665,7 +14665,7 @@
14665
14665
  },
14666
14666
  {
14667
14667
  "name": "subscriptions",
14668
- "description": null,
14668
+ "description": "List of the customers active subscriptions.",
14669
14669
  "args": [],
14670
14670
  "type": {
14671
14671
  "kind": "NON_NULL",
@@ -14767,7 +14767,7 @@
14767
14767
  {
14768
14768
  "kind": "OBJECT",
14769
14769
  "name": "CustomerPortalBillingInformation",
14770
- "description": null,
14770
+ "description": "A brief explanation of the specific billing profile.",
14771
14771
  "fields": [
14772
14772
  {
14773
14773
  "name": "defaultPaymentExpirationMonth",
@@ -14862,11 +14862,11 @@
14862
14862
  {
14863
14863
  "kind": "OBJECT",
14864
14864
  "name": "CustomerPortalColorsPalette",
14865
- "description": null,
14865
+ "description": "Color palette settings for the customer portal.",
14866
14866
  "fields": [
14867
14867
  {
14868
14868
  "name": "backgroundColor",
14869
- "description": null,
14869
+ "description": "Main background color of the customer portal.",
14870
14870
  "args": [],
14871
14871
  "type": {
14872
14872
  "kind": "SCALAR",
@@ -14878,7 +14878,7 @@
14878
14878
  },
14879
14879
  {
14880
14880
  "name": "borderColor",
14881
- "description": null,
14881
+ "description": "Color used for UI borders.",
14882
14882
  "args": [],
14883
14883
  "type": {
14884
14884
  "kind": "SCALAR",
@@ -14890,7 +14890,7 @@
14890
14890
  },
14891
14891
  {
14892
14892
  "name": "currentPlanBackground",
14893
- "description": null,
14893
+ "description": "Background color for the current plan section.",
14894
14894
  "args": [],
14895
14895
  "type": {
14896
14896
  "kind": "SCALAR",
@@ -14902,7 +14902,7 @@
14902
14902
  },
14903
14903
  {
14904
14904
  "name": "iconsColor",
14905
- "description": null,
14905
+ "description": "Background color for the current plan section.",
14906
14906
  "args": [],
14907
14907
  "type": {
14908
14908
  "kind": "SCALAR",
@@ -14914,7 +14914,7 @@
14914
14914
  },
14915
14915
  {
14916
14916
  "name": "paywallBackgroundColor",
14917
- "description": null,
14917
+ "description": "Background color used in the paywall section inside the customer portal.",
14918
14918
  "args": [],
14919
14919
  "type": {
14920
14920
  "kind": "SCALAR",
@@ -14926,7 +14926,7 @@
14926
14926
  },
14927
14927
  {
14928
14928
  "name": "primary",
14929
- "description": null,
14929
+ "description": "Primary accent color for the portal.",
14930
14930
  "args": [],
14931
14931
  "type": {
14932
14932
  "kind": "SCALAR",
@@ -14938,7 +14938,7 @@
14938
14938
  },
14939
14939
  {
14940
14940
  "name": "textColor",
14941
- "description": null,
14941
+ "description": "Color used for text in the customer portal.",
14942
14942
  "args": [],
14943
14943
  "type": {
14944
14944
  "kind": "SCALAR",
@@ -14957,12 +14957,12 @@
14957
14957
  {
14958
14958
  "kind": "INPUT_OBJECT",
14959
14959
  "name": "CustomerPortalColorsPaletteInput",
14960
- "description": null,
14960
+ "description": "Input for customizing customer portal color palette.",
14961
14961
  "fields": null,
14962
14962
  "inputFields": [
14963
14963
  {
14964
14964
  "name": "backgroundColor",
14965
- "description": null,
14965
+ "description": "Background color of the widget.",
14966
14966
  "type": {
14967
14967
  "kind": "SCALAR",
14968
14968
  "name": "String",
@@ -14974,7 +14974,7 @@
14974
14974
  },
14975
14975
  {
14976
14976
  "name": "borderColor",
14977
- "description": null,
14977
+ "description": "Color applied to widget borders or separators.",
14978
14978
  "type": {
14979
14979
  "kind": "SCALAR",
14980
14980
  "name": "String",
@@ -14986,7 +14986,7 @@
14986
14986
  },
14987
14987
  {
14988
14988
  "name": "currentPlanBackground",
14989
- "description": null,
14989
+ "description": "Background color for the customer’s current plan section in the paywall.",
14990
14990
  "type": {
14991
14991
  "kind": "SCALAR",
14992
14992
  "name": "String",
@@ -14998,7 +14998,7 @@
14998
14998
  },
14999
14999
  {
15000
15000
  "name": "iconsColor",
15001
- "description": null,
15001
+ "description": "Color used for icons in the customer portal.",
15002
15002
  "type": {
15003
15003
  "kind": "SCALAR",
15004
15004
  "name": "String",
@@ -15010,7 +15010,7 @@
15010
15010
  },
15011
15011
  {
15012
15012
  "name": "paywallBackgroundColor",
15013
- "description": null,
15013
+ "description": "Background color for embedded paywall sections inside the customer portal.",
15014
15014
  "type": {
15015
15015
  "kind": "SCALAR",
15016
15016
  "name": "String",
@@ -15022,7 +15022,7 @@
15022
15022
  },
15023
15023
  {
15024
15024
  "name": "primary",
15025
- "description": null,
15025
+ "description": "Primary accent color used throughout the widget.",
15026
15026
  "type": {
15027
15027
  "kind": "SCALAR",
15028
15028
  "name": "String",
@@ -15034,7 +15034,7 @@
15034
15034
  },
15035
15035
  {
15036
15036
  "name": "textColor",
15037
- "description": null,
15037
+ "description": "Default color used for text content.",
15038
15038
  "type": {
15039
15039
  "kind": "SCALAR",
15040
15040
  "name": "String",
@@ -15052,11 +15052,11 @@
15052
15052
  {
15053
15053
  "kind": "OBJECT",
15054
15054
  "name": "CustomerPortalConfiguration",
15055
- "description": null,
15055
+ "description": "Styling and layout configuration for the customer portal widget.",
15056
15056
  "fields": [
15057
15057
  {
15058
15058
  "name": "customCss",
15059
- "description": null,
15059
+ "description": "Custom CSS overrides for the customer portal widget.",
15060
15060
  "args": [],
15061
15061
  "type": {
15062
15062
  "kind": "SCALAR",
@@ -15068,7 +15068,7 @@
15068
15068
  },
15069
15069
  {
15070
15070
  "name": "palette",
15071
- "description": null,
15071
+ "description": "Custom color palette for the customer portal UI.",
15072
15072
  "args": [],
15073
15073
  "type": {
15074
15074
  "kind": "OBJECT",
@@ -15080,7 +15080,7 @@
15080
15080
  },
15081
15081
  {
15082
15082
  "name": "typography",
15083
- "description": null,
15083
+ "description": "Font and text style settings for the customer portal.",
15084
15084
  "args": [],
15085
15085
  "type": {
15086
15086
  "kind": "OBJECT",
@@ -15099,12 +15099,12 @@
15099
15099
  {
15100
15100
  "kind": "INPUT_OBJECT",
15101
15101
  "name": "CustomerPortalConfigurationInput",
15102
- "description": null,
15102
+ "description": "Input for configuring the customer portal appearance.",
15103
15103
  "fields": null,
15104
15104
  "inputFields": [
15105
15105
  {
15106
15106
  "name": "customCss",
15107
- "description": null,
15107
+ "description": "Custom CSS rules to override default styling in the portal.",
15108
15108
  "type": {
15109
15109
  "kind": "SCALAR",
15110
15110
  "name": "String",
@@ -15116,7 +15116,7 @@
15116
15116
  },
15117
15117
  {
15118
15118
  "name": "palette",
15119
- "description": null,
15119
+ "description": "Color palette customization for the portal UI.",
15120
15120
  "type": {
15121
15121
  "kind": "INPUT_OBJECT",
15122
15122
  "name": "CustomerPortalColorsPaletteInput",
@@ -15128,7 +15128,7 @@
15128
15128
  },
15129
15129
  {
15130
15130
  "name": "typography",
15131
- "description": null,
15131
+ "description": "Font styling settings for the customer portal.",
15132
15132
  "type": {
15133
15133
  "kind": "INPUT_OBJECT",
15134
15134
  "name": "TypographyConfigurationInput",
@@ -15146,12 +15146,12 @@
15146
15146
  {
15147
15147
  "kind": "INPUT_OBJECT",
15148
15148
  "name": "CustomerPortalInput",
15149
- "description": null,
15149
+ "description": "Optional explanation or context for why this portal session is being initialized.",
15150
15150
  "fields": null,
15151
15151
  "inputFields": [
15152
15152
  {
15153
15153
  "name": "customerId",
15154
- "description": null,
15154
+ "description": "Unique identifier of the customer.",
15155
15155
  "type": {
15156
15156
  "kind": "NON_NULL",
15157
15157
  "name": null,
@@ -15167,7 +15167,7 @@
15167
15167
  },
15168
15168
  {
15169
15169
  "name": "productId",
15170
- "description": null,
15170
+ "description": "The ID of the product context under which the portal is rendered.",
15171
15171
  "type": {
15172
15172
  "kind": "SCALAR",
15173
15173
  "name": "String",
@@ -15179,7 +15179,7 @@
15179
15179
  },
15180
15180
  {
15181
15181
  "name": "resourceId",
15182
- "description": null,
15182
+ "description": "Unique identifier of a resource if the subscription or entitlements are scoped to a specific resource.",
15183
15183
  "type": {
15184
15184
  "kind": "SCALAR",
15185
15185
  "name": "String",
@@ -15320,11 +15320,11 @@
15320
15320
  {
15321
15321
  "kind": "OBJECT",
15322
15322
  "name": "CustomerPortalPromotionalEntitlement",
15323
- "description": null,
15323
+ "description": "General description of the promotional entitlement. Use descriptionField instead to avoid key collisions.",
15324
15324
  "fields": [
15325
15325
  {
15326
15326
  "name": "description",
15327
- "description": null,
15327
+ "description": "The main descriptive text for the entitlement, explaining what benefit is granted.",
15328
15328
  "args": [],
15329
15329
  "type": {
15330
15330
  "kind": "SCALAR",
@@ -15336,7 +15336,7 @@
15336
15336
  },
15337
15337
  {
15338
15338
  "name": "displayName",
15339
- "description": null,
15339
+ "description": "The name of the promotional entitlement as it should appear in the Stigg portal.",
15340
15340
  "args": [],
15341
15341
  "type": {
15342
15342
  "kind": "NON_NULL",
@@ -15352,7 +15352,7 @@
15352
15352
  },
15353
15353
  {
15354
15354
  "name": "endDate",
15355
- "description": null,
15355
+ "description": "The date and time when the promotional entitlement expires and is no longer effective.",
15356
15356
  "args": [],
15357
15357
  "type": {
15358
15358
  "kind": "SCALAR",
@@ -15364,7 +15364,7 @@
15364
15364
  },
15365
15365
  {
15366
15366
  "name": "hasSoftLimit",
15367
- "description": null,
15367
+ "description": "Indicates that the entitlements usage limit is not strictly enforced — customers can exceed it, but their usage is still tracked.",
15368
15368
  "args": [],
15369
15369
  "type": {
15370
15370
  "kind": "SCALAR",
@@ -15376,7 +15376,7 @@
15376
15376
  },
15377
15377
  {
15378
15378
  "name": "hasUnlimitedUsage",
15379
- "description": null,
15379
+ "description": "Indicates whether this promotional entitlement grants unlimited usage.",
15380
15380
  "args": [],
15381
15381
  "type": {
15382
15382
  "kind": "SCALAR",
@@ -15388,7 +15388,7 @@
15388
15388
  },
15389
15389
  {
15390
15390
  "name": "period",
15391
- "description": null,
15391
+ "description": "The time interval after which usage resets automatically.",
15392
15392
  "args": [],
15393
15393
  "type": {
15394
15394
  "kind": "NON_NULL",
@@ -15404,7 +15404,7 @@
15404
15404
  },
15405
15405
  {
15406
15406
  "name": "startDate",
15407
- "description": null,
15407
+ "description": "The date and time when the promotional entitlement becomes active.",
15408
15408
  "args": [],
15409
15409
  "type": {
15410
15410
  "kind": "NON_NULL",
@@ -15420,7 +15420,7 @@
15420
15420
  },
15421
15421
  {
15422
15422
  "name": "usageLimit",
15423
- "description": null,
15423
+ "description": "The maximum allowed usage for this promotional entitlement, which only applies to metered features.",
15424
15424
  "args": [],
15425
15425
  "type": {
15426
15426
  "kind": "SCALAR",
@@ -22703,11 +22703,11 @@
22703
22703
  {
22704
22704
  "kind": "OBJECT",
22705
22705
  "name": "Entitlement",
22706
- "description": null,
22706
+ "description": "Represents an entitlement granted to a customer, including its usage and reset configuration.",
22707
22707
  "fields": [
22708
22708
  {
22709
22709
  "name": "accessDeniedReason",
22710
- "description": null,
22710
+ "description": "Optional message explaining why access to the feature is denied.",
22711
22711
  "args": [],
22712
22712
  "type": {
22713
22713
  "kind": "ENUM",
@@ -22719,7 +22719,7 @@
22719
22719
  },
22720
22720
  {
22721
22721
  "name": "currentUsage",
22722
- "description": null,
22722
+ "description": "The amount of the feature the customer has used so far in the current period.",
22723
22723
  "args": [],
22724
22724
  "type": {
22725
22725
  "kind": "SCALAR",
@@ -22743,7 +22743,7 @@
22743
22743
  },
22744
22744
  {
22745
22745
  "name": "displayNameOverride",
22746
- "description": null,
22746
+ "description": "A custom name to override the default display name for this entitlement.",
22747
22747
  "args": [],
22748
22748
  "type": {
22749
22749
  "kind": "SCALAR",
@@ -22755,7 +22755,7 @@
22755
22755
  },
22756
22756
  {
22757
22757
  "name": "entitlementUpdatedAt",
22758
- "description": null,
22758
+ "description": "Timestamp of the last update to the entitlement grant or configuration.",
22759
22759
  "args": [],
22760
22760
  "type": {
22761
22761
  "kind": "SCALAR",
@@ -22767,7 +22767,7 @@
22767
22767
  },
22768
22768
  {
22769
22769
  "name": "feature",
22770
- "description": null,
22770
+ "description": "The feature this entitlement corresponds to.",
22771
22771
  "args": [],
22772
22772
  "type": {
22773
22773
  "kind": "OBJECT",
@@ -22779,7 +22779,7 @@
22779
22779
  },
22780
22780
  {
22781
22781
  "name": "hasSoftLimit",
22782
- "description": null,
22782
+ "description": "Indicates whether the usage limit is soft — usage can exceed the limit, but will be tracked.",
22783
22783
  "args": [],
22784
22784
  "type": {
22785
22785
  "kind": "SCALAR",
@@ -22791,7 +22791,7 @@
22791
22791
  },
22792
22792
  {
22793
22793
  "name": "hasUnlimitedUsage",
22794
- "description": null,
22794
+ "description": "Indicates whether this entitlement grants unlimited usage with no enforced cap.",
22795
22795
  "args": [],
22796
22796
  "type": {
22797
22797
  "kind": "NON_NULL",
@@ -22807,7 +22807,7 @@
22807
22807
  },
22808
22808
  {
22809
22809
  "name": "hiddenFromWidgets",
22810
- "description": null,
22810
+ "description": "Indicates whether this entitlement should be hidden in customer-facing widgets.",
22811
22811
  "args": [],
22812
22812
  "type": {
22813
22813
  "kind": "LIST",
@@ -22827,7 +22827,7 @@
22827
22827
  },
22828
22828
  {
22829
22829
  "name": "isGranted",
22830
- "description": null,
22830
+ "description": "Indicates whether the entitlement is currently granted to the customer.",
22831
22831
  "args": [],
22832
22832
  "type": {
22833
22833
  "kind": "NON_NULL",
@@ -22843,7 +22843,7 @@
22843
22843
  },
22844
22844
  {
22845
22845
  "name": "meterId",
22846
- "description": null,
22846
+ "description": "The ID of the meter tracking usage for this entitlement.",
22847
22847
  "args": [],
22848
22848
  "type": {
22849
22849
  "kind": "SCALAR",
@@ -22867,7 +22867,7 @@
22867
22867
  },
22868
22868
  {
22869
22869
  "name": "requestedUsage",
22870
- "description": null,
22870
+ "description": "The amount of usage requested by the customer.",
22871
22871
  "args": [],
22872
22872
  "type": {
22873
22873
  "kind": "SCALAR",
@@ -22879,7 +22879,7 @@
22879
22879
  },
22880
22880
  {
22881
22881
  "name": "resetPeriod",
22882
- "description": null,
22882
+ "description": "The interval at which usage resets automatically, such as monthly or yearly.",
22883
22883
  "args": [],
22884
22884
  "type": {
22885
22885
  "kind": "ENUM",
@@ -22891,7 +22891,7 @@
22891
22891
  },
22892
22892
  {
22893
22893
  "name": "resetPeriodConfiguration",
22894
- "description": null,
22894
+ "description": "Detailed configuration object specifying the usage reset schedule.",
22895
22895
  "args": [],
22896
22896
  "type": {
22897
22897
  "kind": "UNION",
@@ -22915,7 +22915,7 @@
22915
22915
  },
22916
22916
  {
22917
22917
  "name": "usageLimit",
22918
- "description": null,
22918
+ "description": "The maximum allowed usage for this entitlement before restrictions apply.",
22919
22919
  "args": [],
22920
22920
  "type": {
22921
22921
  "kind": "SCALAR",
@@ -22963,7 +22963,7 @@
22963
22963
  },
22964
22964
  {
22965
22965
  "name": "usageUpdatedAt",
22966
- "description": null,
22966
+ "description": "Timestamp of the last update to the usage value.",
22967
22967
  "args": [],
22968
22968
  "type": {
22969
22969
  "kind": "SCALAR",
@@ -23005,12 +23005,12 @@
23005
23005
  {
23006
23006
  "kind": "INPUT_OBJECT",
23007
23007
  "name": "EntitlementCheckRequested",
23008
- "description": null,
23008
+ "description": "Input used to report that an entitlement check was performed for a customer.",
23009
23009
  "fields": null,
23010
23010
  "inputFields": [
23011
23011
  {
23012
23012
  "name": "customerId",
23013
- "description": null,
23013
+ "description": "Identifier of the customer for whom the entitlement check was made.",
23014
23014
  "type": {
23015
23015
  "kind": "NON_NULL",
23016
23016
  "name": null,
@@ -23026,7 +23026,7 @@
23026
23026
  },
23027
23027
  {
23028
23028
  "name": "entitlementCheckResult",
23029
- "description": null,
23029
+ "description": "Result object of an entitlement access check.",
23030
23030
  "type": {
23031
23031
  "kind": "NON_NULL",
23032
23032
  "name": null,
@@ -23042,7 +23042,7 @@
23042
23042
  },
23043
23043
  {
23044
23044
  "name": "environmentId",
23045
- "description": null,
23045
+ "description": "The environment context in which the check occurred.",
23046
23046
  "type": {
23047
23047
  "kind": "SCALAR",
23048
23048
  "name": "String",
@@ -23054,7 +23054,7 @@
23054
23054
  },
23055
23055
  {
23056
23056
  "name": "featureId",
23057
- "description": null,
23057
+ "description": "The internal ID of the feature linked to this entitlement.",
23058
23058
  "type": {
23059
23059
  "kind": "NON_NULL",
23060
23060
  "name": null,
@@ -23070,7 +23070,7 @@
23070
23070
  },
23071
23071
  {
23072
23072
  "name": "requestedUsage",
23073
- "description": null,
23073
+ "description": "The amount of usage requested by the customer.",
23074
23074
  "type": {
23075
23075
  "kind": "SCALAR",
23076
23076
  "name": "Float",
@@ -23082,7 +23082,7 @@
23082
23082
  },
23083
23083
  {
23084
23084
  "name": "resourceId",
23085
- "description": null,
23085
+ "description": "The specific resource identifier scoped for the entitlement check.",
23086
23086
  "type": {
23087
23087
  "kind": "SCALAR",
23088
23088
  "name": "String",
@@ -23100,12 +23100,12 @@
23100
23100
  {
23101
23101
  "kind": "INPUT_OBJECT",
23102
23102
  "name": "EntitlementCheckResult",
23103
- "description": null,
23103
+ "description": "Result object of an entitlement access check.",
23104
23104
  "fields": null,
23105
23105
  "inputFields": [
23106
23106
  {
23107
23107
  "name": "accessDeniedReason",
23108
- "description": null,
23108
+ "description": "Optional message explaining why access to the feature is denied.",
23109
23109
  "type": {
23110
23110
  "kind": "ENUM",
23111
23111
  "name": "AccessDeniedReason",
@@ -23117,7 +23117,7 @@
23117
23117
  },
23118
23118
  {
23119
23119
  "name": "currentUsage",
23120
- "description": null,
23120
+ "description": "The amount of the feature the customer has used so far in the current period.",
23121
23121
  "type": {
23122
23122
  "kind": "SCALAR",
23123
23123
  "name": "Float",
@@ -23129,7 +23129,7 @@
23129
23129
  },
23130
23130
  {
23131
23131
  "name": "hasAccess",
23132
- "description": null,
23132
+ "description": "Indicates whether the customer currently has access to the feature.",
23133
23133
  "type": {
23134
23134
  "kind": "NON_NULL",
23135
23135
  "name": null,
@@ -23145,7 +23145,7 @@
23145
23145
  },
23146
23146
  {
23147
23147
  "name": "hasSoftLimit",
23148
- "description": null,
23148
+ "description": "Indicates whether the usage limit is soft — usage can exceed the limit, but will be tracked.",
23149
23149
  "type": {
23150
23150
  "kind": "SCALAR",
23151
23151
  "name": "Boolean",
@@ -23157,7 +23157,7 @@
23157
23157
  },
23158
23158
  {
23159
23159
  "name": "hasUnlimitedUsage",
23160
- "description": null,
23160
+ "description": "Indicates whether this entitlement grants unlimited usage with no enforced cap.",
23161
23161
  "type": {
23162
23162
  "kind": "SCALAR",
23163
23163
  "name": "Boolean",
@@ -23169,7 +23169,7 @@
23169
23169
  },
23170
23170
  {
23171
23171
  "name": "monthlyResetPeriodConfiguration",
23172
- "description": null,
23172
+ "description": "Configuration for monthly usage reset.",
23173
23173
  "type": {
23174
23174
  "kind": "INPUT_OBJECT",
23175
23175
  "name": "MonthlyResetPeriodConfigInput",
@@ -23181,7 +23181,7 @@
23181
23181
  },
23182
23182
  {
23183
23183
  "name": "nextResetDate",
23184
- "description": null,
23184
+ "description": "The next date when the entitlement usage resets.",
23185
23185
  "type": {
23186
23186
  "kind": "SCALAR",
23187
23187
  "name": "DateTime",
@@ -23193,7 +23193,7 @@
23193
23193
  },
23194
23194
  {
23195
23195
  "name": "requestedUsage",
23196
- "description": null,
23196
+ "description": "The amount of usage requested by the customer.",
23197
23197
  "type": {
23198
23198
  "kind": "SCALAR",
23199
23199
  "name": "Float",
@@ -23205,7 +23205,7 @@
23205
23205
  },
23206
23206
  {
23207
23207
  "name": "resetPeriod",
23208
- "description": null,
23208
+ "description": "The interval at which usage resets automatically, such as monthly or yearly.",
23209
23209
  "type": {
23210
23210
  "kind": "ENUM",
23211
23211
  "name": "EntitlementResetPeriod",
@@ -23217,7 +23217,7 @@
23217
23217
  },
23218
23218
  {
23219
23219
  "name": "usageLimit",
23220
- "description": null,
23220
+ "description": "The maximum allowed usage for this entitlement before restrictions apply.",
23221
23221
  "type": {
23222
23222
  "kind": "SCALAR",
23223
23223
  "name": "Float",
@@ -23229,7 +23229,7 @@
23229
23229
  },
23230
23230
  {
23231
23231
  "name": "weeklyResetPeriodConfiguration",
23232
- "description": null,
23232
+ "description": "Configuration for weekly usage reset.",
23233
23233
  "type": {
23234
23234
  "kind": "INPUT_OBJECT",
23235
23235
  "name": "WeeklyResetPeriodConfigInput",
@@ -23241,7 +23241,7 @@
23241
23241
  },
23242
23242
  {
23243
23243
  "name": "yearlyResetPeriodConfiguration",
23244
- "description": null,
23244
+ "description": "Configuration for yearly usage reset.",
23245
23245
  "type": {
23246
23246
  "kind": "INPUT_OBJECT",
23247
23247
  "name": "YearlyResetPeriodConfigInput",
@@ -23263,7 +23263,7 @@
23263
23263
  "fields": [
23264
23264
  {
23265
23265
  "name": "additionalMetaData",
23266
- "description": null,
23266
+ "description": "Any additional metadata attached to this entitlement.",
23267
23267
  "args": [],
23268
23268
  "type": {
23269
23269
  "kind": "SCALAR",
@@ -23287,7 +23287,7 @@
23287
23287
  },
23288
23288
  {
23289
23289
  "name": "displayName",
23290
- "description": null,
23290
+ "description": "The human-readable name of the entitlement, shown in UI elements.",
23291
23291
  "args": [],
23292
23292
  "type": {
23293
23293
  "kind": "NON_NULL",
@@ -23303,7 +23303,7 @@
23303
23303
  },
23304
23304
  {
23305
23305
  "name": "featureStatus",
23306
- "description": null,
23306
+ "description": "The current status of the feature.",
23307
23307
  "args": [],
23308
23308
  "type": {
23309
23309
  "kind": "NON_NULL",
@@ -23319,7 +23319,7 @@
23319
23319
  },
23320
23320
  {
23321
23321
  "name": "featureType",
23322
- "description": null,
23322
+ "description": "The type of feature associated with the entitlement.",
23323
23323
  "args": [],
23324
23324
  "type": {
23325
23325
  "kind": "NON_NULL",
@@ -23335,7 +23335,7 @@
23335
23335
  },
23336
23336
  {
23337
23337
  "name": "featureUnits",
23338
- "description": null,
23338
+ "description": "The singular unit label for the feature.",
23339
23339
  "args": [],
23340
23340
  "type": {
23341
23341
  "kind": "SCALAR",
@@ -23347,7 +23347,7 @@
23347
23347
  },
23348
23348
  {
23349
23349
  "name": "featureUnitsPlural",
23350
- "description": null,
23350
+ "description": "The plural unit label for the feature.",
23351
23351
  "args": [],
23352
23352
  "type": {
23353
23353
  "kind": "SCALAR",
@@ -23375,7 +23375,7 @@
23375
23375
  },
23376
23376
  {
23377
23377
  "name": "meterType",
23378
- "description": null,
23378
+ "description": "The type of meter associated with the entitlement.",
23379
23379
  "args": [],
23380
23380
  "type": {
23381
23381
  "kind": "ENUM",
@@ -23387,7 +23387,7 @@
23387
23387
  },
23388
23388
  {
23389
23389
  "name": "refId",
23390
- "description": null,
23390
+ "description": "The unique reference ID of the entitlement.",
23391
23391
  "args": [],
23392
23392
  "type": {
23393
23393
  "kind": "NON_NULL",
@@ -23481,12 +23481,12 @@
23481
23481
  {
23482
23482
  "kind": "INPUT_OBJECT",
23483
23483
  "name": "EntitlementOptions",
23484
- "description": null,
23484
+ "description": "Options for configuring how an entitlement is tracked or applied.",
23485
23485
  "fields": null,
23486
23486
  "inputFields": [
23487
23487
  {
23488
23488
  "name": "requestedUsage",
23489
- "description": null,
23489
+ "description": "The amount of usage requested by the customer.",
23490
23490
  "type": {
23491
23491
  "kind": "SCALAR",
23492
23492
  "name": "Float",
@@ -23557,11 +23557,11 @@
23557
23557
  {
23558
23558
  "kind": "OBJECT",
23559
23559
  "name": "EntitlementSummary",
23560
- "description": null,
23560
+ "description": "Summary of all entitlements affecting a given feature for a customer.",
23561
23561
  "fields": [
23562
23562
  {
23563
23563
  "name": "addonQuantity",
23564
- "description": null,
23564
+ "description": "The number of addon units applied to the feature entitlement.",
23565
23565
  "args": [],
23566
23566
  "type": {
23567
23567
  "kind": "SCALAR",
@@ -23573,7 +23573,7 @@
23573
23573
  },
23574
23574
  {
23575
23575
  "name": "featurePackageEntitlement",
23576
- "description": null,
23576
+ "description": "The entitlement granted through a feature package.",
23577
23577
  "args": [],
23578
23578
  "type": {
23579
23579
  "kind": "OBJECT",
@@ -23585,7 +23585,7 @@
23585
23585
  },
23586
23586
  {
23587
23587
  "name": "featurePromotionalEntitlement",
23588
- "description": null,
23588
+ "description": "The entitlement granted via a promotional offer or override.",
23589
23589
  "args": [],
23590
23590
  "type": {
23591
23591
  "kind": "OBJECT",
@@ -23597,7 +23597,7 @@
23597
23597
  },
23598
23598
  {
23599
23599
  "name": "isEffectiveEntitlement",
23600
- "description": null,
23600
+ "description": "Indicates whether this entitlement is currently active and in effect.",
23601
23601
  "args": [],
23602
23602
  "type": {
23603
23603
  "kind": "NON_NULL",
@@ -23613,7 +23613,7 @@
23613
23613
  },
23614
23614
  {
23615
23615
  "name": "plan",
23616
- "description": null,
23616
+ "description": "The subscription plan associated with the entitlement.",
23617
23617
  "args": [],
23618
23618
  "type": {
23619
23619
  "kind": "OBJECT",
@@ -23625,7 +23625,7 @@
23625
23625
  },
23626
23626
  {
23627
23627
  "name": "priceEntitlement",
23628
- "description": null,
23628
+ "description": "The entitlement derived from the pricing configuration of the subscription.",
23629
23629
  "args": [],
23630
23630
  "type": {
23631
23631
  "kind": "OBJECT",
@@ -23637,7 +23637,7 @@
23637
23637
  },
23638
23638
  {
23639
23639
  "name": "subscription",
23640
- "description": null,
23640
+ "description": "The customer subscription context in which the entitlement was granted.",
23641
23641
  "args": [],
23642
23642
  "type": {
23643
23643
  "kind": "OBJECT",
@@ -23656,11 +23656,11 @@
23656
23656
  {
23657
23657
  "kind": "OBJECT",
23658
23658
  "name": "EntitlementWithSummary",
23659
- "description": null,
23659
+ "description": "A data structure that combines raw entitlement data with its computed summary.",
23660
23660
  "fields": [
23661
23661
  {
23662
23662
  "name": "accessDeniedReason",
23663
- "description": null,
23663
+ "description": "Optional message explaining why access to the feature is denied.",
23664
23664
  "args": [],
23665
23665
  "type": {
23666
23666
  "kind": "ENUM",
@@ -23672,7 +23672,7 @@
23672
23672
  },
23673
23673
  {
23674
23674
  "name": "currentUsage",
23675
- "description": null,
23675
+ "description": "The amount of the feature the customer has used so far in the current period.",
23676
23676
  "args": [],
23677
23677
  "type": {
23678
23678
  "kind": "SCALAR",
@@ -23696,7 +23696,7 @@
23696
23696
  },
23697
23697
  {
23698
23698
  "name": "displayNameOverride",
23699
- "description": null,
23699
+ "description": "A custom name to override the default display name for this entitlement.",
23700
23700
  "args": [],
23701
23701
  "type": {
23702
23702
  "kind": "SCALAR",
@@ -23708,7 +23708,7 @@
23708
23708
  },
23709
23709
  {
23710
23710
  "name": "entitlementUpdatedAt",
23711
- "description": null,
23711
+ "description": "Timestamp of the last update to the entitlement grant or configuration.",
23712
23712
  "args": [],
23713
23713
  "type": {
23714
23714
  "kind": "SCALAR",
@@ -23720,7 +23720,7 @@
23720
23720
  },
23721
23721
  {
23722
23722
  "name": "feature",
23723
- "description": null,
23723
+ "description": "The feature this entitlement corresponds to.",
23724
23724
  "args": [],
23725
23725
  "type": {
23726
23726
  "kind": "OBJECT",
@@ -23732,7 +23732,7 @@
23732
23732
  },
23733
23733
  {
23734
23734
  "name": "hasSoftLimit",
23735
- "description": null,
23735
+ "description": "Indicates whether the usage limit is soft — usage can exceed the limit, but will be tracked.",
23736
23736
  "args": [],
23737
23737
  "type": {
23738
23738
  "kind": "SCALAR",
@@ -23744,7 +23744,7 @@
23744
23744
  },
23745
23745
  {
23746
23746
  "name": "hasUnlimitedUsage",
23747
- "description": null,
23747
+ "description": "Indicates whether this entitlement grants unlimited usage with no enforced cap.",
23748
23748
  "args": [],
23749
23749
  "type": {
23750
23750
  "kind": "NON_NULL",
@@ -23760,7 +23760,7 @@
23760
23760
  },
23761
23761
  {
23762
23762
  "name": "hiddenFromWidgets",
23763
- "description": null,
23763
+ "description": "Indicates whether this entitlement should be hidden in customer-facing widgets.",
23764
23764
  "args": [],
23765
23765
  "type": {
23766
23766
  "kind": "LIST",
@@ -23780,7 +23780,7 @@
23780
23780
  },
23781
23781
  {
23782
23782
  "name": "isGranted",
23783
- "description": null,
23783
+ "description": "Indicates whether the entitlement is currently granted to the customer.",
23784
23784
  "args": [],
23785
23785
  "type": {
23786
23786
  "kind": "NON_NULL",
@@ -23796,7 +23796,7 @@
23796
23796
  },
23797
23797
  {
23798
23798
  "name": "meterId",
23799
- "description": null,
23799
+ "description": "The ID of the meter tracking usage for this entitlement.",
23800
23800
  "args": [],
23801
23801
  "type": {
23802
23802
  "kind": "SCALAR",
@@ -23820,7 +23820,7 @@
23820
23820
  },
23821
23821
  {
23822
23822
  "name": "requestedUsage",
23823
- "description": null,
23823
+ "description": "The amount of usage requested by the customer.",
23824
23824
  "args": [],
23825
23825
  "type": {
23826
23826
  "kind": "SCALAR",
@@ -23832,7 +23832,7 @@
23832
23832
  },
23833
23833
  {
23834
23834
  "name": "resetPeriod",
23835
- "description": null,
23835
+ "description": "The interval at which usage resets automatically, such as monthly or yearly.",
23836
23836
  "args": [],
23837
23837
  "type": {
23838
23838
  "kind": "ENUM",
@@ -23844,7 +23844,7 @@
23844
23844
  },
23845
23845
  {
23846
23846
  "name": "resetPeriodConfiguration",
23847
- "description": null,
23847
+ "description": "Detailed configuration object specifying the usage reset schedule.",
23848
23848
  "args": [],
23849
23849
  "type": {
23850
23850
  "kind": "UNION",
@@ -23868,7 +23868,7 @@
23868
23868
  },
23869
23869
  {
23870
23870
  "name": "summaries",
23871
- "description": null,
23871
+ "description": "List of entitlement summaries per feature, including source and effective values.",
23872
23872
  "args": [],
23873
23873
  "type": {
23874
23874
  "kind": "LIST",
@@ -23888,7 +23888,7 @@
23888
23888
  },
23889
23889
  {
23890
23890
  "name": "usageLimit",
23891
- "description": null,
23891
+ "description": "The maximum allowed usage for this entitlement before restrictions apply.",
23892
23892
  "args": [],
23893
23893
  "type": {
23894
23894
  "kind": "SCALAR",
@@ -23936,7 +23936,7 @@
23936
23936
  },
23937
23937
  {
23938
23938
  "name": "usageUpdatedAt",
23939
- "description": null,
23939
+ "description": "Timestamp of the last update to the usage value.",
23940
23940
  "args": [],
23941
23941
  "type": {
23942
23942
  "kind": "SCALAR",
@@ -23955,7 +23955,7 @@
23955
23955
  {
23956
23956
  "kind": "OBJECT",
23957
23957
  "name": "EntitlementsUpdated",
23958
- "description": null,
23958
+ "description": "Event payload for when entitlements are updated for a customer.",
23959
23959
  "fields": [
23960
23960
  {
23961
23961
  "name": "accountId",
@@ -23975,7 +23975,7 @@
23975
23975
  },
23976
23976
  {
23977
23977
  "name": "customerId",
23978
- "description": null,
23978
+ "description": "Identifier of the customer whose entitlements have changed.",
23979
23979
  "args": [],
23980
23980
  "type": {
23981
23981
  "kind": "NON_NULL",
@@ -23991,7 +23991,7 @@
23991
23991
  },
23992
23992
  {
23993
23993
  "name": "entitlements",
23994
- "description": null,
23994
+ "description": "The updated list of entitlements for the customer.",
23995
23995
  "args": [],
23996
23996
  "type": {
23997
23997
  "kind": "NON_NULL",
@@ -24031,7 +24031,7 @@
24031
24031
  },
24032
24032
  {
24033
24033
  "name": "resourceId",
24034
- "description": null,
24034
+ "description": "The resource the entitlement update is scoped to.",
24035
24035
  "args": [],
24036
24036
  "type": {
24037
24037
  "kind": "SCALAR",
@@ -32048,12 +32048,12 @@
32048
32048
  {
32049
32049
  "kind": "INPUT_OBJECT",
32050
32050
  "name": "FetchEntitlementQuery",
32051
- "description": null,
32051
+ "description": "Query for fetching a single entitlement for a specific feature and customer.",
32052
32052
  "fields": null,
32053
32053
  "inputFields": [
32054
32054
  {
32055
32055
  "name": "customerId",
32056
- "description": null,
32056
+ "description": "Identifier of the customer.",
32057
32057
  "type": {
32058
32058
  "kind": "NON_NULL",
32059
32059
  "name": null,
@@ -32069,7 +32069,7 @@
32069
32069
  },
32070
32070
  {
32071
32071
  "name": "environmentId",
32072
- "description": null,
32072
+ "description": "The environment identifier used to resolve the entitlement context.",
32073
32073
  "type": {
32074
32074
  "kind": "SCALAR",
32075
32075
  "name": "String",
@@ -32081,7 +32081,7 @@
32081
32081
  },
32082
32082
  {
32083
32083
  "name": "featureId",
32084
- "description": null,
32084
+ "description": "The internal ID of the feature linked to this entitlement.",
32085
32085
  "type": {
32086
32086
  "kind": "NON_NULL",
32087
32087
  "name": null,
@@ -32097,7 +32097,7 @@
32097
32097
  },
32098
32098
  {
32099
32099
  "name": "options",
32100
- "description": null,
32100
+ "description": "Options for configuring how an entitlement is tracked or applied.",
32101
32101
  "type": {
32102
32102
  "kind": "INPUT_OBJECT",
32103
32103
  "name": "EntitlementOptions",
@@ -32109,7 +32109,7 @@
32109
32109
  },
32110
32110
  {
32111
32111
  "name": "resourceId",
32112
- "description": null,
32112
+ "description": "The scoped resource Identifier.",
32113
32113
  "type": {
32114
32114
  "kind": "SCALAR",
32115
32115
  "name": "String",
@@ -32127,12 +32127,12 @@
32127
32127
  {
32128
32128
  "kind": "INPUT_OBJECT",
32129
32129
  "name": "FetchEntitlementsQuery",
32130
- "description": null,
32130
+ "description": "Query for retrieving all entitlements for a customer in a specific environment.",
32131
32131
  "fields": null,
32132
32132
  "inputFields": [
32133
32133
  {
32134
32134
  "name": "customerId",
32135
- "description": null,
32135
+ "description": "Identifier of the customer.",
32136
32136
  "type": {
32137
32137
  "kind": "NON_NULL",
32138
32138
  "name": null,
@@ -32148,7 +32148,7 @@
32148
32148
  },
32149
32149
  {
32150
32150
  "name": "environmentId",
32151
- "description": null,
32151
+ "description": "The environment context for entitlement resolution.",
32152
32152
  "type": {
32153
32153
  "kind": "SCALAR",
32154
32154
  "name": "String",
@@ -32160,7 +32160,7 @@
32160
32160
  },
32161
32161
  {
32162
32162
  "name": "resourceId",
32163
- "description": null,
32163
+ "description": "The scoped resource Identifier.",
32164
32164
  "type": {
32165
32165
  "kind": "SCALAR",
32166
32166
  "name": "String",
@@ -32188,11 +32188,11 @@
32188
32188
  {
32189
32189
  "kind": "OBJECT",
32190
32190
  "name": "FontVariant",
32191
- "description": null,
32191
+ "description": "Typography settings for a single font variant.",
32192
32192
  "fields": [
32193
32193
  {
32194
32194
  "name": "fontSize",
32195
- "description": null,
32195
+ "description": "Font size for the variant.",
32196
32196
  "args": [],
32197
32197
  "type": {
32198
32198
  "kind": "SCALAR",
@@ -32204,7 +32204,7 @@
32204
32204
  },
32205
32205
  {
32206
32206
  "name": "fontWeight",
32207
- "description": null,
32207
+ "description": "Font weight, such as normal or bold.",
32208
32208
  "args": [],
32209
32209
  "type": {
32210
32210
  "kind": "ENUM",
@@ -32223,12 +32223,12 @@
32223
32223
  {
32224
32224
  "kind": "INPUT_OBJECT",
32225
32225
  "name": "FontVariantInput",
32226
- "description": null,
32226
+ "description": "Input for defining font style for a text variant.",
32227
32227
  "fields": null,
32228
32228
  "inputFields": [
32229
32229
  {
32230
32230
  "name": "fontSize",
32231
- "description": null,
32231
+ "description": "Size of the text in px or rem.",
32232
32232
  "type": {
32233
32233
  "kind": "SCALAR",
32234
32234
  "name": "Float",
@@ -32240,7 +32240,7 @@
32240
32240
  },
32241
32241
  {
32242
32242
  "name": "fontWeight",
32243
- "description": null,
32243
+ "description": "Weight of the font, such as normal or bold.",
32244
32244
  "type": {
32245
32245
  "kind": "ENUM",
32246
32246
  "name": "FontWeight",
@@ -32265,13 +32265,13 @@
32265
32265
  "enumValues": [
32266
32266
  {
32267
32267
  "name": "BOLD",
32268
- "description": null,
32268
+ "description": "Bold font weight.",
32269
32269
  "isDeprecated": false,
32270
32270
  "deprecationReason": null
32271
32271
  },
32272
32272
  {
32273
32273
  "name": "NORMAL",
32274
- "description": null,
32274
+ "description": "Standard font weight.",
32275
32275
  "isDeprecated": false,
32276
32276
  "deprecationReason": null
32277
32277
  }
@@ -32788,7 +32788,7 @@
32788
32788
  {
32789
32789
  "kind": "INPUT_OBJECT",
32790
32790
  "name": "GetWidgetConfigurationInput",
32791
- "description": null,
32791
+ "description": "Input object used to retrieve current widget configuration for the environment.",
32792
32792
  "fields": null,
32793
32793
  "inputFields": [
32794
32794
  {
@@ -42573,11 +42573,11 @@
42573
42573
  },
42574
42574
  {
42575
42575
  "name": "purgeCustomerCache",
42576
- "description": null,
42576
+ "description": "Clear the persistent cache for a customer and optionally a resource.",
42577
42577
  "args": [
42578
42578
  {
42579
42579
  "name": "input",
42580
- "description": null,
42580
+ "description": "Input for clearing a customers persistent cache.",
42581
42581
  "type": {
42582
42582
  "kind": "NON_NULL",
42583
42583
  "name": null,
@@ -42606,11 +42606,11 @@
42606
42606
  },
42607
42607
  {
42608
42608
  "name": "recalculateEntitlements",
42609
- "description": null,
42609
+ "description": "Initiate a recalculation of entitlements for selected customers in an environment.",
42610
42610
  "args": [
42611
42611
  {
42612
42612
  "name": "input",
42613
- "description": null,
42613
+ "description": "Input object for triggering entitlement recalculation for one or more customers.",
42614
42614
  "type": {
42615
42615
  "kind": "NON_NULL",
42616
42616
  "name": null,
@@ -42919,11 +42919,11 @@
42919
42919
  },
42920
42920
  {
42921
42921
  "name": "reportEntitlementCheckRequested",
42922
- "description": null,
42922
+ "description": "Log the result of a customer entitlement check for analytics or auditing.",
42923
42923
  "args": [
42924
42924
  {
42925
42925
  "name": "entitlementCheckRequested",
42926
- "description": null,
42926
+ "description": "Input used to report that an entitlement check was performed for a customer.",
42927
42927
  "type": {
42928
42928
  "kind": "NON_NULL",
42929
42929
  "name": null,
@@ -43430,11 +43430,11 @@
43430
43430
  },
43431
43431
  {
43432
43432
  "name": "setWidgetConfiguration",
43433
- "description": null,
43433
+ "description": "Update the widget configuration across different components like checkout, paywall, and customer portal.",
43434
43434
  "args": [
43435
43435
  {
43436
43436
  "name": "input",
43437
- "description": null,
43437
+ "description": "Input for updating configuration settings across all widgets.",
43438
43438
  "type": {
43439
43439
  "kind": "NON_NULL",
43440
43440
  "name": null,
@@ -43554,11 +43554,11 @@
43554
43554
  },
43555
43555
  {
43556
43556
  "name": "syncTaxRates",
43557
- "description": null,
43557
+ "description": "Indicates whether to sync tax rates from the billing provider into the specified environment.",
43558
43558
  "args": [
43559
43559
  {
43560
43560
  "name": "input",
43561
- "description": null,
43561
+ "description": "Input for triggering a sync of tax rates from the billing provider.",
43562
43562
  "type": {
43563
43563
  "kind": "NON_NULL",
43564
43564
  "name": null,
@@ -51400,6 +51400,26 @@
51400
51400
  "isDeprecated": false,
51401
51401
  "deprecationReason": null
51402
51402
  },
51403
+ {
51404
+ "name": "hiddenFromWidgets",
51405
+ "description": "List of hidden widgets of the package",
51406
+ "args": [],
51407
+ "type": {
51408
+ "kind": "LIST",
51409
+ "name": null,
51410
+ "ofType": {
51411
+ "kind": "NON_NULL",
51412
+ "name": null,
51413
+ "ofType": {
51414
+ "kind": "ENUM",
51415
+ "name": "WidgetType",
51416
+ "ofType": null
51417
+ }
51418
+ }
51419
+ },
51420
+ "isDeprecated": false,
51421
+ "deprecationReason": null
51422
+ },
51403
51423
  {
51404
51424
  "name": "maxQuantity",
51405
51425
  "description": "The maximum quantity of this addon that can be added to a subscription",
@@ -51516,11 +51536,11 @@
51516
51536
  {
51517
51537
  "kind": "OBJECT",
51518
51538
  "name": "PaywallColorsPalette",
51519
- "description": null,
51539
+ "description": "Color palette for customizing the paywall.",
51520
51540
  "fields": [
51521
51541
  {
51522
51542
  "name": "backgroundColor",
51523
- "description": null,
51543
+ "description": "Background color for the paywall area.",
51524
51544
  "args": [],
51525
51545
  "type": {
51526
51546
  "kind": "SCALAR",
@@ -51532,7 +51552,7 @@
51532
51552
  },
51533
51553
  {
51534
51554
  "name": "borderColor",
51535
- "description": null,
51555
+ "description": "Color used for UI dividers or borders.",
51536
51556
  "args": [],
51537
51557
  "type": {
51538
51558
  "kind": "SCALAR",
@@ -51544,7 +51564,7 @@
51544
51564
  },
51545
51565
  {
51546
51566
  "name": "currentPlanBackground",
51547
- "description": null,
51567
+ "description": "Background color for highlighting the customers current plan.",
51548
51568
  "args": [],
51549
51569
  "type": {
51550
51570
  "kind": "SCALAR",
@@ -51556,7 +51576,7 @@
51556
51576
  },
51557
51577
  {
51558
51578
  "name": "primary",
51559
- "description": null,
51579
+ "description": "Primary highlight color used across the paywall.",
51560
51580
  "args": [],
51561
51581
  "type": {
51562
51582
  "kind": "SCALAR",
@@ -51568,7 +51588,7 @@
51568
51588
  },
51569
51589
  {
51570
51590
  "name": "textColor",
51571
- "description": null,
51591
+ "description": "Default text color within the paywall.",
51572
51592
  "args": [],
51573
51593
  "type": {
51574
51594
  "kind": "SCALAR",
@@ -51587,12 +51607,12 @@
51587
51607
  {
51588
51608
  "kind": "INPUT_OBJECT",
51589
51609
  "name": "PaywallColorsPaletteInput",
51590
- "description": null,
51610
+ "description": "Input for customizing paywall-specific color elements.",
51591
51611
  "fields": null,
51592
51612
  "inputFields": [
51593
51613
  {
51594
51614
  "name": "backgroundColor",
51595
- "description": null,
51615
+ "description": "Background color of the widget.",
51596
51616
  "type": {
51597
51617
  "kind": "SCALAR",
51598
51618
  "name": "String",
@@ -51604,7 +51624,7 @@
51604
51624
  },
51605
51625
  {
51606
51626
  "name": "borderColor",
51607
- "description": null,
51627
+ "description": "Color applied to widget borders or separators.",
51608
51628
  "type": {
51609
51629
  "kind": "SCALAR",
51610
51630
  "name": "String",
@@ -51616,7 +51636,7 @@
51616
51636
  },
51617
51637
  {
51618
51638
  "name": "currentPlanBackground",
51619
- "description": null,
51639
+ "description": "Background color for the customer’s current plan section in the paywall.",
51620
51640
  "type": {
51621
51641
  "kind": "SCALAR",
51622
51642
  "name": "String",
@@ -51628,7 +51648,7 @@
51628
51648
  },
51629
51649
  {
51630
51650
  "name": "primary",
51631
- "description": null,
51651
+ "description": "Primary accent color used throughout the widget.",
51632
51652
  "type": {
51633
51653
  "kind": "SCALAR",
51634
51654
  "name": "String",
@@ -51640,7 +51660,7 @@
51640
51660
  },
51641
51661
  {
51642
51662
  "name": "textColor",
51643
- "description": null,
51663
+ "description": "Default color used for text content.",
51644
51664
  "type": {
51645
51665
  "kind": "SCALAR",
51646
51666
  "name": "String",
@@ -51658,11 +51678,11 @@
51658
51678
  {
51659
51679
  "kind": "OBJECT",
51660
51680
  "name": "PaywallConfiguration",
51661
- "description": null,
51681
+ "description": "Styling and layout configuration for the paywall widget.",
51662
51682
  "fields": [
51663
51683
  {
51664
51684
  "name": "customCss",
51665
- "description": null,
51685
+ "description": "Custom CSS styles to override default paywall appearance.",
51666
51686
  "args": [],
51667
51687
  "type": {
51668
51688
  "kind": "SCALAR",
@@ -51674,7 +51694,7 @@
51674
51694
  },
51675
51695
  {
51676
51696
  "name": "layout",
51677
- "description": null,
51697
+ "description": "Layout parameters for displaying plans in the paywall.",
51678
51698
  "args": [],
51679
51699
  "type": {
51680
51700
  "kind": "OBJECT",
@@ -51686,7 +51706,7 @@
51686
51706
  },
51687
51707
  {
51688
51708
  "name": "palette",
51689
- "description": null,
51709
+ "description": "Color settings applied to the paywall UI.",
51690
51710
  "args": [],
51691
51711
  "type": {
51692
51712
  "kind": "OBJECT",
@@ -51698,7 +51718,7 @@
51698
51718
  },
51699
51719
  {
51700
51720
  "name": "typography",
51701
- "description": null,
51721
+ "description": "Typography settings for the paywall interface.",
51702
51722
  "args": [],
51703
51723
  "type": {
51704
51724
  "kind": "OBJECT",
@@ -51717,12 +51737,12 @@
51717
51737
  {
51718
51738
  "kind": "INPUT_OBJECT",
51719
51739
  "name": "PaywallConfigurationInput",
51720
- "description": null,
51740
+ "description": "Input for updating the paywall configuration.",
51721
51741
  "fields": null,
51722
51742
  "inputFields": [
51723
51743
  {
51724
51744
  "name": "customCss",
51725
- "description": null,
51745
+ "description": "Custom CSS overrides for additional visual customization.",
51726
51746
  "type": {
51727
51747
  "kind": "SCALAR",
51728
51748
  "name": "String",
@@ -51734,7 +51754,7 @@
51734
51754
  },
51735
51755
  {
51736
51756
  "name": "layout",
51737
- "description": null,
51757
+ "description": "Layout settings for plan display in the paywall.",
51738
51758
  "type": {
51739
51759
  "kind": "INPUT_OBJECT",
51740
51760
  "name": "PaywallLayoutConfigurationInput",
@@ -51746,7 +51766,7 @@
51746
51766
  },
51747
51767
  {
51748
51768
  "name": "palette",
51749
- "description": null,
51769
+ "description": "Color palette settings for the paywall UI.",
51750
51770
  "type": {
51751
51771
  "kind": "INPUT_OBJECT",
51752
51772
  "name": "PaywallColorsPaletteInput",
@@ -51758,7 +51778,7 @@
51758
51778
  },
51759
51779
  {
51760
51780
  "name": "typography",
51761
- "description": null,
51781
+ "description": "Typography configuration used in the paywall widget.",
51762
51782
  "type": {
51763
51783
  "kind": "INPUT_OBJECT",
51764
51784
  "name": "TypographyConfigurationInput",
@@ -51819,11 +51839,11 @@
51819
51839
  {
51820
51840
  "kind": "OBJECT",
51821
51841
  "name": "PaywallLayoutConfiguration",
51822
- "description": null,
51842
+ "description": "Layout configuration for arranging plans in the paywall UI.",
51823
51843
  "fields": [
51824
51844
  {
51825
51845
  "name": "alignment",
51826
- "description": null,
51846
+ "description": "Horizontal alignment of the plan cards, such as left, center, right.",
51827
51847
  "args": [],
51828
51848
  "type": {
51829
51849
  "kind": "ENUM",
@@ -51835,7 +51855,7 @@
51835
51855
  },
51836
51856
  {
51837
51857
  "name": "planMargin",
51838
- "description": null,
51858
+ "description": "Outer spacing around each plan card.",
51839
51859
  "args": [],
51840
51860
  "type": {
51841
51861
  "kind": "SCALAR",
@@ -51847,7 +51867,7 @@
51847
51867
  },
51848
51868
  {
51849
51869
  "name": "planPadding",
51850
- "description": null,
51870
+ "description": "Inner spacing inside each plan card.",
51851
51871
  "args": [],
51852
51872
  "type": {
51853
51873
  "kind": "SCALAR",
@@ -51859,7 +51879,7 @@
51859
51879
  },
51860
51880
  {
51861
51881
  "name": "planWidth",
51862
- "description": null,
51882
+ "description": "Width setting for each individual plan card.",
51863
51883
  "args": [],
51864
51884
  "type": {
51865
51885
  "kind": "SCALAR",
@@ -51878,12 +51898,12 @@
51878
51898
  {
51879
51899
  "kind": "INPUT_OBJECT",
51880
51900
  "name": "PaywallLayoutConfigurationInput",
51881
- "description": null,
51901
+ "description": "Input for controlling the layout of pricing plans in the paywall.",
51882
51902
  "fields": null,
51883
51903
  "inputFields": [
51884
51904
  {
51885
51905
  "name": "alignment",
51886
- "description": null,
51906
+ "description": "Horizontal alignment of pricing plans, such as left, center, or right.",
51887
51907
  "type": {
51888
51908
  "kind": "ENUM",
51889
51909
  "name": "Alignment",
@@ -51895,7 +51915,7 @@
51895
51915
  },
51896
51916
  {
51897
51917
  "name": "planMargin",
51898
- "description": null,
51918
+ "description": "Outer spacing around each plan.",
51899
51919
  "type": {
51900
51920
  "kind": "SCALAR",
51901
51921
  "name": "Float",
@@ -51907,7 +51927,7 @@
51907
51927
  },
51908
51928
  {
51909
51929
  "name": "planPadding",
51910
- "description": null,
51930
+ "description": "Inner spacing inside each plan card.",
51911
51931
  "type": {
51912
51932
  "kind": "SCALAR",
51913
51933
  "name": "Float",
@@ -51919,7 +51939,7 @@
51919
51939
  },
51920
51940
  {
51921
51941
  "name": "planWidth",
51922
- "description": null,
51942
+ "description": "Width of each plan card displayed in the paywall.",
51923
51943
  "type": {
51924
51944
  "kind": "SCALAR",
51925
51945
  "name": "Float",
@@ -56979,11 +56999,11 @@
56979
56999
  {
56980
57000
  "kind": "OBJECT",
56981
57001
  "name": "PriceEntitlement",
56982
- "description": null,
57002
+ "description": "Entitlement that is granted as part of a price component.",
56983
57003
  "fields": [
56984
57004
  {
56985
57005
  "name": "description",
56986
- "description": null,
57006
+ "description": "Detailed description of the entitlement associated with the pricing component.",
56987
57007
  "args": [],
56988
57008
  "type": {
56989
57009
  "kind": "SCALAR",
@@ -56995,7 +57015,7 @@
56995
57015
  },
56996
57016
  {
56997
57017
  "name": "feature",
56998
- "description": null,
57018
+ "description": "The feature this entitlement corresponds to.",
56999
57019
  "args": [],
57000
57020
  "type": {
57001
57021
  "kind": "NON_NULL",
@@ -57011,7 +57031,7 @@
57011
57031
  },
57012
57032
  {
57013
57033
  "name": "featureId",
57014
- "description": null,
57034
+ "description": "The internal ID of the feature linked to this entitlement.",
57015
57035
  "args": [],
57016
57036
  "type": {
57017
57037
  "kind": "NON_NULL",
@@ -57027,7 +57047,7 @@
57027
57047
  },
57028
57048
  {
57029
57049
  "name": "hasSoftLimit",
57030
- "description": null,
57050
+ "description": "Indicates whether the usage limit is soft — usage can exceed the limit, but will be tracked.",
57031
57051
  "args": [],
57032
57052
  "type": {
57033
57053
  "kind": "SCALAR",
@@ -57039,7 +57059,7 @@
57039
57059
  },
57040
57060
  {
57041
57061
  "name": "hasUnlimitedUsage",
57042
- "description": null,
57062
+ "description": "Indicates whether this entitlement grants unlimited usage with no enforced cap.",
57043
57063
  "args": [],
57044
57064
  "type": {
57045
57065
  "kind": "SCALAR",
@@ -57051,7 +57071,7 @@
57051
57071
  },
57052
57072
  {
57053
57073
  "name": "package",
57054
- "description": null,
57074
+ "description": "The package that this entitlement is associated with.",
57055
57075
  "args": [],
57056
57076
  "type": {
57057
57077
  "kind": "NON_NULL",
@@ -57067,7 +57087,7 @@
57067
57087
  },
57068
57088
  {
57069
57089
  "name": "packageId",
57070
- "description": null,
57090
+ "description": "The internal ID of the package or plan that granted this entitlement.",
57071
57091
  "args": [],
57072
57092
  "type": {
57073
57093
  "kind": "NON_NULL",
@@ -57083,7 +57103,7 @@
57083
57103
  },
57084
57104
  {
57085
57105
  "name": "resetPeriod",
57086
- "description": null,
57106
+ "description": "The interval at which usage resets automatically, such as monthly or yearly.",
57087
57107
  "args": [],
57088
57108
  "type": {
57089
57109
  "kind": "ENUM",
@@ -57095,7 +57115,7 @@
57095
57115
  },
57096
57116
  {
57097
57117
  "name": "resetPeriodConfiguration",
57098
- "description": null,
57118
+ "description": "Detailed configuration object specifying the usage reset schedule.",
57099
57119
  "args": [],
57100
57120
  "type": {
57101
57121
  "kind": "UNION",
@@ -57119,7 +57139,7 @@
57119
57139
  },
57120
57140
  {
57121
57141
  "name": "usageLimit",
57122
- "description": null,
57142
+ "description": "The maximum allowed usage for this entitlement before restrictions apply.",
57123
57143
  "args": [],
57124
57144
  "type": {
57125
57145
  "kind": "SCALAR",
@@ -64294,11 +64314,11 @@
64294
64314
  },
64295
64315
  {
64296
64316
  "name": "cachedEntitlements",
64297
- "description": null,
64317
+ "description": "Retrieve entitlements from the cache to optimize performance.",
64298
64318
  "args": [
64299
64319
  {
64300
64320
  "name": "query",
64301
- "description": null,
64321
+ "description": "Query for retrieving all entitlements for a customer in a specific environment.",
64302
64322
  "type": {
64303
64323
  "kind": "NON_NULL",
64304
64324
  "name": null,
@@ -64494,7 +64514,7 @@
64494
64514
  "args": [
64495
64515
  {
64496
64516
  "name": "input",
64497
- "description": null,
64517
+ "description": "Optional explanation or context for why this portal session is being initialized.",
64498
64518
  "type": {
64499
64519
  "kind": "NON_NULL",
64500
64520
  "name": null,
@@ -64805,11 +64825,11 @@
64805
64825
  },
64806
64826
  {
64807
64827
  "name": "entitlement",
64808
- "description": null,
64828
+ "description": "Fetch a specific entitlement for a given feature and customer.",
64809
64829
  "args": [
64810
64830
  {
64811
64831
  "name": "query",
64812
- "description": null,
64832
+ "description": "Query for fetching a single entitlement for a specific feature and customer.",
64813
64833
  "type": {
64814
64834
  "kind": "NON_NULL",
64815
64835
  "name": null,
@@ -64838,11 +64858,11 @@
64838
64858
  },
64839
64859
  {
64840
64860
  "name": "entitlements",
64841
- "description": null,
64861
+ "description": "Get the full list of entitlements for a customer in a specific environment.",
64842
64862
  "args": [
64843
64863
  {
64844
64864
  "name": "query",
64845
- "description": null,
64865
+ "description": "Query for retrieving all entitlements for a customer in a specific environment.",
64846
64866
  "type": {
64847
64867
  "kind": "NON_NULL",
64848
64868
  "name": null,
@@ -66306,7 +66326,7 @@
66306
66326
  },
66307
66327
  {
66308
66328
  "name": "sdkConfiguration",
66309
- "description": null,
66329
+ "description": "Fetch general SDK configuration including global flags and external integrations.",
66310
66330
  "args": [],
66311
66331
  "type": {
66312
66332
  "kind": "OBJECT",
@@ -66916,11 +66936,11 @@
66916
66936
  },
66917
66937
  {
66918
66938
  "name": "widgetConfiguration",
66919
- "description": null,
66939
+ "description": "Fetch the current widget configuration.",
66920
66940
  "args": [
66921
66941
  {
66922
66942
  "name": "input",
66923
- "description": null,
66943
+ "description": "Input object used to retrieve current widget configuration for the environment.",
66924
66944
  "type": {
66925
66945
  "kind": "NON_NULL",
66926
66946
  "name": null,
@@ -66997,12 +67017,12 @@
66997
67017
  {
66998
67018
  "kind": "INPUT_OBJECT",
66999
67019
  "name": "RecalculateEntitlementsInput",
67000
- "description": null,
67020
+ "description": "Input object for triggering entitlement recalculation for one or more customers.",
67001
67021
  "fields": null,
67002
67022
  "inputFields": [
67003
67023
  {
67004
67024
  "name": "customerIds",
67005
- "description": null,
67025
+ "description": "List of customer IDs for which to recalculate entitlements.",
67006
67026
  "type": {
67007
67027
  "kind": "LIST",
67008
67028
  "name": null,
@@ -67022,7 +67042,7 @@
67022
67042
  },
67023
67043
  {
67024
67044
  "name": "environmentId",
67025
- "description": null,
67045
+ "description": "Identifier of the environment where recalculation should occur.",
67026
67046
  "type": {
67027
67047
  "kind": "NON_NULL",
67028
67048
  "name": null,
@@ -67038,7 +67058,7 @@
67038
67058
  },
67039
67059
  {
67040
67060
  "name": "forAllCustomers",
67041
- "description": null,
67061
+ "description": "If true, recalculates entitlements for all customers in the environment.",
67042
67062
  "type": {
67043
67063
  "kind": "SCALAR",
67044
67064
  "name": "Boolean",
@@ -67050,7 +67070,7 @@
67050
67070
  },
67051
67071
  {
67052
67072
  "name": "sideEffectsOptions",
67053
- "description": null,
67073
+ "description": "Optional flags to control recalculation side effects.",
67054
67074
  "type": {
67055
67075
  "kind": "INPUT_OBJECT",
67056
67076
  "name": "RecalculateEntitlementsSideEffectsOptionsInput",
@@ -67068,11 +67088,11 @@
67068
67088
  {
67069
67089
  "kind": "OBJECT",
67070
67090
  "name": "RecalculateEntitlementsResult",
67071
- "description": null,
67091
+ "description": "Output of the entitlement recalculation operation.",
67072
67092
  "fields": [
67073
67093
  {
67074
67094
  "name": "taskId",
67075
- "description": null,
67095
+ "description": "Identifier for the background task handling the recalculation.",
67076
67096
  "args": [],
67077
67097
  "type": {
67078
67098
  "kind": "NON_NULL",
@@ -67095,12 +67115,12 @@
67095
67115
  {
67096
67116
  "kind": "INPUT_OBJECT",
67097
67117
  "name": "RecalculateEntitlementsSideEffectsOptionsInput",
67098
- "description": null,
67118
+ "description": "Flags to control side effects triggered during entitlement recalculation.",
67099
67119
  "fields": null,
67100
67120
  "inputFields": [
67101
67121
  {
67102
67122
  "name": "skipPublishToSubscribers",
67103
- "description": null,
67123
+ "description": "Prevents publishing entitlement updates to subscribers.",
67104
67124
  "type": {
67105
67125
  "kind": "SCALAR",
67106
67126
  "name": "Boolean",
@@ -67112,7 +67132,7 @@
67112
67132
  },
67113
67133
  {
67114
67134
  "name": "skipWriteToCache",
67115
- "description": null,
67135
+ "description": "Skips cache updates for recalculated entitlements.",
67116
67136
  "type": {
67117
67137
  "kind": "SCALAR",
67118
67138
  "name": "Boolean",
@@ -67124,7 +67144,7 @@
67124
67144
  },
67125
67145
  {
67126
67146
  "name": "skipWriteToDataCatalog",
67127
- "description": null,
67147
+ "description": "Skips updating the data catalog during recalculation.",
67128
67148
  "type": {
67129
67149
  "kind": "SCALAR",
67130
67150
  "name": "Boolean",
@@ -67136,7 +67156,7 @@
67136
67156
  },
67137
67157
  {
67138
67158
  "name": "skipWriteToEventLog",
67139
- "description": null,
67159
+ "description": "Skips writing entitlement recalculation events to the event log.",
67140
67160
  "type": {
67141
67161
  "kind": "SCALAR",
67142
67162
  "name": "Boolean",
@@ -67963,11 +67983,11 @@
67963
67983
  {
67964
67984
  "kind": "OBJECT",
67965
67985
  "name": "SdkConfiguration",
67966
- "description": null,
67986
+ "description": "Overall SDK configuration for the current environment.",
67967
67987
  "fields": [
67968
67988
  {
67969
67989
  "name": "isWidgetWatermarkEnabled",
67970
- "description": null,
67990
+ "description": "Flag to determine whether the Stigg watermark should be displayed in widgets.",
67971
67991
  "args": [],
67972
67992
  "type": {
67973
67993
  "kind": "SCALAR",
@@ -67979,7 +67999,7 @@
67979
67999
  },
67980
68000
  {
67981
68001
  "name": "sentryDsn",
67982
- "description": null,
68002
+ "description": "Sentry DSN (Data Source Name) used for error logging and monitoring.",
67983
68003
  "args": [],
67984
68004
  "type": {
67985
68005
  "kind": "SCALAR",
@@ -70065,7 +70085,7 @@
70065
70085
  "fields": [
70066
70086
  {
70067
70087
  "name": "entitlementsUpdated",
70068
- "description": null,
70088
+ "description": "Subscribe to real-time updates when a customers entitlements change.",
70069
70089
  "args": [],
70070
70090
  "type": {
70071
70091
  "kind": "NON_NULL",
@@ -81295,12 +81315,12 @@
81295
81315
  {
81296
81316
  "kind": "INPUT_OBJECT",
81297
81317
  "name": "SyncTaxRatesInput",
81298
- "description": null,
81318
+ "description": "Input for triggering a sync of tax rates from the billing provider.",
81299
81319
  "fields": null,
81300
81320
  "inputFields": [
81301
81321
  {
81302
81322
  "name": "environmentId",
81303
- "description": null,
81323
+ "description": "The ID of the environment for which tax rates should be synced.",
81304
81324
  "type": {
81305
81325
  "kind": "SCALAR",
81306
81326
  "name": "String",
@@ -81814,12 +81834,12 @@
81814
81834
  {
81815
81835
  "kind": "INPUT_OBJECT",
81816
81836
  "name": "TaxExempt",
81817
- "description": null,
81837
+ "description": "Information on the tax exemption.",
81818
81838
  "fields": null,
81819
81839
  "inputFields": [
81820
81840
  {
81821
81841
  "name": "type",
81822
- "description": null,
81842
+ "description": "The type of tax exemption identifier, such as VAT.",
81823
81843
  "type": {
81824
81844
  "kind": "NON_NULL",
81825
81845
  "name": null,
@@ -81835,7 +81855,7 @@
81835
81855
  },
81836
81856
  {
81837
81857
  "name": "value",
81838
- "description": null,
81858
+ "description": "The actual tax identifier value",
81839
81859
  "type": {
81840
81860
  "kind": "NON_NULL",
81841
81861
  "name": null,
@@ -82826,11 +82846,11 @@
82826
82846
  {
82827
82847
  "kind": "OBJECT",
82828
82848
  "name": "TypographyConfiguration",
82829
- "description": null,
82849
+ "description": "Typography settings for various text elements.",
82830
82850
  "fields": [
82831
82851
  {
82832
82852
  "name": "body",
82833
- "description": null,
82853
+ "description": "Font styling for body text.",
82834
82854
  "args": [],
82835
82855
  "type": {
82836
82856
  "kind": "OBJECT",
@@ -82842,7 +82862,7 @@
82842
82862
  },
82843
82863
  {
82844
82864
  "name": "fontFamily",
82845
- "description": null,
82865
+ "description": "Primary font family used across the widget.",
82846
82866
  "args": [],
82847
82867
  "type": {
82848
82868
  "kind": "SCALAR",
@@ -82854,7 +82874,7 @@
82854
82874
  },
82855
82875
  {
82856
82876
  "name": "h1",
82857
- "description": null,
82877
+ "description": "Font styling for level-1 headings.",
82858
82878
  "args": [],
82859
82879
  "type": {
82860
82880
  "kind": "OBJECT",
@@ -82866,7 +82886,7 @@
82866
82886
  },
82867
82887
  {
82868
82888
  "name": "h2",
82869
- "description": null,
82889
+ "description": "Font styling for level-2 headings.",
82870
82890
  "args": [],
82871
82891
  "type": {
82872
82892
  "kind": "OBJECT",
@@ -82878,7 +82898,7 @@
82878
82898
  },
82879
82899
  {
82880
82900
  "name": "h3",
82881
- "description": null,
82901
+ "description": "Font styling for level-3 headings.",
82882
82902
  "args": [],
82883
82903
  "type": {
82884
82904
  "kind": "OBJECT",
@@ -82897,12 +82917,12 @@
82897
82917
  {
82898
82918
  "kind": "INPUT_OBJECT",
82899
82919
  "name": "TypographyConfigurationInput",
82900
- "description": null,
82920
+ "description": "Input for setting typography styles for widgets.",
82901
82921
  "fields": null,
82902
82922
  "inputFields": [
82903
82923
  {
82904
82924
  "name": "body",
82905
- "description": null,
82925
+ "description": "Style applied to general text content.",
82906
82926
  "type": {
82907
82927
  "kind": "INPUT_OBJECT",
82908
82928
  "name": "FontVariantInput",
@@ -82914,7 +82934,7 @@
82914
82934
  },
82915
82935
  {
82916
82936
  "name": "fontFamily",
82917
- "description": null,
82937
+ "description": "Font family to be used throughout the widget.",
82918
82938
  "type": {
82919
82939
  "kind": "SCALAR",
82920
82940
  "name": "String",
@@ -82926,7 +82946,7 @@
82926
82946
  },
82927
82947
  {
82928
82948
  "name": "h1",
82929
- "description": null,
82949
+ "description": "Style applied to top-level headings.",
82930
82950
  "type": {
82931
82951
  "kind": "INPUT_OBJECT",
82932
82952
  "name": "FontVariantInput",
@@ -82938,7 +82958,7 @@
82938
82958
  },
82939
82959
  {
82940
82960
  "name": "h2",
82941
- "description": null,
82961
+ "description": "Style applied to second-level headings.",
82942
82962
  "type": {
82943
82963
  "kind": "INPUT_OBJECT",
82944
82964
  "name": "FontVariantInput",
@@ -82950,7 +82970,7 @@
82950
82970
  },
82951
82971
  {
82952
82972
  "name": "h3",
82953
- "description": null,
82973
+ "description": "Style applied to third-level headings.",
82954
82974
  "type": {
82955
82975
  "kind": "INPUT_OBJECT",
82956
82976
  "name": "FontVariantInput",
@@ -88515,11 +88535,11 @@
88515
88535
  {
88516
88536
  "kind": "OBJECT",
88517
88537
  "name": "WidgetConfiguration",
88518
- "description": null,
88538
+ "description": "Configuration settings for all embeddable widgets.",
88519
88539
  "fields": [
88520
88540
  {
88521
88541
  "name": "checkout",
88522
- "description": null,
88542
+ "description": "Custom UI configuration for the checkout widget.",
88523
88543
  "args": [],
88524
88544
  "type": {
88525
88545
  "kind": "OBJECT",
@@ -88531,7 +88551,7 @@
88531
88551
  },
88532
88552
  {
88533
88553
  "name": "customerPortal",
88534
- "description": null,
88554
+ "description": "Custom UI configuration for the customer portal widget.",
88535
88555
  "args": [],
88536
88556
  "type": {
88537
88557
  "kind": "OBJECT",
@@ -88543,7 +88563,7 @@
88543
88563
  },
88544
88564
  {
88545
88565
  "name": "paywall",
88546
- "description": null,
88566
+ "description": "Custom UI configuration for the paywall widget.",
88547
88567
  "args": [],
88548
88568
  "type": {
88549
88569
  "kind": "OBJECT",
@@ -88562,12 +88582,12 @@
88562
88582
  {
88563
88583
  "kind": "INPUT_OBJECT",
88564
88584
  "name": "WidgetConfigurationUpdateInput",
88565
- "description": null,
88585
+ "description": "Input for updating configuration settings across all widgets.",
88566
88586
  "fields": null,
88567
88587
  "inputFields": [
88568
88588
  {
88569
88589
  "name": "checkoutConfiguration",
88570
- "description": null,
88590
+ "description": "Updated configuration for the checkout widget.",
88571
88591
  "type": {
88572
88592
  "kind": "INPUT_OBJECT",
88573
88593
  "name": "CheckoutConfigurationInput",
@@ -88579,7 +88599,7 @@
88579
88599
  },
88580
88600
  {
88581
88601
  "name": "customerPortalConfiguration",
88582
- "description": null,
88602
+ "description": "Updated configuration for the customer portal widget.",
88583
88603
  "type": {
88584
88604
  "kind": "INPUT_OBJECT",
88585
88605
  "name": "CustomerPortalConfigurationInput",
@@ -88603,7 +88623,7 @@
88603
88623
  },
88604
88624
  {
88605
88625
  "name": "paywallConfiguration",
88606
- "description": null,
88626
+ "description": "Updated configuration for the paywall widget.",
88607
88627
  "type": {
88608
88628
  "kind": "INPUT_OBJECT",
88609
88629
  "name": "PaywallConfigurationInput",