1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module AppsmarketV2
# G Suite Marketplace API
#
# Lets your G Suite Marketplace applications integrate with Google's licensing
# and billing services.
#
# @example
# require 'google/apis/appsmarket_v2'
#
# Appsmarket = Google::Apis::AppsmarketV2 # Alias the module
# service = Appsmarket::GSuiteMarketplaceAPIService.new
#
# @see https://developers.google.com/apps-marketplace
class GSuiteMarketplaceAPIService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://appsmarket.googleapis.com/', '')
@batch_path = 'batch'
end
# Get the status of a license for a customer to determine if they have access
# for a given app.
# @param [String] application_id
# Application Id
# @param [String] customer_id
# Customer Id
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AppsmarketV2::CustomerLicense] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AppsmarketV2::CustomerLicense]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_customer_license(application_id, customer_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'appsmarket/v2/customerLicense/{applicationId}/{customerId}', options)
command.response_representation = Google::Apis::AppsmarketV2::CustomerLicense::Representation
command.response_class = Google::Apis::AppsmarketV2::CustomerLicense
command.params['applicationId'] = application_id unless application_id.nil?
command.params['customerId'] = customer_id unless customer_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get a list of licensing notifications with regards to a given app.
# @param [String] application_id
# Application Id
# @param [Fixnum] max_results
# @param [String] start_token
# @param [Fixnum] timestamp
# Timestamp in milliseconds since epoch
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AppsmarketV2::LicenseNotificationList] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AppsmarketV2::LicenseNotificationList]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_license_notifications(application_id, max_results: nil, start_token: nil, timestamp: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'appsmarket/v2/licenseNotification/{applicationId}', options)
command.response_representation = Google::Apis::AppsmarketV2::LicenseNotificationList::Representation
command.response_class = Google::Apis::AppsmarketV2::LicenseNotificationList
command.params['applicationId'] = application_id unless application_id.nil?
command.query['max-results'] = max_results unless max_results.nil?
command.query['start-token'] = start_token unless start_token.nil?
command.query['timestamp'] = timestamp unless timestamp.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get the user's licensing status for their permission to use a given app.
# @param [String] application_id
# Application Id
# @param [String] user_id
# User Id
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AppsmarketV2::UserLicense] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AppsmarketV2::UserLicense]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_user_license(application_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'appsmarket/v2/userLicense/{applicationId}/{userId}', options)
command.response_representation = Google::Apis::AppsmarketV2::UserLicense::Representation
command.response_class = Google::Apis::AppsmarketV2::UserLicense
command.params['applicationId'] = application_id unless application_id.nil?
command.params['userId'] = user_id unless user_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
|
