Skip to content

Commit 905f652

Browse files
feat(paymentsresellersubscription): update the API
#### paymentsresellersubscription:v1 The following keys were added: - schemas.GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload.description - schemas.GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload.id - schemas.GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload.properties.attachedToGoogleStructure.description - schemas.GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload.properties.attachedToGoogleStructure.readOnly - schemas.GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload.properties.attachedToGoogleStructure.type - schemas.GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload.properties.partnerStructureId.description - schemas.GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload.properties.partnerStructureId.type - schemas.GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload.type - schemas.GoogleCloudPaymentsResellerSubscriptionV1ProductPayload.properties.googleHomePayload.$ref - schemas.GoogleCloudPaymentsResellerSubscriptionV1ProductPayload.properties.googleHomePayload.description The following keys were changed: - resources.partners.resources.products.methods.list.description - resources.partners.resources.promotions.methods.findEligible.description - resources.partners.resources.promotions.methods.list.description - resources.partners.resources.subscriptions.methods.cancel.description - resources.partners.resources.subscriptions.methods.entitle.description - resources.partners.resources.subscriptions.methods.extend.description - resources.partners.resources.subscriptions.methods.get.description - resources.partners.resources.subscriptions.methods.undoCancel.description - resources.partners.resources.userSessions.methods.generate.description - schemas.GoogleCloudPaymentsResellerSubscriptionV1Product.properties.bundleDetails.description - schemas.GoogleCloudPaymentsResellerSubscriptionV1Product.properties.productType.description - schemas.GoogleCloudPaymentsResellerSubscriptionV1Promotion.properties.promotionType.description - schemas.GoogleCloudPaymentsResellerSubscriptionV1PromotionIntroductoryPricingDetailsIntroductoryPricingSpec.properties.recurrenceCount.description
1 parent ea383cf commit 905f652

File tree

2 files changed

+64
-27
lines changed

2 files changed

+64
-27
lines changed

discovery/paymentsresellersubscription-v1.json

Lines changed: 34 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@
110110
"products": {
111111
"methods": {
112112
"list": {
113-
"description": "To retrieve the products that can be resold by the partner. It should be autenticated with a service account. - This API doesn't apply to YouTube products currently.",
113+
"description": "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.",
114114
"flatPath": "v1/partners/{partnersId}/products",
115115
"httpMethod": "GET",
116116
"id": "paymentsresellersubscription.partners.products.list",
@@ -155,7 +155,7 @@
155155
"promotions": {
156156
"methods": {
157157
"findEligible": {
158-
"description": "To find 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.",
158+
"description": "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.",
159159
"flatPath": "v1/partners/{partnersId}/promotions:findEligible",
160160
"httpMethod": "POST",
161161
"id": "paymentsresellersubscription.partners.promotions.findEligible",
@@ -183,7 +183,7 @@
183183
]
184184
},
185185
"list": {
186-
"description": "Retrieves the promotions, such as free trial, that can be used by the partner. - This API doesn't apply to YouTube promotions currently. It should be autenticated with a service account.",
186+
"description": "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.",
187187
"flatPath": "v1/partners/{partnersId}/promotions",
188188
"httpMethod": "GET",
189189
"id": "paymentsresellersubscription.partners.promotions.list",
@@ -228,7 +228,7 @@
228228
"subscriptions": {
229229
"methods": {
230230
"cancel": {
231-
"description": "Used by partners to cancel 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.",
231+
"description": "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.",
232232
"flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}:cancel",
233233
"httpMethod": "POST",
234234
"id": "paymentsresellersubscription.partners.subscriptions.cancel",
@@ -289,7 +289,7 @@
289289
]
290290
},
291291
"entitle": {
292-
"description": "Used by partners to entitle 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.",
292+
"description": "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.",
293293
"flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}:entitle",
294294
"httpMethod": "POST",
295295
"id": "paymentsresellersubscription.partners.subscriptions.entitle",
@@ -317,7 +317,7 @@
317317
]
318318
},
319319
"extend": {
320-
"description": "[Opt-in only] Most partners should be on auto-extend by default. Used by partners to extend 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.",
320+
"description": "[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.",
321321
"flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}:extend",
322322
"httpMethod": "POST",
323323
"id": "paymentsresellersubscription.partners.subscriptions.extend",
@@ -345,7 +345,7 @@
345345
]
346346
},
347347
"get": {
348-
"description": "Used by partners to get a subscription by id. It should be called directly by the partner using service accounts.",
348+
"description": "Gets a subscription by id. It should be called directly by the partner using service accounts.",
349349
"flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}",
350350
"httpMethod": "GET",
351351
"id": "paymentsresellersubscription.partners.subscriptions.get",
@@ -403,7 +403,7 @@
403403
]
404404
},
405405
"undoCancel": {
406-
"description": "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. - **This API doesn't apply to YouTube subscriptions.** It should be called directly by the partner using service accounts.",
406+
"description": "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.",
407407
"flatPath": "v1/partners/{partnersId}/subscriptions/{subscriptionsId}:undoCancel",
408408
"httpMethod": "POST",
409409
"id": "paymentsresellersubscription.partners.subscriptions.undoCancel",
@@ -435,7 +435,7 @@
435435
"userSessions": {
436436
"methods": {
437437
"generate": {
438-
"description": "This API replaces user authorized OAuth consent based APIs (Create, Entitle). Generates a short-lived token for a user session based on the 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.",
438+
"description": "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.",
439439
"flatPath": "v1/partners/{partnersId}/userSessions:generate",
440440
"httpMethod": "POST",
441441
"id": "paymentsresellersubscription.partners.userSessions.generate",
@@ -467,7 +467,7 @@
467467
}
468468
}
469469
},
470-
"revision": "20241211",
470+
"revision": "20250312",
471471
"rootUrl": "https://paymentsresellersubscription.googleapis.com/",
472472
"schemas": {
473473
"GoogleCloudPaymentsResellerSubscriptionV1Amount": {
@@ -765,6 +765,22 @@
765765
},
766766
"type": "object"
767767
},
768+
"GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload": {
769+
"description": "Payload specific for Google Home products.",
770+
"id": "GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload",
771+
"properties": {
772+
"attachedToGoogleStructure": {
773+
"description": "Output only. This identifies whether the subscription is attached to a Google Home structure.",
774+
"readOnly": true,
775+
"type": "boolean"
776+
},
777+
"partnerStructureId": {
778+
"description": "Optional. This identifies the structure ID on partner side that the subscription should be applied to. Only required when the partner requires structure mapping.",
779+
"type": "string"
780+
}
781+
},
782+
"type": "object"
783+
},
768784
"GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload": {
769785
"description": "Payload specific to Google One products.",
770786
"id": "GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload",
@@ -891,7 +907,7 @@
891907
"properties": {
892908
"bundleDetails": {
893909
"$ref": "ProductBundleDetails",
894-
"description": "Output only. Output Only. Specifies the details for a bundle product.",
910+
"description": "Output only. Specifies the details for a bundle product.",
895911
"readOnly": true
896912
},
897913
"finiteBillingCycleDetails": {
@@ -911,7 +927,7 @@
911927
"type": "array"
912928
},
913929
"productType": {
914-
"description": "Output only. Output Only. Specifies the type of the product.",
930+
"description": "Output only. Specifies the type of the product.",
915931
"enum": [
916932
"PRODUCT_TYPE_UNSPECIFIED",
917933
"PRODUCT_TYPE_SUBSCRIPTION",
@@ -965,6 +981,10 @@
965981
"description": "Specifies product specific payload.",
966982
"id": "GoogleCloudPaymentsResellerSubscriptionV1ProductPayload",
967983
"properties": {
984+
"googleHomePayload": {
985+
"$ref": "GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload",
986+
"description": "Payload specific to Google Home products."
987+
},
968988
"googleOnePayload": {
969989
"$ref": "GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload",
970990
"description": "Product-specific payloads. Payload specific to Google One products."
@@ -1023,7 +1043,7 @@
10231043
"type": "string"
10241044
},
10251045
"promotionType": {
1026-
"description": "Output only. Output Only. Specifies the type of the promotion.",
1046+
"description": "Output only. Specifies the type of the promotion.",
10271047
"enum": [
10281048
"PROMOTION_TYPE_UNSPECIFIED",
10291049
"PROMOTION_TYPE_FREE_TRIAL",
@@ -1092,7 +1112,7 @@
10921112
"type": "string"
10931113
},
10941114
"recurrenceCount": {
1095-
"description": "Output only. Output Only. The duration of an introductory offer in billing cycles.",
1115+
"description": "Output only. The duration of an introductory offer in billing cycles.",
10961116
"format": "int32",
10971117
"readOnly": true,
10981118
"type": "integer"

src/apis/paymentsresellersubscription/v1.ts

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,19 @@ export namespace paymentsresellersubscription_v1 {
329329
*/
330330
userSession?: Schema$GoogleCloudPaymentsResellerSubscriptionV1UserSession;
331331
}
332+
/**
333+
* Payload specific for Google Home products.
334+
*/
335+
export interface Schema$GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload {
336+
/**
337+
* Output only. This identifies whether the subscription is attached to a Google Home structure.
338+
*/
339+
attachedToGoogleStructure?: boolean | null;
340+
/**
341+
* Optional. This identifies the structure ID on partner side that the subscription should be applied to. Only required when the partner requires structure mapping.
342+
*/
343+
partnerStructureId?: string | null;
344+
}
332345
/**
333346
* Payload specific to Google One products.
334347
*/
@@ -407,7 +420,7 @@ export namespace paymentsresellersubscription_v1 {
407420
*/
408421
export interface Schema$GoogleCloudPaymentsResellerSubscriptionV1Product {
409422
/**
410-
* Output only. Output Only. Specifies the details for a bundle product.
423+
* Output only. Specifies the details for a bundle product.
411424
*/
412425
bundleDetails?: Schema$ProductBundleDetails;
413426
/**
@@ -423,7 +436,7 @@ export namespace paymentsresellersubscription_v1 {
423436
*/
424437
priceConfigs?: Schema$GoogleCloudPaymentsResellerSubscriptionV1ProductPriceConfig[];
425438
/**
426-
* Output only. Output Only. Specifies the type of the product.
439+
* Output only. Specifies the type of the product.
427440
*/
428441
productType?: string | null;
429442
/**
@@ -452,6 +465,10 @@ export namespace paymentsresellersubscription_v1 {
452465
* Specifies product specific payload.
453466
*/
454467
export interface Schema$GoogleCloudPaymentsResellerSubscriptionV1ProductPayload {
468+
/**
469+
* Payload specific to Google Home products.
470+
*/
471+
googleHomePayload?: Schema$GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload;
455472
/**
456473
* Product-specific payloads. Payload specific to Google One products.
457474
*/
@@ -499,7 +516,7 @@ export namespace paymentsresellersubscription_v1 {
499516
*/
500517
name?: string | null;
501518
/**
502-
* Output only. Output Only. Specifies the type of the promotion.
519+
* Output only. Specifies the type of the promotion.
503520
*/
504521
promotionType?: string | null;
505522
/**
@@ -537,7 +554,7 @@ export namespace paymentsresellersubscription_v1 {
537554
*/
538555
discountRatioMicros?: string | null;
539556
/**
540-
* Output only. Output Only. The duration of an introductory offer in billing cycles.
557+
* Output only. The duration of an introductory offer in billing cycles.
541558
*/
542559
recurrenceCount?: number | null;
543560
/**
@@ -871,7 +888,7 @@ export namespace paymentsresellersubscription_v1 {
871888
}
872889

873890
/**
874-
* To retrieve the products that can be resold by the partner. It should be autenticated with a service account. - This API doesn't apply to YouTube products currently.
891+
* 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.
875892
*
876893
* @param params - Parameters for request
877894
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -997,7 +1014,7 @@ export namespace paymentsresellersubscription_v1 {
9971014
}
9981015

9991016
/**
1000-
* To find 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.
1017+
* 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.
10011018
*
10021019
* @param params - Parameters for request
10031020
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1096,7 +1113,7 @@ export namespace paymentsresellersubscription_v1 {
10961113
}
10971114

10981115
/**
1099-
* Retrieves the promotions, such as free trial, that can be used by the partner. - This API doesn't apply to YouTube promotions currently. It should be autenticated with a service account.
1116+
* 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.
11001117
*
11011118
* @param params - Parameters for request
11021119
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1234,7 +1251,7 @@ export namespace paymentsresellersubscription_v1 {
12341251
}
12351252

12361253
/**
1237-
* Used by partners to cancel 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.
1254+
* 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.
12381255
*
12391256
* @param params - Parameters for request
12401257
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1429,7 +1446,7 @@ export namespace paymentsresellersubscription_v1 {
14291446
}
14301447

14311448
/**
1432-
* Used by partners to entitle 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.
1449+
* 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.
14331450
*
14341451
* @param params - Parameters for request
14351452
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1528,7 +1545,7 @@ export namespace paymentsresellersubscription_v1 {
15281545
}
15291546

15301547
/**
1531-
* [Opt-in only] Most partners should be on auto-extend by default. Used by partners to extend 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.
1548+
* [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.
15321549
*
15331550
* @param params - Parameters for request
15341551
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1624,7 +1641,7 @@ export namespace paymentsresellersubscription_v1 {
16241641
}
16251642

16261643
/**
1627-
* Used by partners to get a subscription by id. It should be called directly by the partner using service accounts.
1644+
* Gets a subscription by id. It should be called directly by the partner using service accounts.
16281645
*
16291646
* @param params - Parameters for request
16301647
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1819,7 +1836,7 @@ export namespace paymentsresellersubscription_v1 {
18191836
}
18201837

18211838
/**
1822-
* 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. - **This API doesn't apply to YouTube subscriptions.** It should be called directly by the partner using service accounts.
1839+
* 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.
18231840
*
18241841
* @param params - Parameters for request
18251842
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2013,7 +2030,7 @@ export namespace paymentsresellersubscription_v1 {
20132030
}
20142031

20152032
/**
2016-
* This API replaces user authorized OAuth consent based APIs (Create, Entitle). Generates a short-lived token for a user session based on the 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.
2033+
* 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.
20172034
*
20182035
* @param params - Parameters for request
20192036
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.

0 commit comments

Comments
 (0)