revenuecat-api 1.1.0 → 1.1.1
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.
|
@@ -1093,7 +1093,6 @@ export interface components {
|
|
|
1093
1093
|
/**
|
|
1094
1094
|
* @description The platform of the app.
|
|
1095
1095
|
* Mac App Store is disabled by default. See [Legacy Mac Apps](https://www.revenuecat.com/docs/legacy-mac-apps) for more details.
|
|
1096
|
-
*
|
|
1097
1096
|
* @enum {string}
|
|
1098
1097
|
*/
|
|
1099
1098
|
type: "amazon" | "app_store" | "mac_app_store" | "play_store" | "stripe" | "rc_billing" | "roku" | "paddle";
|
|
@@ -1112,14 +1111,15 @@ export interface components {
|
|
|
1112
1111
|
bundle_id: string;
|
|
1113
1112
|
/** @description The shared secret of the app */
|
|
1114
1113
|
shared_secret?: string;
|
|
1115
|
-
/**
|
|
1114
|
+
/**
|
|
1115
|
+
* @description PKCS /#8 In App Key downloaded from App Store Connect in PEM format. Copy the contents
|
|
1116
1116
|
* of the file in this field. See instructions on how to get it in:
|
|
1117
1117
|
* https://www.revenuecat.com/docs/in-app-purchase-key-configuration
|
|
1118
|
-
|
|
1118
|
+
*/
|
|
1119
1119
|
subscription_private_key?: string;
|
|
1120
1120
|
/** @description In App Key id. The ID of the downloaded in app key. You can get it from App Store Connect */
|
|
1121
1121
|
subscription_key_id?: string;
|
|
1122
|
-
/** @description The key Issuer id. See instructions on how to obtain this in: https://www.revenuecat.com/docs/in-app-purchase-key-configuration#3-providing-the-issuer-id-to-revenuecat
|
|
1122
|
+
/** @description The key Issuer id. See instructions on how to obtain this in: https://www.revenuecat.com/docs/in-app-purchase-key-configuration#3-providing-the-issuer-id-to-revenuecat */
|
|
1123
1123
|
subscription_key_issuer?: string;
|
|
1124
1124
|
};
|
|
1125
1125
|
};
|
|
@@ -2050,7 +2050,6 @@ export interface components {
|
|
|
2050
2050
|
* @description [Deprecated] Whether the app is tied to the sandbox environment.
|
|
2051
2051
|
* This field is deprecated and will be removed in the future.
|
|
2052
2052
|
* The environment is determined by the `paddle_api_key` format.
|
|
2053
|
-
*
|
|
2054
2053
|
* @example true
|
|
2055
2054
|
*/
|
|
2056
2055
|
paddle_is_sandbox?: boolean | null;
|
|
@@ -2347,7 +2346,7 @@ export interface components {
|
|
|
2347
2346
|
* @description The company support email. This field is deprecated. Please, use `support_email` instead.
|
|
2348
2347
|
*/
|
|
2349
2348
|
seller_company_support_email?: string | null;
|
|
2350
|
-
/** @description Used as the `reply to` address in all emails sent to customers, to allow them to receive support.
|
|
2349
|
+
/** @description Used as the `reply to` address in all emails sent to customers, to allow them to receive support. */
|
|
2351
2350
|
support_email?: string | null;
|
|
2352
2351
|
/** @description The default currency to be used for the app. */
|
|
2353
2352
|
default_currency: components["schemas"]["RCBillingCurrency"];
|
|
@@ -2501,14 +2500,12 @@ export interface components {
|
|
|
2501
2500
|
pending_payment: boolean;
|
|
2502
2501
|
/**
|
|
2503
2502
|
* @description The auto renewal status of a subscription.<br><br>Possible values:<br>• `will_renew`: the subscription is currently set to automatically renew<br>• `will_not_renew`: the subscription is currently set to expire at the end of the period<br>• `will_change_product`: the subscription is currently set to change product at the end of the period (which might start a new subscription)<br>• `will_pause`: the subscription is currently set to pause at the end of the current period<br>• `requires_price_increase_consent`: the subscription will expire at the end of the current period unless the customer consents to the price increase<br>• `has_already_renewed`: the customer has already been charged for the upcoming renewal (so the renewal will take place even if the customer opts out of auto-renewal before the end of the period)
|
|
2504
|
-
*
|
|
2505
2503
|
* @example will_renew
|
|
2506
2504
|
* @enum {string}
|
|
2507
2505
|
*/
|
|
2508
2506
|
auto_renewal_status: "will_renew" | "will_not_renew" | "will_change_product" | "will_pause" | "requires_price_increase_consent" | "has_already_renewed";
|
|
2509
2507
|
/**
|
|
2510
2508
|
* @description The status of a subscription. Please note that additional states might be added in the future. To determine whether or not a subscription currently provides access to any associated entitlements, use the _gives_access_ field.<br><br>Possible values:<br>• `trialing`: the subscription is in a free trial period<br>• `active`: the subscription is active, in a paid period<br>• `expired`: the subscription is expired and no longer active<br>• `in_grace_period`: the subscription is past its regular expiry date and experienced a billing issue, but is currently still in an access-granting grace period<br>• `in_billing_retry`: the subscription has experienced a billing issue. Billing is being retried, access is suspended.-paused: the subscription is currently paused and should not provide access.<br>• `unknown`: the subscription is in an unknown state. Refer to the _gives_access_ field to determine whether or not to grant access.<br>• `incomplete`: the subscription is in an incomplete state, maybe due to incorrect billing details or because it's scheduled to start in the future.
|
|
2511
|
-
*
|
|
2512
2509
|
* @example trialing
|
|
2513
2510
|
* @enum {string}
|
|
2514
2511
|
*/
|
|
@@ -2778,7 +2775,6 @@ export interface operations {
|
|
|
2778
2775
|
"application/json": {
|
|
2779
2776
|
/**
|
|
2780
2777
|
* @description The ID of the offering the paywall will be created for.
|
|
2781
|
-
*
|
|
2782
2778
|
* @example ofrng123456789a
|
|
2783
2779
|
*/
|
|
2784
2780
|
offering_id: string;
|
|
@@ -3264,8 +3260,10 @@ export interface operations {
|
|
|
3264
3260
|
"get-customer": {
|
|
3265
3261
|
parameters: {
|
|
3266
3262
|
query?: {
|
|
3267
|
-
/**
|
|
3268
|
-
*
|
|
3263
|
+
/**
|
|
3264
|
+
* @description Specifies which fields in the response should be expanded.
|
|
3265
|
+
* Accepted values are: `attributes` (requires `customer_information:customers:read` permission).
|
|
3266
|
+
*/
|
|
3269
3267
|
expand?: "attributes"[];
|
|
3270
3268
|
};
|
|
3271
3269
|
header?: never;
|
|
@@ -3322,11 +3320,13 @@ export interface operations {
|
|
|
3322
3320
|
[name: string]: unknown;
|
|
3323
3321
|
};
|
|
3324
3322
|
content: {
|
|
3325
|
-
/**
|
|
3323
|
+
/**
|
|
3324
|
+
* @example {
|
|
3326
3325
|
* "object": "customer",
|
|
3327
3326
|
* "id": "b5b7bfd2-66fb-4091-af50-7c3cdccfdf24",
|
|
3328
3327
|
* "deleted_at": 1658399423658
|
|
3329
|
-
* }
|
|
3328
|
+
* }
|
|
3329
|
+
*/
|
|
3330
3330
|
"application/json": components["schemas"]["DeletedObject"];
|
|
3331
3331
|
};
|
|
3332
3332
|
};
|
|
@@ -3391,8 +3391,10 @@ export interface operations {
|
|
|
3391
3391
|
"get-product": {
|
|
3392
3392
|
parameters: {
|
|
3393
3393
|
query?: {
|
|
3394
|
-
/**
|
|
3395
|
-
*
|
|
3394
|
+
/**
|
|
3395
|
+
* @description Specifies which fields in the response should be expanded.
|
|
3396
|
+
* Accepted values are: `app` (requires `project_configuration:apps:read` permission).
|
|
3397
|
+
*/
|
|
3396
3398
|
expand?: "app"[];
|
|
3397
3399
|
};
|
|
3398
3400
|
header?: never;
|
|
@@ -3476,9 +3478,10 @@ export interface operations {
|
|
|
3476
3478
|
};
|
|
3477
3479
|
cookie?: never;
|
|
3478
3480
|
};
|
|
3479
|
-
/**
|
|
3481
|
+
/**
|
|
3482
|
+
* @description Store-specific information. Only required for subscription products.
|
|
3480
3483
|
* For in-app purchase products, send an empty body or omit the request body entirely.
|
|
3481
|
-
|
|
3484
|
+
*/
|
|
3482
3485
|
requestBody?: {
|
|
3483
3486
|
content: {
|
|
3484
3487
|
"application/json": {
|
|
@@ -3520,8 +3523,10 @@ export interface operations {
|
|
|
3520
3523
|
app_id?: string;
|
|
3521
3524
|
starting_after?: string;
|
|
3522
3525
|
limit?: number;
|
|
3523
|
-
/**
|
|
3524
|
-
*
|
|
3526
|
+
/**
|
|
3527
|
+
* @description Specifies which fields in the response should be expanded.
|
|
3528
|
+
* Accepted values are: `items.app` (requires `project_configuration:apps:read` permission).
|
|
3529
|
+
*/
|
|
3525
3530
|
expand?: "items.app"[];
|
|
3526
3531
|
};
|
|
3527
3532
|
header?: never;
|
|
@@ -3574,7 +3579,6 @@ export interface operations {
|
|
|
3574
3579
|
* - For Stripe, the product identifier that always starts with "prod_"
|
|
3575
3580
|
* - For Amazon, if it's a subscription, the term SKU of the subscription. If it's a one-time purchase, the SKU of the product.
|
|
3576
3581
|
* - For Roku, this is the product identifier of the subscription or one-time purchase product.
|
|
3577
|
-
*
|
|
3578
3582
|
* @example com.revenuecat.magicweather.monthly
|
|
3579
3583
|
*/
|
|
3580
3584
|
store_identifier: string;
|
|
@@ -3620,8 +3624,10 @@ export interface operations {
|
|
|
3620
3624
|
"get-entitlement": {
|
|
3621
3625
|
parameters: {
|
|
3622
3626
|
query?: {
|
|
3623
|
-
/**
|
|
3624
|
-
*
|
|
3627
|
+
/**
|
|
3628
|
+
* @description Specifies which fields in the response should be expanded.
|
|
3629
|
+
* Accepted values are: `product` (requires `project_configuration:products:read` permission).
|
|
3630
|
+
*/
|
|
3625
3631
|
expand?: "product"[];
|
|
3626
3632
|
};
|
|
3627
3633
|
header?: never;
|
|
@@ -3745,8 +3751,10 @@ export interface operations {
|
|
|
3745
3751
|
query?: {
|
|
3746
3752
|
starting_after?: string;
|
|
3747
3753
|
limit?: number;
|
|
3748
|
-
/**
|
|
3749
|
-
*
|
|
3754
|
+
/**
|
|
3755
|
+
* @description Specifies which fields in the response should be expanded.
|
|
3756
|
+
* Accepted values are: `items.product` (requires `project_configuration:products:read` permission).
|
|
3757
|
+
*/
|
|
3750
3758
|
expand?: "items.product"[];
|
|
3751
3759
|
};
|
|
3752
3760
|
header?: never;
|
|
@@ -3958,8 +3966,10 @@ export interface operations {
|
|
|
3958
3966
|
"get-offering": {
|
|
3959
3967
|
parameters: {
|
|
3960
3968
|
query?: {
|
|
3961
|
-
/**
|
|
3962
|
-
*
|
|
3969
|
+
/**
|
|
3970
|
+
* @description Specifies which fields in the response should be expanded.
|
|
3971
|
+
* Accepted values are: `package` (requires `project_configuration:packages:read` permission), `package.product` (requires `project_configuration:products:read` permission).
|
|
3972
|
+
*/
|
|
3963
3973
|
expand?: ("package" | "package.product")[];
|
|
3964
3974
|
};
|
|
3965
3975
|
header?: never;
|
|
@@ -4090,8 +4100,10 @@ export interface operations {
|
|
|
4090
4100
|
query?: {
|
|
4091
4101
|
starting_after?: string;
|
|
4092
4102
|
limit?: number;
|
|
4093
|
-
/**
|
|
4094
|
-
*
|
|
4103
|
+
/**
|
|
4104
|
+
* @description Specifies which fields in the response should be expanded.
|
|
4105
|
+
* Accepted values are: `items.package` (requires `project_configuration:packages:read` permission), `items.package.product` (requires `project_configuration:products:read` permission).
|
|
4106
|
+
*/
|
|
4095
4107
|
expand?: ("items.package" | "items.package.product")[];
|
|
4096
4108
|
};
|
|
4097
4109
|
header?: never;
|
|
@@ -4179,8 +4191,10 @@ export interface operations {
|
|
|
4179
4191
|
"get-package": {
|
|
4180
4192
|
parameters: {
|
|
4181
4193
|
query?: {
|
|
4182
|
-
/**
|
|
4183
|
-
*
|
|
4194
|
+
/**
|
|
4195
|
+
* @description Specifies which fields in the response should be expanded.
|
|
4196
|
+
* Accepted values are: `product` (requires `project_configuration:products:read` permission).
|
|
4197
|
+
*/
|
|
4184
4198
|
expand?: "product"[];
|
|
4185
4199
|
};
|
|
4186
4200
|
header?: never;
|
|
@@ -4309,8 +4323,10 @@ export interface operations {
|
|
|
4309
4323
|
query?: {
|
|
4310
4324
|
starting_after?: string;
|
|
4311
4325
|
limit?: number;
|
|
4312
|
-
/**
|
|
4313
|
-
*
|
|
4326
|
+
/**
|
|
4327
|
+
* @description Specifies which fields in the response should be expanded.
|
|
4328
|
+
* Accepted values are: `items.product` (requires `project_configuration:products:read` permission).
|
|
4329
|
+
*/
|
|
4314
4330
|
expand?: "items.product"[];
|
|
4315
4331
|
};
|
|
4316
4332
|
header?: never;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "revenuecat-api",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.1",
|
|
4
4
|
"description": "Type-safe RevenueCat API client using fetch with automatic rate limiting",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -19,17 +19,17 @@
|
|
|
19
19
|
"url": "git+https://github.com/idolize/revenuecat-api.git"
|
|
20
20
|
},
|
|
21
21
|
"dependencies": {
|
|
22
|
-
"openapi-fetch": "^0.
|
|
22
|
+
"openapi-fetch": "^0.15.0"
|
|
23
23
|
},
|
|
24
24
|
"devDependencies": {
|
|
25
|
-
"@eslint/js": "^9.
|
|
26
|
-
"@types/node": "^24.
|
|
27
|
-
"eslint": "^9.
|
|
25
|
+
"@eslint/js": "^9.38.0",
|
|
26
|
+
"@types/node": "^24.9.1",
|
|
27
|
+
"eslint": "^9.38.0",
|
|
28
28
|
"globals": "^16.4.0",
|
|
29
|
-
"openapi-typescript": "^7.
|
|
29
|
+
"openapi-typescript": "^7.10.1",
|
|
30
30
|
"typescript": "^5.9.3",
|
|
31
|
-
"typescript-eslint": "^8.46.
|
|
32
|
-
"vitest": "^
|
|
31
|
+
"typescript-eslint": "^8.46.2",
|
|
32
|
+
"vitest": "^4.0.3"
|
|
33
33
|
},
|
|
34
34
|
"scripts": {
|
|
35
35
|
"test": "vitest --no-watch",
|