google-apis-paymentsresellersubscription_v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: a9656818f209d22eda5a54ee19a6a3c4b48c2ac641a5e5f51d67f855d680fc27
4
+ data.tar.gz: f544545ef643b5053d27f958311c6d12d29cc91683ff0221f0d3711d4f0768ac
5
+ SHA512:
6
+ metadata.gz: 32bf223ca99b9c807c3e7597be7fdbc7620d8cd159ff905e7d767ab207da4111a84379f5d1423d7fd749f638f9c5051234ea8398be9ef669dbca7570fcfbde16
7
+ data.tar.gz: cadaf5c331f9618edbbe4ef2af5c77244b66e8c7ded3589eae639de900caf71a0a60fffe4dfe1cf36c07940afd81c254bdf41241dcf33887c06aa4b94194a4c7
data/.yardopts ADDED
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-paymentsresellersubscription_v1
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/paymentsresellersubscription_v1/*.rb
9
+ lib/google/apis/paymentsresellersubscription_v1.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
data/CHANGELOG.md ADDED
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-paymentsresellersubscription_v1
2
+
3
+ ### v0.1.0 (2021-05-08)
4
+
5
+ * Regenerated from discovery document revision 20210507
6
+ * Regenerated using generator version 0.2.0
7
+
data/LICENSE.md ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/OVERVIEW.md ADDED
@@ -0,0 +1,96 @@
1
+ # Simple REST client for version V1 of the Payments Reseller Subscription API
2
+
3
+ This is a simple client library for version V1 of the Payments Reseller Subscription API. It provides:
4
+
5
+ * A client object that connects to the HTTP/JSON REST endpoint for the service.
6
+ * Ruby objects for data structures related to the service.
7
+ * Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
8
+ * Control of retry, pagination, and timeouts.
9
+
10
+ Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
11
+
12
+ ## Getting started
13
+
14
+ ### Before you begin
15
+
16
+ There are a few setup steps you need to complete before you can use this library:
17
+
18
+ 1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
19
+ 2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
20
+ 3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/paymentsresellersubscription.googleapis.com) in the console.
21
+
22
+ ### Installation
23
+
24
+ Add this line to your application's Gemfile:
25
+
26
+ ```ruby
27
+ gem 'google-apis-paymentsresellersubscription_v1', '~> 0.1'
28
+ ```
29
+
30
+ And then execute:
31
+
32
+ ```
33
+ $ bundle
34
+ ```
35
+
36
+ Or install it yourself as:
37
+
38
+ ```
39
+ $ gem install google-apis-paymentsresellersubscription_v1
40
+ ```
41
+
42
+ ### Creating a client object
43
+
44
+ Once the gem is installed, you can load the client code and instantiate a client.
45
+
46
+ ```ruby
47
+ # Load the client
48
+ require "google/apis/paymentsresellersubscription_v1"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::PaymentsresellersubscriptionV1::PaymentsResellerSubscriptionService.new
52
+
53
+ # Authenticate calls
54
+ client.authentication = # ... use the googleauth gem to create credentials
55
+ ```
56
+
57
+ See the class reference docs for information on the methods you can call from a client.
58
+
59
+ ## Documentation
60
+
61
+ More detailed descriptions of the Google simple REST clients are available in two documents.
62
+
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
+
66
+ (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Paymentsresellersubscription service in particular.)
67
+
68
+ For reference information on specific calls in the Payments Reseller Subscription API, see the {Google::Apis::PaymentsresellersubscriptionV1::PaymentsResellerSubscriptionService class reference docs}.
69
+
70
+ ## Which client should I use?
71
+
72
+ Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
73
+
74
+ This library, `google-apis-paymentsresellersubscription_v1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
75
+
76
+ Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
77
+
78
+ Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
79
+
80
+ **For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
81
+
82
+ The [product documentation](https://developers.google.com/payments/reseller/subscription/) may provide guidance regarding the preferred client library to use.
83
+
84
+ ## Supported Ruby versions
85
+
86
+ This library is supported on Ruby 2.5+.
87
+
88
+ Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
89
+
90
+ ## License
91
+
92
+ This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
93
+
94
+ ## Support
95
+
96
+ Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).
@@ -0,0 +1,15 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require "google/apis/paymentsresellersubscription_v1"
@@ -0,0 +1,33 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/paymentsresellersubscription_v1/service.rb'
16
+ require 'google/apis/paymentsresellersubscription_v1/classes.rb'
17
+ require 'google/apis/paymentsresellersubscription_v1/representations.rb'
18
+ require 'google/apis/paymentsresellersubscription_v1/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Payments Reseller Subscription API
23
+ #
24
+ #
25
+ #
26
+ # @see https://developers.google.com/payments/reseller/subscription/
27
+ module PaymentsresellersubscriptionV1
28
+ # Version of the Payments Reseller Subscription API this client connects to.
29
+ # This is NOT the gem version.
30
+ VERSION = 'V1'
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,577 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module PaymentsresellersubscriptionV1
24
+
25
+ #
26
+ class GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # Optional. If true, the subscription will be cancelled immediately. Otherwise,
30
+ # the subscription will be cancelled at the end of the current cycle, and
31
+ # therefore no prorated refund will be issued for the rest of the cycle.
32
+ # Corresponds to the JSON property `cancelImmediately`
33
+ # @return [Boolean]
34
+ attr_accessor :cancel_immediately
35
+ alias_method :cancel_immediately?, :cancel_immediately
36
+
37
+ # Specifies the reason for the cancellation.
38
+ # Corresponds to the JSON property `cancellationReason`
39
+ # @return [String]
40
+ attr_accessor :cancellation_reason
41
+
42
+ def initialize(**args)
43
+ update!(**args)
44
+ end
45
+
46
+ # Update properties of this object
47
+ def update!(**args)
48
+ @cancel_immediately = args[:cancel_immediately] if args.key?(:cancel_immediately)
49
+ @cancellation_reason = args[:cancellation_reason] if args.key?(:cancellation_reason)
50
+ end
51
+ end
52
+
53
+ #
54
+ class GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionResponse
55
+ include Google::Apis::Core::Hashable
56
+
57
+ # A Subscription resource managed by 3P Partners.
58
+ # Corresponds to the JSON property `subscription`
59
+ # @return [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Subscription]
60
+ attr_accessor :subscription
61
+
62
+ def initialize(**args)
63
+ update!(**args)
64
+ end
65
+
66
+ # Update properties of this object
67
+ def update!(**args)
68
+ @subscription = args[:subscription] if args.key?(:subscription)
69
+ end
70
+ end
71
+
72
+ # Describes the length of a period of a time.
73
+ class GoogleCloudPaymentsResellerSubscriptionV1Duration
74
+ include Google::Apis::Core::Hashable
75
+
76
+ # number of duration units to be included.
77
+ # Corresponds to the JSON property `count`
78
+ # @return [Fixnum]
79
+ attr_accessor :count
80
+
81
+ # The unit used for the duration
82
+ # Corresponds to the JSON property `unit`
83
+ # @return [String]
84
+ attr_accessor :unit
85
+
86
+ def initialize(**args)
87
+ update!(**args)
88
+ end
89
+
90
+ # Update properties of this object
91
+ def update!(**args)
92
+ @count = args[:count] if args.key?(:count)
93
+ @unit = args[:unit] if args.key?(:unit)
94
+ end
95
+ end
96
+
97
+ # Partner request for entitling the previously provisioned subscription to an
98
+ # end user. The end user identity is inferred from the request OAuth context.
99
+ class GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest
100
+ include Google::Apis::Core::Hashable
101
+
102
+ def initialize(**args)
103
+ update!(**args)
104
+ end
105
+
106
+ # Update properties of this object
107
+ def update!(**args)
108
+ end
109
+ end
110
+
111
+ #
112
+ class GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionResponse
113
+ include Google::Apis::Core::Hashable
114
+
115
+ # A Subscription resource managed by 3P Partners.
116
+ # Corresponds to the JSON property `subscription`
117
+ # @return [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Subscription]
118
+ attr_accessor :subscription
119
+
120
+ def initialize(**args)
121
+ update!(**args)
122
+ end
123
+
124
+ # Update properties of this object
125
+ def update!(**args)
126
+ @subscription = args[:subscription] if args.key?(:subscription)
127
+ end
128
+ end
129
+
130
+ # Request message for extending a Subscription resource. A new recurrence will
131
+ # be made based on the subscription schedule defined by the original product.
132
+ class GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionRequest
133
+ include Google::Apis::Core::Hashable
134
+
135
+ # Describes the details of an extension request.
136
+ # Corresponds to the JSON property `extension`
137
+ # @return [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Extension]
138
+ attr_accessor :extension
139
+
140
+ # Required. Restricted to 36 ASCII characters. A random UUID is recommended. The
141
+ # idempotency key for the request. The ID generation logic is controlled by the
142
+ # partner. request_id should be the same as on retries of the same request. A
143
+ # different request_id must be used for a extension of a different cycle. A
144
+ # random UUID is recommended.
145
+ # Corresponds to the JSON property `requestId`
146
+ # @return [String]
147
+ attr_accessor :request_id
148
+
149
+ def initialize(**args)
150
+ update!(**args)
151
+ end
152
+
153
+ # Update properties of this object
154
+ def update!(**args)
155
+ @extension = args[:extension] if args.key?(:extension)
156
+ @request_id = args[:request_id] if args.key?(:request_id)
157
+ end
158
+ end
159
+
160
+ #
161
+ class GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionResponse
162
+ include Google::Apis::Core::Hashable
163
+
164
+ # The time at which the subscription is expected to be extended, in ISO 8061
165
+ # format. UTC timezone. Example, "cycleEndTime":"2019-08-31T17:28:54.564Z"
166
+ # Corresponds to the JSON property `cycleEndTime`
167
+ # @return [String]
168
+ attr_accessor :cycle_end_time
169
+
170
+ # End of the free trial period, in ISO 8061 format. UTC timezone. Example, "
171
+ # freeTrialEndTime":"2019-08-31T17:28:54.564Z" This time will be set the same as
172
+ # initial subscription creation time if no free trial period is offered to the
173
+ # partner.
174
+ # Corresponds to the JSON property `freeTrialEndTime`
175
+ # @return [String]
176
+ attr_accessor :free_trial_end_time
177
+
178
+ def initialize(**args)
179
+ update!(**args)
180
+ end
181
+
182
+ # Update properties of this object
183
+ def update!(**args)
184
+ @cycle_end_time = args[:cycle_end_time] if args.key?(:cycle_end_time)
185
+ @free_trial_end_time = args[:free_trial_end_time] if args.key?(:free_trial_end_time)
186
+ end
187
+ end
188
+
189
+ # Describes the details of an extension request.
190
+ class GoogleCloudPaymentsResellerSubscriptionV1Extension
191
+ include Google::Apis::Core::Hashable
192
+
193
+ # Describes the length of a period of a time.
194
+ # Corresponds to the JSON property `duration`
195
+ # @return [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Duration]
196
+ attr_accessor :duration
197
+
198
+ # Required. Identifier of the end-user in partner’s system.
199
+ # Corresponds to the JSON property `partnerUserToken`
200
+ # @return [String]
201
+ attr_accessor :partner_user_token
202
+
203
+ def initialize(**args)
204
+ update!(**args)
205
+ end
206
+
207
+ # Update properties of this object
208
+ def update!(**args)
209
+ @duration = args[:duration] if args.key?(:duration)
210
+ @partner_user_token = args[:partner_user_token] if args.key?(:partner_user_token)
211
+ end
212
+ end
213
+
214
+ #
215
+ class GoogleCloudPaymentsResellerSubscriptionV1ListProductsResponse
216
+ include Google::Apis::Core::Hashable
217
+
218
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
219
+ # field is empty, there are no subsequent pages.
220
+ # Corresponds to the JSON property `nextPageToken`
221
+ # @return [String]
222
+ attr_accessor :next_page_token
223
+
224
+ # The products for the specified partner.
225
+ # Corresponds to the JSON property `products`
226
+ # @return [Array<Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Product>]
227
+ attr_accessor :products
228
+
229
+ def initialize(**args)
230
+ update!(**args)
231
+ end
232
+
233
+ # Update properties of this object
234
+ def update!(**args)
235
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
236
+ @products = args[:products] if args.key?(:products)
237
+ end
238
+ end
239
+
240
+ #
241
+ class GoogleCloudPaymentsResellerSubscriptionV1ListPromotionsResponse
242
+ include Google::Apis::Core::Hashable
243
+
244
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
245
+ # field is empty, there are no subsequent pages.
246
+ # Corresponds to the JSON property `nextPageToken`
247
+ # @return [String]
248
+ attr_accessor :next_page_token
249
+
250
+ # The promotions for the specified partner.
251
+ # Corresponds to the JSON property `promotions`
252
+ # @return [Array<Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Promotion>]
253
+ attr_accessor :promotions
254
+
255
+ def initialize(**args)
256
+ update!(**args)
257
+ end
258
+
259
+ # Update properties of this object
260
+ def update!(**args)
261
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
262
+ @promotions = args[:promotions] if args.key?(:promotions)
263
+ end
264
+ end
265
+
266
+ # Describes a location of an end user.
267
+ class GoogleCloudPaymentsResellerSubscriptionV1Location
268
+ include Google::Apis::Core::Hashable
269
+
270
+ # The postal code this location refers to. Ex. "94043"
271
+ # Corresponds to the JSON property `postalCode`
272
+ # @return [String]
273
+ attr_accessor :postal_code
274
+
275
+ # 2-letter ISO region code for current content region. Ex. “US” Please refers to:
276
+ # https://en.wikipedia.org/wiki/ISO_3166-1
277
+ # Corresponds to the JSON property `regionCode`
278
+ # @return [String]
279
+ attr_accessor :region_code
280
+
281
+ def initialize(**args)
282
+ update!(**args)
283
+ end
284
+
285
+ # Update properties of this object
286
+ def update!(**args)
287
+ @postal_code = args[:postal_code] if args.key?(:postal_code)
288
+ @region_code = args[:region_code] if args.key?(:region_code)
289
+ end
290
+ end
291
+
292
+ # A Product resource that defines a subscription service that can be resold.
293
+ class GoogleCloudPaymentsResellerSubscriptionV1Product
294
+ include Google::Apis::Core::Hashable
295
+
296
+ # Output only. Response only. Resource name of the subscription. It will have
297
+ # the format of "partners/`partner_id`/products/`product_id`"
298
+ # Corresponds to the JSON property `name`
299
+ # @return [String]
300
+ attr_accessor :name
301
+
302
+ # Output only. 2-letter ISO region code where the product is available in. Ex. "
303
+ # US" Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1
304
+ # Corresponds to the JSON property `regionCodes`
305
+ # @return [Array<String>]
306
+ attr_accessor :region_codes
307
+
308
+ # Describes the length of a period of a time.
309
+ # Corresponds to the JSON property `subscriptionBillingCycleDuration`
310
+ # @return [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Duration]
311
+ attr_accessor :subscription_billing_cycle_duration
312
+
313
+ # Output only. Localized human readable name of the product.
314
+ # Corresponds to the JSON property `titles`
315
+ # @return [Array<Google::Apis::PaymentsresellersubscriptionV1::GoogleTypeLocalizedText>]
316
+ attr_accessor :titles
317
+
318
+ def initialize(**args)
319
+ update!(**args)
320
+ end
321
+
322
+ # Update properties of this object
323
+ def update!(**args)
324
+ @name = args[:name] if args.key?(:name)
325
+ @region_codes = args[:region_codes] if args.key?(:region_codes)
326
+ @subscription_billing_cycle_duration = args[:subscription_billing_cycle_duration] if args.key?(:subscription_billing_cycle_duration)
327
+ @titles = args[:titles] if args.key?(:titles)
328
+ end
329
+ end
330
+
331
+ # A Promotion resource that defines a promotion for a subscription that can be
332
+ # resold.
333
+ class GoogleCloudPaymentsResellerSubscriptionV1Promotion
334
+ include Google::Apis::Core::Hashable
335
+
336
+ # Output only. The product ids this promotion can be applied to.
337
+ # Corresponds to the JSON property `applicableProducts`
338
+ # @return [Array<String>]
339
+ attr_accessor :applicable_products
340
+
341
+ # Optional. Specifies the end time (exclusive) of the period that the promotion
342
+ # is available in. If unset, the promotion is available indefinitely.
343
+ # Corresponds to the JSON property `endTime`
344
+ # @return [String]
345
+ attr_accessor :end_time
346
+
347
+ # Describes the length of a period of a time.
348
+ # Corresponds to the JSON property `freeTrialDuration`
349
+ # @return [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Duration]
350
+ attr_accessor :free_trial_duration
351
+
352
+ # Output only. Response only. Resource name of the subscription promotion. It
353
+ # will have the format of "partners/`partner_id`/promotion/`promotion_id`"
354
+ # Corresponds to the JSON property `name`
355
+ # @return [String]
356
+ attr_accessor :name
357
+
358
+ # Output only. 2-letter ISO region code where the promotion is available in. Ex.
359
+ # "US" Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1
360
+ # Corresponds to the JSON property `regionCodes`
361
+ # @return [Array<String>]
362
+ attr_accessor :region_codes
363
+
364
+ # Optional. Specifies the start time (inclusive) of the period that the
365
+ # promotion is available in.
366
+ # Corresponds to the JSON property `startTime`
367
+ # @return [String]
368
+ attr_accessor :start_time
369
+
370
+ # Output only. Localized human readable name of the promotion.
371
+ # Corresponds to the JSON property `titles`
372
+ # @return [Array<Google::Apis::PaymentsresellersubscriptionV1::GoogleTypeLocalizedText>]
373
+ attr_accessor :titles
374
+
375
+ def initialize(**args)
376
+ update!(**args)
377
+ end
378
+
379
+ # Update properties of this object
380
+ def update!(**args)
381
+ @applicable_products = args[:applicable_products] if args.key?(:applicable_products)
382
+ @end_time = args[:end_time] if args.key?(:end_time)
383
+ @free_trial_duration = args[:free_trial_duration] if args.key?(:free_trial_duration)
384
+ @name = args[:name] if args.key?(:name)
385
+ @region_codes = args[:region_codes] if args.key?(:region_codes)
386
+ @start_time = args[:start_time] if args.key?(:start_time)
387
+ @titles = args[:titles] if args.key?(:titles)
388
+ end
389
+ end
390
+
391
+ # A Subscription resource managed by 3P Partners.
392
+ class GoogleCloudPaymentsResellerSubscriptionV1Subscription
393
+ include Google::Apis::Core::Hashable
394
+
395
+ # Describes the details of a cancelled subscription.
396
+ # Corresponds to the JSON property `cancellationDetails`
397
+ # @return [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1SubscriptionCancellationDetails]
398
+ attr_accessor :cancellation_details
399
+
400
+ # Output only. System generated timestamp when the subscription is created. UTC
401
+ # timezone.
402
+ # Corresponds to the JSON property `createTime`
403
+ # @return [String]
404
+ attr_accessor :create_time
405
+
406
+ # Output only. The time at which the subscription is expected to be extended, in
407
+ # ISO 8061 format. UTC timezone. For example: "2019-08-31T17:28:54.564Z"
408
+ # Corresponds to the JSON property `cycleEndTime`
409
+ # @return [String]
410
+ attr_accessor :cycle_end_time
411
+
412
+ # Output only. Indicates if the subscription is entitled to the end user.
413
+ # Corresponds to the JSON property `endUserEntitled`
414
+ # @return [Boolean]
415
+ attr_accessor :end_user_entitled
416
+ alias_method :end_user_entitled?, :end_user_entitled
417
+
418
+ # Output only. End of the free trial period, in ISO 8061 format. For example, "
419
+ # 2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free
420
+ # trial promotion is specified.
421
+ # Corresponds to the JSON property `freeTrialEndTime`
422
+ # @return [String]
423
+ attr_accessor :free_trial_end_time
424
+
425
+ # Output only. Response only. Resource name of the subscription. It will have
426
+ # the format of "partners/`partner_id`/subscriptions/`subscription_id`"
427
+ # Corresponds to the JSON property `name`
428
+ # @return [String]
429
+ attr_accessor :name
430
+
431
+ # Required. Identifier of the end-user in partner’s system. The value is
432
+ # restricted to 63 ASCII characters at the maximum.
433
+ # Corresponds to the JSON property `partnerUserToken`
434
+ # @return [String]
435
+ attr_accessor :partner_user_token
436
+
437
+ # Required. Resource name that identifies one or more subscription products. The
438
+ # format will be 'partners/`partner_id`/products/`product_id`'.
439
+ # Corresponds to the JSON property `products`
440
+ # @return [Array<String>]
441
+ attr_accessor :products
442
+
443
+ # Optional. Resource name that identifies one or more promotions that can be
444
+ # applied on the product. A typical promotion for a subscription is Free trial.
445
+ # The format will be 'partners/`partner_id`/promotions/`promotion_id`'.
446
+ # Corresponds to the JSON property `promotions`
447
+ # @return [Array<String>]
448
+ attr_accessor :promotions
449
+
450
+ # Output only. The place where partners should redirect the end-user to after
451
+ # creation. This field might also be populated when creation failed. However,
452
+ # Partners should always prepare a default URL to redirect the user in case this
453
+ # field is empty.
454
+ # Corresponds to the JSON property `redirectUri`
455
+ # @return [String]
456
+ attr_accessor :redirect_uri
457
+
458
+ # Describes a location of an end user.
459
+ # Corresponds to the JSON property `serviceLocation`
460
+ # @return [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Location]
461
+ attr_accessor :service_location
462
+
463
+ # Output only. Descibes the state of the subscription. See more details at [the
464
+ # lifecycle of a subscription](/payments/reseller/subscription/reference/index/
465
+ # Receive.Notifications#payments-subscription-lifecycle).
466
+ # Corresponds to the JSON property `state`
467
+ # @return [String]
468
+ attr_accessor :state
469
+
470
+ # Output only. System generated timestamp when the subscription is most recently
471
+ # updated. UTC timezone.
472
+ # Corresponds to the JSON property `updateTime`
473
+ # @return [String]
474
+ attr_accessor :update_time
475
+
476
+ def initialize(**args)
477
+ update!(**args)
478
+ end
479
+
480
+ # Update properties of this object
481
+ def update!(**args)
482
+ @cancellation_details = args[:cancellation_details] if args.key?(:cancellation_details)
483
+ @create_time = args[:create_time] if args.key?(:create_time)
484
+ @cycle_end_time = args[:cycle_end_time] if args.key?(:cycle_end_time)
485
+ @end_user_entitled = args[:end_user_entitled] if args.key?(:end_user_entitled)
486
+ @free_trial_end_time = args[:free_trial_end_time] if args.key?(:free_trial_end_time)
487
+ @name = args[:name] if args.key?(:name)
488
+ @partner_user_token = args[:partner_user_token] if args.key?(:partner_user_token)
489
+ @products = args[:products] if args.key?(:products)
490
+ @promotions = args[:promotions] if args.key?(:promotions)
491
+ @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
492
+ @service_location = args[:service_location] if args.key?(:service_location)
493
+ @state = args[:state] if args.key?(:state)
494
+ @update_time = args[:update_time] if args.key?(:update_time)
495
+ end
496
+ end
497
+
498
+ # Describes the details of a cancelled subscription.
499
+ class GoogleCloudPaymentsResellerSubscriptionV1SubscriptionCancellationDetails
500
+ include Google::Apis::Core::Hashable
501
+
502
+ # The reason of the cancellation.
503
+ # Corresponds to the JSON property `reason`
504
+ # @return [String]
505
+ attr_accessor :reason
506
+
507
+ def initialize(**args)
508
+ update!(**args)
509
+ end
510
+
511
+ # Update properties of this object
512
+ def update!(**args)
513
+ @reason = args[:reason] if args.key?(:reason)
514
+ end
515
+ end
516
+
517
+ # Request to revoke a cancellation request.
518
+ class GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest
519
+ include Google::Apis::Core::Hashable
520
+
521
+ def initialize(**args)
522
+ update!(**args)
523
+ end
524
+
525
+ # Update properties of this object
526
+ def update!(**args)
527
+ end
528
+ end
529
+
530
+ # Response that contains the updated subscription resource.
531
+ class GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionResponse
532
+ include Google::Apis::Core::Hashable
533
+
534
+ # A Subscription resource managed by 3P Partners.
535
+ # Corresponds to the JSON property `subscription`
536
+ # @return [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Subscription]
537
+ attr_accessor :subscription
538
+
539
+ def initialize(**args)
540
+ update!(**args)
541
+ end
542
+
543
+ # Update properties of this object
544
+ def update!(**args)
545
+ @subscription = args[:subscription] if args.key?(:subscription)
546
+ end
547
+ end
548
+
549
+ # Localized variant of a text in a particular language.
550
+ class GoogleTypeLocalizedText
551
+ include Google::Apis::Core::Hashable
552
+
553
+ # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more
554
+ # information, see http://www.unicode.org/reports/tr35/#
555
+ # Unicode_locale_identifier.
556
+ # Corresponds to the JSON property `languageCode`
557
+ # @return [String]
558
+ attr_accessor :language_code
559
+
560
+ # Localized string in the language corresponding to `language_code' below.
561
+ # Corresponds to the JSON property `text`
562
+ # @return [String]
563
+ attr_accessor :text
564
+
565
+ def initialize(**args)
566
+ update!(**args)
567
+ end
568
+
569
+ # Update properties of this object
570
+ def update!(**args)
571
+ @language_code = args[:language_code] if args.key?(:language_code)
572
+ @text = args[:text] if args.key?(:text)
573
+ end
574
+ end
575
+ end
576
+ end
577
+ end