@maxim_mazurok/gapi.client.paymentsresellersubscription-v1 0.0.20250805 → 0.0.20250810
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +150 -148
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://paymentsresellersubscription.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250810
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -31,61 +31,61 @@ declare namespace gapi.client {
|
|
|
31
31
|
): void;
|
|
32
32
|
|
|
33
33
|
namespace paymentsresellersubscription {
|
|
34
|
-
interface
|
|
34
|
+
interface Amount {
|
|
35
35
|
/** Required. Amount in micros (1_000_000 micros = 1 currency unit) */
|
|
36
36
|
amountMicros?: string;
|
|
37
37
|
/** Required. Currency codes in accordance with [ISO-4217 Currency Codes] (https://en.wikipedia.org/wiki/ISO_4217). For example, USD. */
|
|
38
38
|
currencyCode?: string;
|
|
39
39
|
}
|
|
40
|
-
interface
|
|
40
|
+
interface CancelSubscriptionRequest {
|
|
41
41
|
/** Optional. If true, Google will cancel the subscription immediately, and may or may not (based on the contract) issue a prorated refund for the remainder of the billing cycle. Otherwise, Google defers the cancelation at renewal_time, and will not issue a refund. - YouTube subscriptions must use this option currently. However, the user will still have access to the subscription until the end of the billing cycle. */
|
|
42
42
|
cancelImmediately?: boolean;
|
|
43
43
|
/** Specifies the reason for the cancellation. */
|
|
44
44
|
cancellationReason?: string;
|
|
45
45
|
}
|
|
46
|
-
interface
|
|
46
|
+
interface CancelSubscriptionResponse {
|
|
47
47
|
/** The cancelled subscription resource. */
|
|
48
|
-
subscription?:
|
|
48
|
+
subscription?: Subscription;
|
|
49
49
|
}
|
|
50
|
-
interface
|
|
50
|
+
interface CreateSubscriptionIntent {
|
|
51
51
|
/** Required. The parent resource name, which is the identifier of the partner. */
|
|
52
52
|
parent?: string;
|
|
53
53
|
/** Required. The Subscription to be created. */
|
|
54
|
-
subscription?:
|
|
54
|
+
subscription?: Subscription;
|
|
55
55
|
/** Required. Identifies the subscription resource on the Partner side. The value is restricted to 63 ASCII characters at the maximum. If a subscription was previously created with the same subscription_id, we will directly return that one. */
|
|
56
56
|
subscriptionId?: string;
|
|
57
57
|
}
|
|
58
|
-
interface
|
|
58
|
+
interface Duration {
|
|
59
59
|
/** number of duration units to be included. */
|
|
60
60
|
count?: number;
|
|
61
61
|
/** The unit used for the duration */
|
|
62
62
|
unit?: string;
|
|
63
63
|
}
|
|
64
|
-
interface
|
|
64
|
+
interface EntitleSubscriptionIntent {
|
|
65
65
|
/** Required. The name of the subscription resource that is entitled to the current end user. It is in the format of "partners/{partner_id}/subscriptions/{subscriptionId}". */
|
|
66
66
|
name?: string;
|
|
67
67
|
}
|
|
68
|
-
interface
|
|
68
|
+
interface EntitleSubscriptionRequest {
|
|
69
69
|
/** Optional. The line items to be entitled. If unspecified, all line items will be entitled. */
|
|
70
|
-
lineItemEntitlementDetails?:
|
|
70
|
+
lineItemEntitlementDetails?: EntitleSubscriptionRequestLineItemEntitlementDetails[];
|
|
71
71
|
}
|
|
72
|
-
interface
|
|
72
|
+
interface EntitleSubscriptionRequestLineItemEntitlementDetails {
|
|
73
73
|
/** Required. The index of the line item to be entitled. */
|
|
74
74
|
lineItemIndex?: number;
|
|
75
75
|
/** Optional. Only applicable if the line item corresponds to a hard bundle. Product resource names that identify the bundle elements to be entitled in the line item. If unspecified, all bundle elements will be entitled. The format is 'partners/{partner_id}/products/{product_id}'. */
|
|
76
76
|
products?: string[];
|
|
77
77
|
}
|
|
78
|
-
interface
|
|
78
|
+
interface EntitleSubscriptionResponse {
|
|
79
79
|
/** The subscription that has user linked to it. */
|
|
80
|
-
subscription?:
|
|
80
|
+
subscription?: Subscription;
|
|
81
81
|
}
|
|
82
|
-
interface
|
|
82
|
+
interface ExtendSubscriptionRequest {
|
|
83
83
|
/** Required. Specifies details of the extension. Currently, the duration of the extension must be exactly one billing cycle of the original subscription. */
|
|
84
|
-
extension?:
|
|
84
|
+
extension?: Extension;
|
|
85
85
|
/** Required. Restricted to 36 ASCII characters. A random UUID is recommended. The idempotency key for the request. The ID generation logic is controlled by the partner. request_id should be the same as on retries of the same request. A different request_id must be used for a extension of a different cycle. */
|
|
86
86
|
requestId?: string;
|
|
87
87
|
}
|
|
88
|
-
interface
|
|
88
|
+
interface ExtendSubscriptionResponse {
|
|
89
89
|
/** The time at which the subscription is expected to be extended, in ISO 8061 format. UTC timezone. Example, "cycleEndTime":"2019-08-31T17:28:54.564Z" */
|
|
90
90
|
cycleEndTime?: string;
|
|
91
91
|
/** End of the free trial period, in ISO 8061 format. UTC timezone. Example, "freeTrialEndTime":"2019-08-31T17:28:54.564Z" This time will be set the same as initial subscription creation time if no free trial period is offered to the partner. */
|
|
@@ -93,13 +93,13 @@ declare namespace gapi.client {
|
|
|
93
93
|
/** Output only. The time at which the subscription is expected to be renewed by Google - a new charge will be incurred and the service entitlement will be renewed. A non-immediate cancellation will take place at this time too, before which, the service entitlement for the end user will remain valid. UTC timezone in ISO 8061 format. For example: "2019-08-31T17:28:54.564Z" */
|
|
94
94
|
renewalTime?: string;
|
|
95
95
|
}
|
|
96
|
-
interface
|
|
96
|
+
interface Extension {
|
|
97
97
|
/** Required. Specifies the period of access the subscription should grant. */
|
|
98
|
-
duration?:
|
|
98
|
+
duration?: Duration;
|
|
99
99
|
/** Required. Identifier of the end-user in partner’s system. */
|
|
100
100
|
partnerUserToken?: string;
|
|
101
101
|
}
|
|
102
|
-
interface
|
|
102
|
+
interface FindEligiblePromotionsRequest {
|
|
103
103
|
/** Optional. Specifies the filters for the promotion results. The syntax is defined in https://google.aip.dev/160 with the following caveats: 1. Only the following features are supported: - Logical operator `AND` - Comparison operator `=` (no wildcards `*`) - Traversal operator `.` - Has operator `:` (no wildcards `*`) 2. Only the following fields are supported: - `applicableProducts` - `regionCodes` - `youtubePayload.partnerEligibilityId` - `youtubePayload.postalCode` 3. Unless explicitly mentioned above, other features are not supported. Example: `applicableProducts:partners/partner1/products/product1 AND regionCodes:US AND youtubePayload.postalCode=94043 AND youtubePayload.partnerEligibilityId=eligibility-id` */
|
|
104
104
|
filter?: string;
|
|
105
105
|
/** Optional. The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */
|
|
@@ -107,31 +107,33 @@ declare namespace gapi.client {
|
|
|
107
107
|
/** Optional. A page token, received from a previous `ListPromotions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPromotions` must match the call that provided the page token. */
|
|
108
108
|
pageToken?: string;
|
|
109
109
|
}
|
|
110
|
-
interface
|
|
110
|
+
interface FindEligiblePromotionsResponse {
|
|
111
111
|
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages. */
|
|
112
112
|
nextPageToken?: string;
|
|
113
113
|
/** The promotions for the current user. */
|
|
114
|
-
promotions?:
|
|
114
|
+
promotions?: Promotion[];
|
|
115
115
|
}
|
|
116
|
-
interface
|
|
116
|
+
interface FiniteBillingCycleDetails {
|
|
117
117
|
/** Required. The number of a subscription line item billing cycles after which billing will stop automatically. */
|
|
118
118
|
billingCycleCountLimit?: string;
|
|
119
119
|
}
|
|
120
|
-
interface
|
|
120
|
+
interface GenerateUserSessionRequest {
|
|
121
121
|
/** The user intent to generate the user session. */
|
|
122
|
-
intentPayload?:
|
|
122
|
+
intentPayload?: IntentPayload;
|
|
123
123
|
}
|
|
124
|
-
interface
|
|
124
|
+
interface GenerateUserSessionResponse {
|
|
125
125
|
/** The generated user session. The token size is proportional to the size of the intent payload. */
|
|
126
|
-
userSession?:
|
|
126
|
+
userSession?: UserSession;
|
|
127
127
|
}
|
|
128
|
-
interface
|
|
128
|
+
interface GoogleHomePayload {
|
|
129
129
|
/** Output only. This identifies whether the subscription is attached to a Google Home structure. */
|
|
130
130
|
attachedToGoogleStructure?: boolean;
|
|
131
|
+
/** Optional. Structure identifier on Google side. */
|
|
132
|
+
googleStructureId?: string;
|
|
131
133
|
/** Optional. This identifies the structure ID on partner side that the subscription should be applied to. Only required when the partner requires structure mapping. */
|
|
132
134
|
partnerStructureId?: string;
|
|
133
135
|
}
|
|
134
|
-
interface
|
|
136
|
+
interface GoogleOnePayload {
|
|
135
137
|
/** Campaign attributed to sales of this subscription. */
|
|
136
138
|
campaigns?: string[];
|
|
137
139
|
/** The type of offering the subscription was sold by the partner. e.g. VAS. */
|
|
@@ -141,75 +143,87 @@ declare namespace gapi.client {
|
|
|
141
143
|
/** The identifier for the partner store where the subscription was sold. */
|
|
142
144
|
storeId?: string;
|
|
143
145
|
}
|
|
144
|
-
interface
|
|
146
|
+
interface GoogleTypeLocalizedText {
|
|
147
|
+
/** The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */
|
|
148
|
+
languageCode?: string;
|
|
149
|
+
/** Localized string in the language corresponding to language_code below. */
|
|
150
|
+
text?: string;
|
|
151
|
+
}
|
|
152
|
+
interface IntentPayload {
|
|
145
153
|
/** The request to create a subscription. */
|
|
146
|
-
createIntent?:
|
|
154
|
+
createIntent?: CreateSubscriptionIntent;
|
|
147
155
|
/** The request to entitle a subscription. */
|
|
148
|
-
entitleIntent?:
|
|
156
|
+
entitleIntent?: EntitleSubscriptionIntent;
|
|
149
157
|
}
|
|
150
|
-
interface
|
|
158
|
+
interface ListProductsResponse {
|
|
151
159
|
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages. */
|
|
152
160
|
nextPageToken?: string;
|
|
153
161
|
/** The products for the specified partner. */
|
|
154
|
-
products?:
|
|
162
|
+
products?: Product[];
|
|
155
163
|
}
|
|
156
|
-
interface
|
|
164
|
+
interface ListPromotionsResponse {
|
|
157
165
|
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages. */
|
|
158
166
|
nextPageToken?: string;
|
|
159
167
|
/** The promotions for the specified partner. */
|
|
160
|
-
promotions?:
|
|
168
|
+
promotions?: Promotion[];
|
|
161
169
|
}
|
|
162
|
-
interface
|
|
170
|
+
interface Location {
|
|
163
171
|
/** The postal code this location refers to. Ex. "94043" */
|
|
164
172
|
postalCode?: string;
|
|
165
173
|
/** 2-letter ISO region code for current content region. Ex. “US” Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1 */
|
|
166
174
|
regionCode?: string;
|
|
167
175
|
}
|
|
168
|
-
interface
|
|
176
|
+
interface Product {
|
|
169
177
|
/** Output only. Specifies the details for a bundle product. */
|
|
170
178
|
bundleDetails?: ProductBundleDetails;
|
|
171
179
|
/** Optional. Details for a subscription line item with finite billing cycles. If unset, the line item will be charged indefinitely. */
|
|
172
|
-
finiteBillingCycleDetails?:
|
|
180
|
+
finiteBillingCycleDetails?: FiniteBillingCycleDetails;
|
|
173
181
|
/** Identifier. Response only. Resource name of the product. It will have the format of "partners/{partner_id}/products/{product_id}" */
|
|
174
182
|
name?: string;
|
|
175
183
|
/** Output only. Price configs for the product in the available regions. */
|
|
176
|
-
priceConfigs?:
|
|
184
|
+
priceConfigs?: ProductPriceConfig[];
|
|
177
185
|
/** Output only. Specifies the type of the product. */
|
|
178
186
|
productType?: string;
|
|
179
187
|
/** Output only. 2-letter ISO region code where the product is available in. Ex. "US" Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1 */
|
|
180
188
|
regionCodes?: string[];
|
|
181
189
|
/** Output only. Specifies the length of the billing cycle of the subscription. */
|
|
182
|
-
subscriptionBillingCycleDuration?:
|
|
190
|
+
subscriptionBillingCycleDuration?: Duration;
|
|
183
191
|
/** Output only. Localized human readable name of the product. */
|
|
184
192
|
titles?: GoogleTypeLocalizedText[];
|
|
185
193
|
}
|
|
186
|
-
interface
|
|
194
|
+
interface ProductBundleDetails {
|
|
195
|
+
/** The individual products that are included in the bundle. */
|
|
196
|
+
bundleElements?: ProductBundleDetailsBundleElement[];
|
|
197
|
+
/** The entitlement mode of the bundle product. */
|
|
198
|
+
entitlementMode?: string;
|
|
199
|
+
}
|
|
200
|
+
interface ProductBundleDetailsBundleElement {
|
|
187
201
|
/** Required. Output only. Product resource name that identifies the bundle element. The format is 'partners/{partner_id}/products/{product_id}'. */
|
|
188
202
|
product?: string;
|
|
189
203
|
}
|
|
190
|
-
interface
|
|
204
|
+
interface ProductPayload {
|
|
191
205
|
/** Payload specific to Google Home products. */
|
|
192
|
-
googleHomePayload?:
|
|
206
|
+
googleHomePayload?: GoogleHomePayload;
|
|
193
207
|
/** Product-specific payloads. Payload specific to Google One products. */
|
|
194
|
-
googleOnePayload?:
|
|
208
|
+
googleOnePayload?: GoogleOnePayload;
|
|
195
209
|
/** Payload specific to Youtube products. */
|
|
196
|
-
youtubePayload?:
|
|
210
|
+
youtubePayload?: YoutubePayload;
|
|
197
211
|
}
|
|
198
|
-
interface
|
|
212
|
+
interface ProductPriceConfig {
|
|
199
213
|
/** Output only. The price in the region. */
|
|
200
|
-
amount?:
|
|
214
|
+
amount?: Amount;
|
|
201
215
|
/** Output only. 2-letter ISO region code where the product is available in. Ex. "US". */
|
|
202
216
|
regionCode?: string;
|
|
203
217
|
}
|
|
204
|
-
interface
|
|
218
|
+
interface Promotion {
|
|
205
219
|
/** Output only. The product ids this promotion can be applied to. */
|
|
206
220
|
applicableProducts?: string[];
|
|
207
221
|
/** Optional. Specifies the end time (exclusive) of the period that the promotion is available in. If unset, the promotion is available indefinitely. */
|
|
208
222
|
endTime?: string;
|
|
209
223
|
/** Optional. Specifies the duration of the free trial of the subscription when promotion_type is PROMOTION_TYPE_FREE_TRIAL */
|
|
210
|
-
freeTrialDuration?:
|
|
224
|
+
freeTrialDuration?: Duration;
|
|
211
225
|
/** Optional. Specifies the introductory pricing details when the promotion_type is PROMOTION_TYPE_INTRODUCTORY_PRICING. */
|
|
212
|
-
introductoryPricingDetails?:
|
|
226
|
+
introductoryPricingDetails?: PromotionIntroductoryPricingDetails;
|
|
213
227
|
/** Identifier. Response only. Resource name of the subscription promotion. It will have the format of "partners/{partner_id}/promotion/{promotion_id}" */
|
|
214
228
|
name?: string;
|
|
215
229
|
/** Output only. Specifies the type of the promotion. */
|
|
@@ -221,13 +235,13 @@ declare namespace gapi.client {
|
|
|
221
235
|
/** Output only. Localized human readable name of the promotion. */
|
|
222
236
|
titles?: GoogleTypeLocalizedText[];
|
|
223
237
|
}
|
|
224
|
-
interface
|
|
238
|
+
interface PromotionIntroductoryPricingDetails {
|
|
225
239
|
/** Output only. Specifies the introductory pricing periods. */
|
|
226
|
-
introductoryPricingSpecs?:
|
|
240
|
+
introductoryPricingSpecs?: PromotionIntroductoryPricingDetailsIntroductoryPricingSpec[];
|
|
227
241
|
}
|
|
228
|
-
interface
|
|
242
|
+
interface PromotionIntroductoryPricingDetailsIntroductoryPricingSpec {
|
|
229
243
|
/** Output only. The discount amount. The value is positive. */
|
|
230
|
-
discountAmount?:
|
|
244
|
+
discountAmount?: Amount;
|
|
231
245
|
/** Output only. The discount percentage in micros. For example, 50,000 represents 5%. */
|
|
232
246
|
discountRatioMicros?: string;
|
|
233
247
|
/** Output only. The duration of an introductory offer in billing cycles. */
|
|
@@ -235,20 +249,20 @@ declare namespace gapi.client {
|
|
|
235
249
|
/** Output only. 2-letter ISO region code where the product is available in. Ex. "US". */
|
|
236
250
|
regionCode?: string;
|
|
237
251
|
}
|
|
238
|
-
interface
|
|
239
|
-
interface
|
|
252
|
+
interface ResumeSubscriptionRequest {}
|
|
253
|
+
interface ResumeSubscriptionResponse {
|
|
240
254
|
/** The resumed subscription resource. */
|
|
241
|
-
subscription?:
|
|
255
|
+
subscription?: Subscription;
|
|
242
256
|
}
|
|
243
|
-
interface
|
|
257
|
+
interface ServicePeriod {
|
|
244
258
|
/** Optional. The end time of the service period. Time is exclusive. */
|
|
245
259
|
endTime?: string;
|
|
246
260
|
/** Required. The start time of the service period. Time is inclusive. */
|
|
247
261
|
startTime?: string;
|
|
248
262
|
}
|
|
249
|
-
interface
|
|
263
|
+
interface Subscription {
|
|
250
264
|
/** Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. */
|
|
251
|
-
cancellationDetails?:
|
|
265
|
+
cancellationDetails?: SubscriptionCancellationDetails;
|
|
252
266
|
/** Output only. System generated timestamp when the subscription is created. UTC timezone. */
|
|
253
267
|
createTime?: string;
|
|
254
268
|
/** Output only. The time at which the subscription is expected to be extended, in ISO 8061 format. UTC timezone. For example: "2019-08-31T17:28:54.564Z" */
|
|
@@ -258,9 +272,9 @@ declare namespace gapi.client {
|
|
|
258
272
|
/** Output only. End of the free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified. */
|
|
259
273
|
freeTrialEndTime?: string;
|
|
260
274
|
/** Required. The line items of the subscription. */
|
|
261
|
-
lineItems?:
|
|
275
|
+
lineItems?: SubscriptionLineItem[];
|
|
262
276
|
/** Output only. Describes the details of the migrated subscription. Only populated if this subscription is migrated from another system. */
|
|
263
|
-
migrationDetails?:
|
|
277
|
+
migrationDetails?: SubscriptionMigrationDetails;
|
|
264
278
|
/** Identifier. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}". This is available for authorizeAddon, but otherwise is response only. */
|
|
265
279
|
name?: string;
|
|
266
280
|
/** Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. */
|
|
@@ -272,7 +286,7 @@ declare namespace gapi.client {
|
|
|
272
286
|
/** Optional. Deprecated: consider using the top-level `promotion_specs` as the input. Optional. Resource name that identifies one or more promotions that can be applied on the product. A typical promotion for a subscription is Free trial. The format will be 'partners/{partner_id}/promotions/{promotion_id}'. */
|
|
273
287
|
promotions?: string[];
|
|
274
288
|
/** Optional. Subscription-level promotions. Only free trial is supported on this level. It determines the first renewal time of the subscription to be the end of the free trial period. Specify the promotion resource name only when used as input. */
|
|
275
|
-
promotionSpecs?:
|
|
289
|
+
promotionSpecs?: SubscriptionPromotionSpec[];
|
|
276
290
|
/** Optional. The timestamp when the user transaction was made with the Partner. Specify for the case of "bundle with choice", and it must be before the provision_time (when the user makes a selection). */
|
|
277
291
|
purchaseTime?: string;
|
|
278
292
|
/** Output only. The place where partners should redirect the end-user to after creation. This field might also be populated when creation failed. However, Partners should always prepare a default URL to redirect the user in case this field is empty. */
|
|
@@ -280,91 +294,95 @@ declare namespace gapi.client {
|
|
|
280
294
|
/** Output only. The time at which the subscription is expected to be renewed by Google - a new charge will be incurred and the service entitlement will be renewed. A non-immediate cancellation will take place at this time too, before which, the service entitlement for the end user will remain valid. UTC timezone in ISO 8061 format. For example: "2019-08-31T17:28:54.564Z" */
|
|
281
295
|
renewalTime?: string;
|
|
282
296
|
/** Required. The location that the service is provided as indicated by the partner. */
|
|
283
|
-
serviceLocation?:
|
|
297
|
+
serviceLocation?: Location;
|
|
284
298
|
/** Output only. Describes the state of the subscription. See more details at [the lifecycle of a subscription](/payments/reseller/subscription/reference/index/Receive.Notifications#payments-subscription-lifecycle). */
|
|
285
299
|
state?: string;
|
|
286
300
|
/** Output only. System generated timestamp when the subscription is most recently updated. UTC timezone. */
|
|
287
301
|
updateTime?: string;
|
|
288
302
|
/** Optional. Details about the previous subscription that this new subscription upgrades/downgrades from. Only populated if this subscription is an upgrade/downgrade from another subscription. */
|
|
289
|
-
upgradeDowngradeDetails?:
|
|
303
|
+
upgradeDowngradeDetails?: SubscriptionUpgradeDowngradeDetails;
|
|
290
304
|
}
|
|
291
|
-
interface
|
|
305
|
+
interface SubscriptionCancellationDetails {
|
|
292
306
|
/** Output only. The reason of the cancellation. */
|
|
293
307
|
reason?: string;
|
|
294
308
|
}
|
|
295
|
-
interface
|
|
309
|
+
interface SubscriptionLineItem {
|
|
296
310
|
/** Output only. The price of the product/service in this line item. The amount could be the wholesale price, or it can include a cost of sale based on the contract. */
|
|
297
|
-
amount?:
|
|
311
|
+
amount?: Amount;
|
|
298
312
|
/** Output only. The bundle details for the line item. Only populated if the line item corresponds to a hard bundle. */
|
|
299
313
|
bundleDetails?: SubscriptionLineItemBundleDetails;
|
|
300
314
|
/** Output only. Description of this line item. */
|
|
301
315
|
description?: string;
|
|
302
316
|
/** Optional. Details for a subscription line item with finite billing cycles. If unset, the line item will be charged indefinitely. Used only with LINE_ITEM_RECURRENCE_TYPE_PERIODIC. */
|
|
303
|
-
finiteBillingCycleDetails?:
|
|
317
|
+
finiteBillingCycleDetails?: FiniteBillingCycleDetails;
|
|
304
318
|
/** Output only. The free trial end time will be populated after the line item is successfully processed. End time of the line item free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified. */
|
|
305
319
|
lineItemFreeTrialEndTime?: string;
|
|
306
320
|
/** Output only. A unique index of the subscription line item. */
|
|
307
321
|
lineItemIndex?: number;
|
|
308
322
|
/** Optional. The promotions applied on the line item. It can be: - an introductory pricing promotion. - a free trial promotion. This feature is not enabled. If used, the request will be rejected. When used as input in Create or Provision API, specify its resource name only. */
|
|
309
|
-
lineItemPromotionSpecs?:
|
|
323
|
+
lineItemPromotionSpecs?: SubscriptionPromotionSpec[];
|
|
310
324
|
/** Output only. Details only set for a ONE_TIME recurrence line item. */
|
|
311
|
-
oneTimeRecurrenceDetails?:
|
|
325
|
+
oneTimeRecurrenceDetails?: SubscriptionLineItemOneTimeRecurrenceDetails;
|
|
312
326
|
/** Required. Product resource name that identifies one the line item The format is 'partners/{partner_id}/products/{product_id}'. */
|
|
313
327
|
product?: string;
|
|
314
328
|
/** Optional. Product specific payload for this line item. */
|
|
315
|
-
productPayload?:
|
|
329
|
+
productPayload?: ProductPayload;
|
|
316
330
|
/** Output only. The recurrence type of the line item. */
|
|
317
331
|
recurrenceType?: string;
|
|
318
332
|
/** Output only. The state of the line item. */
|
|
319
333
|
state?: string;
|
|
320
334
|
}
|
|
321
|
-
interface
|
|
335
|
+
interface SubscriptionLineItemBundleDetails {
|
|
336
|
+
/** Output only. The details for each element in the hard bundle. */
|
|
337
|
+
bundleElementDetails?: SubscriptionLineItemBundleDetailsBundleElementDetails[];
|
|
338
|
+
}
|
|
339
|
+
interface SubscriptionLineItemBundleDetailsBundleElementDetails {
|
|
322
340
|
/** Output only. Product resource name that identifies the bundle element. The format is 'partners/{partner_id}/products/{product_id}'. */
|
|
323
341
|
product?: string;
|
|
324
342
|
/** Output only. The time when this product is linked to an end user. */
|
|
325
343
|
userAccountLinkedTime?: string;
|
|
326
344
|
}
|
|
327
|
-
interface
|
|
345
|
+
interface SubscriptionLineItemOneTimeRecurrenceDetails {
|
|
328
346
|
/** Output only. The service period of the ONE_TIME line item. */
|
|
329
|
-
servicePeriod?:
|
|
347
|
+
servicePeriod?: ServicePeriod;
|
|
330
348
|
}
|
|
331
|
-
interface
|
|
349
|
+
interface SubscriptionMigrationDetails {
|
|
332
350
|
/** Output only. The migrated subscription id in the legacy system. */
|
|
333
351
|
migratedSubscriptionId?: string;
|
|
334
352
|
}
|
|
335
|
-
interface
|
|
353
|
+
interface SubscriptionPromotionSpec {
|
|
336
354
|
/** Output only. The duration of the free trial if the promotion is of type FREE_TRIAL. */
|
|
337
|
-
freeTrialDuration?:
|
|
355
|
+
freeTrialDuration?: Duration;
|
|
338
356
|
/** Output only. The details of the introductory pricing spec if the promotion is of type INTRODUCTORY_PRICING. */
|
|
339
|
-
introductoryPricingDetails?:
|
|
357
|
+
introductoryPricingDetails?: PromotionIntroductoryPricingDetails;
|
|
340
358
|
/** Required. Promotion resource name that identifies a promotion. The format is 'partners/{partner_id}/promotions/{promotion_id}'. */
|
|
341
359
|
promotion?: string;
|
|
342
360
|
/** Output only. The type of the promotion for the spec. */
|
|
343
361
|
type?: string;
|
|
344
362
|
}
|
|
345
|
-
interface
|
|
363
|
+
interface SubscriptionUpgradeDowngradeDetails {
|
|
346
364
|
/** Required. Specifies the billing cycle spec for the new upgraded/downgraded subscription. */
|
|
347
365
|
billingCycleSpec?: string;
|
|
348
366
|
/** Required. The previous subscription id to be replaced. This is not the full resource name, use the subscription_id segment only. */
|
|
349
367
|
previousSubscriptionId?: string;
|
|
350
368
|
}
|
|
351
|
-
interface
|
|
352
|
-
interface
|
|
369
|
+
interface SuspendSubscriptionRequest {}
|
|
370
|
+
interface SuspendSubscriptionResponse {
|
|
353
371
|
/** The suspended subscription resource. */
|
|
354
|
-
subscription?:
|
|
372
|
+
subscription?: Subscription;
|
|
355
373
|
}
|
|
356
|
-
interface
|
|
357
|
-
interface
|
|
374
|
+
interface UndoCancelSubscriptionRequest {}
|
|
375
|
+
interface UndoCancelSubscriptionResponse {
|
|
358
376
|
/** The updated subscription resource. */
|
|
359
|
-
subscription?:
|
|
377
|
+
subscription?: Subscription;
|
|
360
378
|
}
|
|
361
|
-
interface
|
|
379
|
+
interface UserSession {
|
|
362
380
|
/** Output only. The time at which the user session expires. */
|
|
363
381
|
expireTime?: string;
|
|
364
382
|
/** Output only. The encrypted token of the user session, including the information of the user's intent and request. This token should be provided when redirecting the user to Google. */
|
|
365
383
|
token?: string;
|
|
366
384
|
}
|
|
367
|
-
interface
|
|
385
|
+
interface YoutubePayload {
|
|
368
386
|
/** Output only. The access expiration time for this line item. */
|
|
369
387
|
accessEndTime?: string;
|
|
370
388
|
/** The list of eligibility_ids which are applicable for the line item. */
|
|
@@ -372,22 +390,6 @@ declare namespace gapi.client {
|
|
|
372
390
|
/** Optional. Specifies the plan type offered to the end user by the partner. */
|
|
373
391
|
partnerPlanType?: string;
|
|
374
392
|
}
|
|
375
|
-
interface GoogleTypeLocalizedText {
|
|
376
|
-
/** The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. */
|
|
377
|
-
languageCode?: string;
|
|
378
|
-
/** Localized string in the language corresponding to language_code below. */
|
|
379
|
-
text?: string;
|
|
380
|
-
}
|
|
381
|
-
interface ProductBundleDetails {
|
|
382
|
-
/** The individual products that are included in the bundle. */
|
|
383
|
-
bundleElements?: GoogleCloudPaymentsResellerSubscriptionV1ProductBundleDetailsBundleElement[];
|
|
384
|
-
/** The entitlement mode of the bundle product. */
|
|
385
|
-
entitlementMode?: string;
|
|
386
|
-
}
|
|
387
|
-
interface SubscriptionLineItemBundleDetails {
|
|
388
|
-
/** Output only. The details for each element in the hard bundle. */
|
|
389
|
-
bundleElementDetails?: GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItemBundleDetailsBundleElementDetails[];
|
|
390
|
-
}
|
|
391
393
|
interface ProductsResource {
|
|
392
394
|
/** Currently, it doesn't support **YouTube** products. Retrieves the products that can be resold by the partner. It should be autenticated with a service account. */
|
|
393
395
|
list(request?: {
|
|
@@ -421,7 +423,7 @@ declare namespace gapi.client {
|
|
|
421
423
|
upload_protocol?: string;
|
|
422
424
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
423
425
|
uploadType?: string;
|
|
424
|
-
}): Request<
|
|
426
|
+
}): Request<ListProductsResponse>;
|
|
425
427
|
}
|
|
426
428
|
interface PromotionsResource {
|
|
427
429
|
/** Currently, it is only enabeld for **YouTube**. Finds eligible promotions for the current user. The API requires user authorization via OAuth. The bare minimum oauth scope `openid` is sufficient, which will skip the consent screen. */
|
|
@@ -451,8 +453,8 @@ declare namespace gapi.client {
|
|
|
451
453
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
452
454
|
uploadType?: string;
|
|
453
455
|
/** Request body */
|
|
454
|
-
resource:
|
|
455
|
-
}): Request<
|
|
456
|
+
resource: FindEligiblePromotionsRequest;
|
|
457
|
+
}): Request<FindEligiblePromotionsResponse>;
|
|
456
458
|
findEligible(
|
|
457
459
|
request: {
|
|
458
460
|
/** V1 error format. */
|
|
@@ -480,8 +482,8 @@ declare namespace gapi.client {
|
|
|
480
482
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
481
483
|
uploadType?: string;
|
|
482
484
|
},
|
|
483
|
-
body:
|
|
484
|
-
): Request<
|
|
485
|
+
body: FindEligiblePromotionsRequest,
|
|
486
|
+
): Request<FindEligiblePromotionsResponse>;
|
|
485
487
|
/** Currently, it doesn't support **YouTube** promotions. Retrieves the promotions, such as free trial, that can be used by the partner. It should be autenticated with a service account. */
|
|
486
488
|
list(request?: {
|
|
487
489
|
/** V1 error format. */
|
|
@@ -514,7 +516,7 @@ declare namespace gapi.client {
|
|
|
514
516
|
upload_protocol?: string;
|
|
515
517
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
516
518
|
uploadType?: string;
|
|
517
|
-
}): Request<
|
|
519
|
+
}): Request<ListPromotionsResponse>;
|
|
518
520
|
}
|
|
519
521
|
interface SubscriptionsResource {
|
|
520
522
|
/** Cancels a subscription service either immediately or by the end of the current billing cycle for their customers. It should be called directly by the partner using service accounts. */
|
|
@@ -544,8 +546,8 @@ declare namespace gapi.client {
|
|
|
544
546
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
545
547
|
uploadType?: string;
|
|
546
548
|
/** Request body */
|
|
547
|
-
resource:
|
|
548
|
-
}): Request<
|
|
549
|
+
resource: CancelSubscriptionRequest;
|
|
550
|
+
}): Request<CancelSubscriptionResponse>;
|
|
549
551
|
cancel(
|
|
550
552
|
request: {
|
|
551
553
|
/** V1 error format. */
|
|
@@ -573,8 +575,8 @@ declare namespace gapi.client {
|
|
|
573
575
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
574
576
|
uploadType?: string;
|
|
575
577
|
},
|
|
576
|
-
body:
|
|
577
|
-
): Request<
|
|
578
|
+
body: CancelSubscriptionRequest,
|
|
579
|
+
): Request<CancelSubscriptionResponse>;
|
|
578
580
|
/** Used by partners to create a subscription for their customers. The created subscription is associated with the end user inferred from the end user credentials. This API must be authorized by the end user using OAuth. */
|
|
579
581
|
create(request: {
|
|
580
582
|
/** V1 error format. */
|
|
@@ -604,8 +606,8 @@ declare namespace gapi.client {
|
|
|
604
606
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
605
607
|
uploadType?: string;
|
|
606
608
|
/** Request body */
|
|
607
|
-
resource:
|
|
608
|
-
}): Request<
|
|
609
|
+
resource: Subscription;
|
|
610
|
+
}): Request<Subscription>;
|
|
609
611
|
create(
|
|
610
612
|
request: {
|
|
611
613
|
/** V1 error format. */
|
|
@@ -635,8 +637,8 @@ declare namespace gapi.client {
|
|
|
635
637
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
636
638
|
uploadType?: string;
|
|
637
639
|
},
|
|
638
|
-
body:
|
|
639
|
-
): Request<
|
|
640
|
+
body: Subscription,
|
|
641
|
+
): Request<Subscription>;
|
|
640
642
|
/** Entitles a previously provisioned subscription to the current end user. The end user identity is inferred from the authorized credential of the request. This API must be authorized by the end user using OAuth. */
|
|
641
643
|
entitle(request: {
|
|
642
644
|
/** V1 error format. */
|
|
@@ -664,8 +666,8 @@ declare namespace gapi.client {
|
|
|
664
666
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
665
667
|
uploadType?: string;
|
|
666
668
|
/** Request body */
|
|
667
|
-
resource:
|
|
668
|
-
}): Request<
|
|
669
|
+
resource: EntitleSubscriptionRequest;
|
|
670
|
+
}): Request<EntitleSubscriptionResponse>;
|
|
669
671
|
entitle(
|
|
670
672
|
request: {
|
|
671
673
|
/** V1 error format. */
|
|
@@ -693,8 +695,8 @@ declare namespace gapi.client {
|
|
|
693
695
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
694
696
|
uploadType?: string;
|
|
695
697
|
},
|
|
696
|
-
body:
|
|
697
|
-
): Request<
|
|
698
|
+
body: EntitleSubscriptionRequest,
|
|
699
|
+
): Request<EntitleSubscriptionResponse>;
|
|
698
700
|
/** [Opt-in only] Most partners should be on auto-extend by default. Extends a subscription service for their customers on an ongoing basis for the subscription to remain active and renewable. It should be called directly by the partner using service accounts. */
|
|
699
701
|
extend(request: {
|
|
700
702
|
/** V1 error format. */
|
|
@@ -722,8 +724,8 @@ declare namespace gapi.client {
|
|
|
722
724
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
723
725
|
uploadType?: string;
|
|
724
726
|
/** Request body */
|
|
725
|
-
resource:
|
|
726
|
-
}): Request<
|
|
727
|
+
resource: ExtendSubscriptionRequest;
|
|
728
|
+
}): Request<ExtendSubscriptionResponse>;
|
|
727
729
|
extend(
|
|
728
730
|
request: {
|
|
729
731
|
/** V1 error format. */
|
|
@@ -751,8 +753,8 @@ declare namespace gapi.client {
|
|
|
751
753
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
752
754
|
uploadType?: string;
|
|
753
755
|
},
|
|
754
|
-
body:
|
|
755
|
-
): Request<
|
|
756
|
+
body: ExtendSubscriptionRequest,
|
|
757
|
+
): Request<ExtendSubscriptionResponse>;
|
|
756
758
|
/** Gets a subscription by id. It should be called directly by the partner using service accounts. */
|
|
757
759
|
get(request?: {
|
|
758
760
|
/** V1 error format. */
|
|
@@ -779,7 +781,7 @@ declare namespace gapi.client {
|
|
|
779
781
|
upload_protocol?: string;
|
|
780
782
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
781
783
|
uploadType?: string;
|
|
782
|
-
}): Request<
|
|
784
|
+
}): Request<Subscription>;
|
|
783
785
|
/** Used by partners to provision a subscription for their customers. This creates a subscription without associating it with the end user account. EntitleSubscription must be called separately using OAuth in order for the end user account to be associated with the subscription. It should be called directly by the partner using service accounts. */
|
|
784
786
|
provision(request: {
|
|
785
787
|
/** V1 error format. */
|
|
@@ -809,8 +811,8 @@ declare namespace gapi.client {
|
|
|
809
811
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
810
812
|
uploadType?: string;
|
|
811
813
|
/** Request body */
|
|
812
|
-
resource:
|
|
813
|
-
}): Request<
|
|
814
|
+
resource: Subscription;
|
|
815
|
+
}): Request<Subscription>;
|
|
814
816
|
provision(
|
|
815
817
|
request: {
|
|
816
818
|
/** V1 error format. */
|
|
@@ -840,8 +842,8 @@ declare namespace gapi.client {
|
|
|
840
842
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
841
843
|
uploadType?: string;
|
|
842
844
|
},
|
|
843
|
-
body:
|
|
844
|
-
): Request<
|
|
845
|
+
body: Subscription,
|
|
846
|
+
): Request<Subscription>;
|
|
845
847
|
/** Resumes a suspended subscription. The new billing cycle will start at the time of the request. It should be called directly by the partner using service accounts. */
|
|
846
848
|
resume(request: {
|
|
847
849
|
/** V1 error format. */
|
|
@@ -869,8 +871,8 @@ declare namespace gapi.client {
|
|
|
869
871
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
870
872
|
uploadType?: string;
|
|
871
873
|
/** Request body */
|
|
872
|
-
resource:
|
|
873
|
-
}): Request<
|
|
874
|
+
resource: ResumeSubscriptionRequest;
|
|
875
|
+
}): Request<ResumeSubscriptionResponse>;
|
|
874
876
|
resume(
|
|
875
877
|
request: {
|
|
876
878
|
/** V1 error format. */
|
|
@@ -898,8 +900,8 @@ declare namespace gapi.client {
|
|
|
898
900
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
899
901
|
uploadType?: string;
|
|
900
902
|
},
|
|
901
|
-
body:
|
|
902
|
-
): Request<
|
|
903
|
+
body: ResumeSubscriptionRequest,
|
|
904
|
+
): Request<ResumeSubscriptionResponse>;
|
|
903
905
|
/** Suspends a subscription. Contract terms may dictate if a prorated refund will be issued upon suspension. It should be called directly by the partner using service accounts. */
|
|
904
906
|
suspend(request: {
|
|
905
907
|
/** V1 error format. */
|
|
@@ -927,8 +929,8 @@ declare namespace gapi.client {
|
|
|
927
929
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
928
930
|
uploadType?: string;
|
|
929
931
|
/** Request body */
|
|
930
|
-
resource:
|
|
931
|
-
}): Request<
|
|
932
|
+
resource: SuspendSubscriptionRequest;
|
|
933
|
+
}): Request<SuspendSubscriptionResponse>;
|
|
932
934
|
suspend(
|
|
933
935
|
request: {
|
|
934
936
|
/** V1 error format. */
|
|
@@ -956,8 +958,8 @@ declare namespace gapi.client {
|
|
|
956
958
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
957
959
|
uploadType?: string;
|
|
958
960
|
},
|
|
959
|
-
body:
|
|
960
|
-
): Request<
|
|
961
|
+
body: SuspendSubscriptionRequest,
|
|
962
|
+
): Request<SuspendSubscriptionResponse>;
|
|
961
963
|
/** Currently, it is used by **Google One, Play Pass** partners. Revokes the pending cancellation of a subscription, which is currently in `STATE_CANCEL_AT_END_OF_CYCLE` state. If the subscription is already cancelled, the request will fail. It should be called directly by the partner using service accounts. */
|
|
962
964
|
undoCancel(request: {
|
|
963
965
|
/** V1 error format. */
|
|
@@ -985,8 +987,8 @@ declare namespace gapi.client {
|
|
|
985
987
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
986
988
|
uploadType?: string;
|
|
987
989
|
/** Request body */
|
|
988
|
-
resource:
|
|
989
|
-
}): Request<
|
|
990
|
+
resource: UndoCancelSubscriptionRequest;
|
|
991
|
+
}): Request<UndoCancelSubscriptionResponse>;
|
|
990
992
|
undoCancel(
|
|
991
993
|
request: {
|
|
992
994
|
/** V1 error format. */
|
|
@@ -1014,8 +1016,8 @@ declare namespace gapi.client {
|
|
|
1014
1016
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1015
1017
|
uploadType?: string;
|
|
1016
1018
|
},
|
|
1017
|
-
body:
|
|
1018
|
-
): Request<
|
|
1019
|
+
body: UndoCancelSubscriptionRequest,
|
|
1020
|
+
): Request<UndoCancelSubscriptionResponse>;
|
|
1019
1021
|
}
|
|
1020
1022
|
interface UserSessionsResource {
|
|
1021
1023
|
/** This API replaces user authorized OAuth consent based APIs (Create, Entitle). Issues a timed session token for the given user intent. You can use the session token to redirect the user to Google to finish the signup flow. You can re-generate new session token repeatedly for the same request if necessary, regardless of the previous tokens being expired or not. By default, the session token is valid for 1 hour. */
|
|
@@ -1045,8 +1047,8 @@ declare namespace gapi.client {
|
|
|
1045
1047
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1046
1048
|
uploadType?: string;
|
|
1047
1049
|
/** Request body */
|
|
1048
|
-
resource:
|
|
1049
|
-
}): Request<
|
|
1050
|
+
resource: GenerateUserSessionRequest;
|
|
1051
|
+
}): Request<GenerateUserSessionResponse>;
|
|
1050
1052
|
generate(
|
|
1051
1053
|
request: {
|
|
1052
1054
|
/** V1 error format. */
|
|
@@ -1074,8 +1076,8 @@ declare namespace gapi.client {
|
|
|
1074
1076
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1075
1077
|
uploadType?: string;
|
|
1076
1078
|
},
|
|
1077
|
-
body:
|
|
1078
|
-
): Request<
|
|
1079
|
+
body: GenerateUserSessionRequest,
|
|
1080
|
+
): Request<GenerateUserSessionResponse>;
|
|
1079
1081
|
}
|
|
1080
1082
|
interface PartnersResource {
|
|
1081
1083
|
products: ProductsResource;
|
package/package.json
CHANGED