google-apis-apigee_v1 0.70.0 → 0.71.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -1868,6 +1868,623 @@ module Google
1868
1868
  execute_or_queue_command(command, &block)
1869
1869
  end
1870
1870
 
1871
+ # Creates an AppGroup. Once created, user can register apps under the AppGroup
1872
+ # to obtain secret key and password. At creation time, the AppGroup's state is
1873
+ # set as `active`. The attribute `Attribute` with key `attribute_name` as `
1874
+ # __apigee_reserved__developer_details` can be used to store developers and
1875
+ # their roles. The JSON format expected is: [ ` "developer_id":"", "roles":[ "" ]
1876
+ # ` ] and is dealt in base64encoded format. Etag will be available in attribute
1877
+ # `Attribute` with key `attribute_name` as `
1878
+ # __apigee_reserved__developer_details_etag` for that AppGroup.
1879
+ # @param [String] parent
1880
+ # Required. Name of the Apigee organization in which the AppGroup is created.
1881
+ # Use the following structure in your request: `organizations/`org``.
1882
+ # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup] google_cloud_apigee_v1_app_group_object
1883
+ # @param [String] fields
1884
+ # Selector specifying which fields to include in a partial response.
1885
+ # @param [String] quota_user
1886
+ # Available to use for quota purposes for server-side applications. Can be any
1887
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1888
+ # @param [Google::Apis::RequestOptions] options
1889
+ # Request-specific options
1890
+ #
1891
+ # @yield [result, err] Result & error if block supplied
1892
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup] parsed result object
1893
+ # @yieldparam err [StandardError] error object if request failed
1894
+ #
1895
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup]
1896
+ #
1897
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1898
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1899
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1900
+ def create_organization_appgroup(parent, google_cloud_apigee_v1_app_group_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1901
+ command = make_simple_command(:post, 'v1/{+parent}/appgroups', options)
1902
+ command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup::Representation
1903
+ command.request_object = google_cloud_apigee_v1_app_group_object
1904
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup::Representation
1905
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup
1906
+ command.params['parent'] = parent unless parent.nil?
1907
+ command.query['fields'] = fields unless fields.nil?
1908
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1909
+ execute_or_queue_command(command, &block)
1910
+ end
1911
+
1912
+ # Deletes an AppGroup. All app and API keys associations with the AppGroup are
1913
+ # also removed. **Warning**: This API will permanently delete the AppGroup and
1914
+ # related artifacts. **Note**: The delete operation is asynchronous. The
1915
+ # AppGroup app is deleted immediately, but its associated resources, such as
1916
+ # apps and API keys, may take anywhere from a few seconds to a few minutes to be
1917
+ # deleted.
1918
+ # @param [String] name
1919
+ # Required. Name of the AppGroup. Use the following structure in your request: `
1920
+ # organizations/`org`/appgroups/`app_group_name``
1921
+ # @param [String] fields
1922
+ # Selector specifying which fields to include in a partial response.
1923
+ # @param [String] quota_user
1924
+ # Available to use for quota purposes for server-side applications. Can be any
1925
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1926
+ # @param [Google::Apis::RequestOptions] options
1927
+ # Request-specific options
1928
+ #
1929
+ # @yield [result, err] Result & error if block supplied
1930
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup] parsed result object
1931
+ # @yieldparam err [StandardError] error object if request failed
1932
+ #
1933
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup]
1934
+ #
1935
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1936
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1937
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1938
+ def delete_organization_appgroup(name, fields: nil, quota_user: nil, options: nil, &block)
1939
+ command = make_simple_command(:delete, 'v1/{+name}', options)
1940
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup::Representation
1941
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup
1942
+ command.params['name'] = name unless name.nil?
1943
+ command.query['fields'] = fields unless fields.nil?
1944
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1945
+ execute_or_queue_command(command, &block)
1946
+ end
1947
+
1948
+ # Returns the AppGroup details for the provided AppGroup name in the request URI.
1949
+ # @param [String] name
1950
+ # Required. Name of the AppGroup. Use the following structure in your request: `
1951
+ # organizations/`org`/appgroups/`app_group_name``
1952
+ # @param [String] fields
1953
+ # Selector specifying which fields to include in a partial response.
1954
+ # @param [String] quota_user
1955
+ # Available to use for quota purposes for server-side applications. Can be any
1956
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1957
+ # @param [Google::Apis::RequestOptions] options
1958
+ # Request-specific options
1959
+ #
1960
+ # @yield [result, err] Result & error if block supplied
1961
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup] parsed result object
1962
+ # @yieldparam err [StandardError] error object if request failed
1963
+ #
1964
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup]
1965
+ #
1966
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1967
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1968
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1969
+ def get_organization_appgroup(name, fields: nil, quota_user: nil, options: nil, &block)
1970
+ command = make_simple_command(:get, 'v1/{+name}', options)
1971
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup::Representation
1972
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup
1973
+ command.params['name'] = name unless name.nil?
1974
+ command.query['fields'] = fields unless fields.nil?
1975
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1976
+ execute_or_queue_command(command, &block)
1977
+ end
1978
+
1979
+ # Lists all AppGroups in an organization. A maximum of 1000 AppGroups are
1980
+ # returned in the response if PageSize is not specified, or if the PageSize is
1981
+ # greater than 1000.
1982
+ # @param [String] parent
1983
+ # Required. Name of the Apigee organization. Use the following structure in your
1984
+ # request: `organizations/`org``.
1985
+ # @param [String] filter
1986
+ # The filter expression to be used to get the list of AppGroups, where filtering
1987
+ # can be done on name, correlationID or channelID of the app group. Example:
1988
+ # filter = "name = foobar"
1989
+ # @param [Fixnum] page_size
1990
+ # Count of AppGroups a single page can have in the response. If unspecified, at
1991
+ # most 1000 AppGroups will be returned. The maximum value is 1000; values above
1992
+ # 1000 will be coerced to 1000.
1993
+ # @param [String] page_token
1994
+ # The starting index record for listing the AppGroups.
1995
+ # @param [String] fields
1996
+ # Selector specifying which fields to include in a partial response.
1997
+ # @param [String] quota_user
1998
+ # Available to use for quota purposes for server-side applications. Can be any
1999
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2000
+ # @param [Google::Apis::RequestOptions] options
2001
+ # Request-specific options
2002
+ #
2003
+ # @yield [result, err] Result & error if block supplied
2004
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppGroupsResponse] parsed result object
2005
+ # @yieldparam err [StandardError] error object if request failed
2006
+ #
2007
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppGroupsResponse]
2008
+ #
2009
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2010
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2011
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2012
+ def list_organization_appgroups(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2013
+ command = make_simple_command(:get, 'v1/{+parent}/appgroups', options)
2014
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppGroupsResponse::Representation
2015
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppGroupsResponse
2016
+ command.params['parent'] = parent unless parent.nil?
2017
+ command.query['filter'] = filter unless filter.nil?
2018
+ command.query['pageSize'] = page_size unless page_size.nil?
2019
+ command.query['pageToken'] = page_token unless page_token.nil?
2020
+ command.query['fields'] = fields unless fields.nil?
2021
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2022
+ execute_or_queue_command(command, &block)
2023
+ end
2024
+
2025
+ # Updates an appGroup. This API replaces the existing appGroup details with
2026
+ # those specified in the request. Include or exclude any existing details that
2027
+ # you want to retain or delete, respectively. Note that the state of the
2028
+ # AppGroup should be updated using `action`, and not via AppGroup. The custom
2029
+ # attribute limit is 1000, and is how `__apigee_reserved__developer_details` can
2030
+ # be updated. **Note**: OAuth access tokens and Key Management Service (KMS)
2031
+ # entities (apps, developers, and API products) are cached for 180 seconds (
2032
+ # current default). Any custom attributes associated with these entities are
2033
+ # cached for at least 180 seconds after the entity is accessed at runtime.
2034
+ # Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to
2035
+ # expire an access token in less than 180 seconds.
2036
+ # @param [String] name
2037
+ # Required. Name of the AppGroup. Use the following structure in your request: `
2038
+ # organizations/`org`/appgroups/`app_group_name``
2039
+ # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup] google_cloud_apigee_v1_app_group_object
2040
+ # @param [String] action
2041
+ # Activate or de-activate the appGroup by setting the action as `active` or `
2042
+ # inactive`. The `Content-Type` header must be set to `application/octet-stream`,
2043
+ # with empty body.
2044
+ # @param [String] fields
2045
+ # Selector specifying which fields to include in a partial response.
2046
+ # @param [String] quota_user
2047
+ # Available to use for quota purposes for server-side applications. Can be any
2048
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2049
+ # @param [Google::Apis::RequestOptions] options
2050
+ # Request-specific options
2051
+ #
2052
+ # @yield [result, err] Result & error if block supplied
2053
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup] parsed result object
2054
+ # @yieldparam err [StandardError] error object if request failed
2055
+ #
2056
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup]
2057
+ #
2058
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2059
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2060
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2061
+ def update_organization_appgroup(name, google_cloud_apigee_v1_app_group_object = nil, action: nil, fields: nil, quota_user: nil, options: nil, &block)
2062
+ command = make_simple_command(:put, 'v1/{+name}', options)
2063
+ command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup::Representation
2064
+ command.request_object = google_cloud_apigee_v1_app_group_object
2065
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup::Representation
2066
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroup
2067
+ command.params['name'] = name unless name.nil?
2068
+ command.query['action'] = action unless action.nil?
2069
+ command.query['fields'] = fields unless fields.nil?
2070
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2071
+ execute_or_queue_command(command, &block)
2072
+ end
2073
+
2074
+ # Creates an app and associates it with an AppGroup. This API associates the
2075
+ # AppGroup app with the specified API product and auto-generates an API key for
2076
+ # the app to use in calls to API proxies inside that API product. The `name` is
2077
+ # the unique ID of the app that you can use in API calls.
2078
+ # @param [String] parent
2079
+ # Required. Name of the AppGroup. Use the following structure in your request: `
2080
+ # organizations/`org`/appgroups/`app_group_name``
2081
+ # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp] google_cloud_apigee_v1_app_group_app_object
2082
+ # @param [String] fields
2083
+ # Selector specifying which fields to include in a partial response.
2084
+ # @param [String] quota_user
2085
+ # Available to use for quota purposes for server-side applications. Can be any
2086
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2087
+ # @param [Google::Apis::RequestOptions] options
2088
+ # Request-specific options
2089
+ #
2090
+ # @yield [result, err] Result & error if block supplied
2091
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp] parsed result object
2092
+ # @yieldparam err [StandardError] error object if request failed
2093
+ #
2094
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp]
2095
+ #
2096
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2097
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2098
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2099
+ def create_organization_appgroup_app(parent, google_cloud_apigee_v1_app_group_app_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2100
+ command = make_simple_command(:post, 'v1/{+parent}/apps', options)
2101
+ command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp::Representation
2102
+ command.request_object = google_cloud_apigee_v1_app_group_app_object
2103
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp::Representation
2104
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp
2105
+ command.params['parent'] = parent unless parent.nil?
2106
+ command.query['fields'] = fields unless fields.nil?
2107
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2108
+ execute_or_queue_command(command, &block)
2109
+ end
2110
+
2111
+ # Deletes an AppGroup app. **Note**: The delete operation is asynchronous. The
2112
+ # AppGroup app is deleted immediately, but its associated resources, such as app
2113
+ # keys or access tokens, may take anywhere from a few seconds to a few minutes
2114
+ # to be deleted.
2115
+ # @param [String] name
2116
+ # Required. Name of the AppGroup app. Use the following structure in your
2117
+ # request: `organizations/`org`/appgroups/`app_group_name`/apps/`app``
2118
+ # @param [String] fields
2119
+ # Selector specifying which fields to include in a partial response.
2120
+ # @param [String] quota_user
2121
+ # Available to use for quota purposes for server-side applications. Can be any
2122
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2123
+ # @param [Google::Apis::RequestOptions] options
2124
+ # Request-specific options
2125
+ #
2126
+ # @yield [result, err] Result & error if block supplied
2127
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp] parsed result object
2128
+ # @yieldparam err [StandardError] error object if request failed
2129
+ #
2130
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp]
2131
+ #
2132
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2133
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2134
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2135
+ def delete_organization_appgroup_app(name, fields: nil, quota_user: nil, options: nil, &block)
2136
+ command = make_simple_command(:delete, 'v1/{+name}', options)
2137
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp::Representation
2138
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp
2139
+ command.params['name'] = name unless name.nil?
2140
+ command.query['fields'] = fields unless fields.nil?
2141
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2142
+ execute_or_queue_command(command, &block)
2143
+ end
2144
+
2145
+ # Returns the details for an AppGroup app.
2146
+ # @param [String] name
2147
+ # Required. Name of the AppGroup app. Use the following structure in your
2148
+ # request: `organizations/`org`/appgroups/`app_group_name`/apps/`app``
2149
+ # @param [String] fields
2150
+ # Selector specifying which fields to include in a partial response.
2151
+ # @param [String] quota_user
2152
+ # Available to use for quota purposes for server-side applications. Can be any
2153
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2154
+ # @param [Google::Apis::RequestOptions] options
2155
+ # Request-specific options
2156
+ #
2157
+ # @yield [result, err] Result & error if block supplied
2158
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp] parsed result object
2159
+ # @yieldparam err [StandardError] error object if request failed
2160
+ #
2161
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp]
2162
+ #
2163
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2164
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2165
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2166
+ def get_organization_appgroup_app(name, fields: nil, quota_user: nil, options: nil, &block)
2167
+ command = make_simple_command(:get, 'v1/{+name}', options)
2168
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp::Representation
2169
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp
2170
+ command.params['name'] = name unless name.nil?
2171
+ command.query['fields'] = fields unless fields.nil?
2172
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2173
+ execute_or_queue_command(command, &block)
2174
+ end
2175
+
2176
+ # Lists all apps created by an AppGroup in an Apigee organization. Optionally,
2177
+ # you can request an expanded view of the AppGroup apps. Lists all AppGroupApps
2178
+ # in an AppGroup. A maximum of 1000 AppGroup apps are returned in the response
2179
+ # if PageSize is not specified, or if the PageSize is greater than 1000.
2180
+ # @param [String] parent
2181
+ # Required. Name of the AppGroup. Use the following structure in your request: `
2182
+ # organizations/`org`/appgroups/`app_group_name``
2183
+ # @param [Fixnum] page_size
2184
+ # Optional. Maximum number entries to return. If unspecified, at most 1000
2185
+ # entries will be returned.
2186
+ # @param [String] page_token
2187
+ # Optional. Page token. If provides, must be a valid AppGroup app returned from
2188
+ # a previous call that can be used to retrieve the next page.
2189
+ # @param [String] fields
2190
+ # Selector specifying which fields to include in a partial response.
2191
+ # @param [String] quota_user
2192
+ # Available to use for quota purposes for server-side applications. Can be any
2193
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2194
+ # @param [Google::Apis::RequestOptions] options
2195
+ # Request-specific options
2196
+ #
2197
+ # @yield [result, err] Result & error if block supplied
2198
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppGroupAppsResponse] parsed result object
2199
+ # @yieldparam err [StandardError] error object if request failed
2200
+ #
2201
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppGroupAppsResponse]
2202
+ #
2203
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2204
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2205
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2206
+ def list_organization_appgroup_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2207
+ command = make_simple_command(:get, 'v1/{+parent}/apps', options)
2208
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppGroupAppsResponse::Representation
2209
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppGroupAppsResponse
2210
+ command.params['parent'] = parent unless parent.nil?
2211
+ command.query['pageSize'] = page_size unless page_size.nil?
2212
+ command.query['pageToken'] = page_token unless page_token.nil?
2213
+ command.query['fields'] = fields unless fields.nil?
2214
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2215
+ execute_or_queue_command(command, &block)
2216
+ end
2217
+
2218
+ # Updates the details for an AppGroup app. In addition, you can add an API
2219
+ # product to an AppGroup app and automatically generate an API key for the app
2220
+ # to use when calling APIs in the API product. If you want to use an existing
2221
+ # API key for the API product, add the API product to the API key using the
2222
+ # UpdateAppGroupAppKey API. Using this API, you cannot update the app name, as
2223
+ # it is the primary key used to identify the app and cannot be changed. This API
2224
+ # replaces the existing attributes with those specified in the request. Include
2225
+ # or exclude any existing attributes that you want to retain or delete,
2226
+ # respectively.
2227
+ # @param [String] name
2228
+ # Required. Name of the AppGroup app. Use the following structure in your
2229
+ # request: `organizations/`org`/appgroups/`app_group_name`/apps/`app``
2230
+ # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp] google_cloud_apigee_v1_app_group_app_object
2231
+ # @param [String] action
2232
+ # Approve or revoke the consumer key by setting this value to `approve` or `
2233
+ # revoke`. The `Content-Type` header must be set to `application/octet-stream`,
2234
+ # with empty body.
2235
+ # @param [String] fields
2236
+ # Selector specifying which fields to include in a partial response.
2237
+ # @param [String] quota_user
2238
+ # Available to use for quota purposes for server-side applications. Can be any
2239
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2240
+ # @param [Google::Apis::RequestOptions] options
2241
+ # Request-specific options
2242
+ #
2243
+ # @yield [result, err] Result & error if block supplied
2244
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp] parsed result object
2245
+ # @yieldparam err [StandardError] error object if request failed
2246
+ #
2247
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp]
2248
+ #
2249
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2250
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2251
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2252
+ def update_organization_appgroup_app(name, google_cloud_apigee_v1_app_group_app_object = nil, action: nil, fields: nil, quota_user: nil, options: nil, &block)
2253
+ command = make_simple_command(:put, 'v1/{+name}', options)
2254
+ command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp::Representation
2255
+ command.request_object = google_cloud_apigee_v1_app_group_app_object
2256
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp::Representation
2257
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupApp
2258
+ command.params['name'] = name unless name.nil?
2259
+ command.query['action'] = action unless action.nil?
2260
+ command.query['fields'] = fields unless fields.nil?
2261
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2262
+ execute_or_queue_command(command, &block)
2263
+ end
2264
+
2265
+ # Creates a custom consumer key and secret for a AppGroup app. This is
2266
+ # particularly useful if you want to migrate existing consumer keys and secrets
2267
+ # to Apigee from another system. Consumer keys and secrets can contain letters,
2268
+ # numbers, underscores, and hyphens. No other special characters are allowed. To
2269
+ # avoid service disruptions, a consumer key and secret should not exceed 2 KBs
2270
+ # each. **Note**: When creating the consumer key and secret, an association to
2271
+ # API products will not be made. Therefore, you should not specify the
2272
+ # associated API products in your request. Instead, use the
2273
+ # ProductizeAppGroupAppKey API to make the association after the consumer key
2274
+ # and secret are created. If a consumer key and secret already exist, you can
2275
+ # keep them or delete them using the DeleteAppGroupAppKey API.
2276
+ # @param [String] parent
2277
+ # Required. Parent of the AppGroup app key. Use the following structure in your
2278
+ # request: `organizations/`org`/appgroups/`app_group_name`/apps/`app`/keys`
2279
+ # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey] google_cloud_apigee_v1_app_group_app_key_object
2280
+ # @param [String] fields
2281
+ # Selector specifying which fields to include in a partial response.
2282
+ # @param [String] quota_user
2283
+ # Available to use for quota purposes for server-side applications. Can be any
2284
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2285
+ # @param [Google::Apis::RequestOptions] options
2286
+ # Request-specific options
2287
+ #
2288
+ # @yield [result, err] Result & error if block supplied
2289
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey] parsed result object
2290
+ # @yieldparam err [StandardError] error object if request failed
2291
+ #
2292
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey]
2293
+ #
2294
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2295
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2296
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2297
+ def create_organization_appgroup_app_key(parent, google_cloud_apigee_v1_app_group_app_key_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2298
+ command = make_simple_command(:post, 'v1/{+parent}/keys', options)
2299
+ command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey::Representation
2300
+ command.request_object = google_cloud_apigee_v1_app_group_app_key_object
2301
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey::Representation
2302
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey
2303
+ command.params['parent'] = parent unless parent.nil?
2304
+ command.query['fields'] = fields unless fields.nil?
2305
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2306
+ execute_or_queue_command(command, &block)
2307
+ end
2308
+
2309
+ # Deletes an app's consumer key and removes all API products associated with the
2310
+ # app. After the consumer key is deleted, it cannot be used to access any APIs.
2311
+ # @param [String] name
2312
+ # Required. Name of the AppGroup app key. Use the following structure in your
2313
+ # request: `organizations/`org`/appgroups/`app_group_name`/apps/`app`/keys/`key``
2314
+ # @param [String] fields
2315
+ # Selector specifying which fields to include in a partial response.
2316
+ # @param [String] quota_user
2317
+ # Available to use for quota purposes for server-side applications. Can be any
2318
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2319
+ # @param [Google::Apis::RequestOptions] options
2320
+ # Request-specific options
2321
+ #
2322
+ # @yield [result, err] Result & error if block supplied
2323
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey] parsed result object
2324
+ # @yieldparam err [StandardError] error object if request failed
2325
+ #
2326
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey]
2327
+ #
2328
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2329
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2330
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2331
+ def delete_organization_appgroup_app_key(name, fields: nil, quota_user: nil, options: nil, &block)
2332
+ command = make_simple_command(:delete, 'v1/{+name}', options)
2333
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey::Representation
2334
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey
2335
+ command.params['name'] = name unless name.nil?
2336
+ command.query['fields'] = fields unless fields.nil?
2337
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2338
+ execute_or_queue_command(command, &block)
2339
+ end
2340
+
2341
+ # Gets details for a consumer key for a AppGroup app, including the key and
2342
+ # secret value, associated API products, and other information.
2343
+ # @param [String] name
2344
+ # Required. Name of the AppGroup app key. Use the following structure in your
2345
+ # request: `organizations/`org`/appgroups/`app_group_name`/apps/`app`/keys/`key``
2346
+ # @param [String] fields
2347
+ # Selector specifying which fields to include in a partial response.
2348
+ # @param [String] quota_user
2349
+ # Available to use for quota purposes for server-side applications. Can be any
2350
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2351
+ # @param [Google::Apis::RequestOptions] options
2352
+ # Request-specific options
2353
+ #
2354
+ # @yield [result, err] Result & error if block supplied
2355
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey] parsed result object
2356
+ # @yieldparam err [StandardError] error object if request failed
2357
+ #
2358
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey]
2359
+ #
2360
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2361
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2362
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2363
+ def get_organization_appgroup_app_key(name, fields: nil, quota_user: nil, options: nil, &block)
2364
+ command = make_simple_command(:get, 'v1/{+name}', options)
2365
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey::Representation
2366
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey
2367
+ command.params['name'] = name unless name.nil?
2368
+ command.query['fields'] = fields unless fields.nil?
2369
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2370
+ execute_or_queue_command(command, &block)
2371
+ end
2372
+
2373
+ # Adds an API product to an AppGroupAppKey, enabling the app that holds the key
2374
+ # to access the API resources bundled in the API product. In addition, you can
2375
+ # add attributes to the AppGroupAppKey. This API replaces the existing
2376
+ # attributes with those specified in the request. Include or exclude any
2377
+ # existing attributes that you want to retain or delete, respectively. You can
2378
+ # use the same key to access all API products associated with the app.
2379
+ # @param [String] name
2380
+ # Required. Name of the AppGroup app key. Use the following structure in your
2381
+ # request: `organizations/`org`/appgroups/`app_group_name`/apps/`app`/keys/`key``
2382
+ # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest] google_cloud_apigee_v1_update_app_group_app_key_request_object
2383
+ # @param [String] fields
2384
+ # Selector specifying which fields to include in a partial response.
2385
+ # @param [String] quota_user
2386
+ # Available to use for quota purposes for server-side applications. Can be any
2387
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2388
+ # @param [Google::Apis::RequestOptions] options
2389
+ # Request-specific options
2390
+ #
2391
+ # @yield [result, err] Result & error if block supplied
2392
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey] parsed result object
2393
+ # @yieldparam err [StandardError] error object if request failed
2394
+ #
2395
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey]
2396
+ #
2397
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2398
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2399
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2400
+ def update_organization_appgroup_app_key_app_group_app_key(name, google_cloud_apigee_v1_update_app_group_app_key_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2401
+ command = make_simple_command(:post, 'v1/{+name}', options)
2402
+ command.request_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest::Representation
2403
+ command.request_object = google_cloud_apigee_v1_update_app_group_app_key_request_object
2404
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey::Representation
2405
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey
2406
+ command.params['name'] = name unless name.nil?
2407
+ command.query['fields'] = fields unless fields.nil?
2408
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2409
+ execute_or_queue_command(command, &block)
2410
+ end
2411
+
2412
+ # Removes an API product from an app's consumer key. After the API product is
2413
+ # removed, the app cannot access the API resources defined in that API product. *
2414
+ # *Note**: The consumer key is not removed, only its association with the API
2415
+ # product.
2416
+ # @param [String] name
2417
+ # Required. Parent of the AppGroup app key. Use the following structure in your
2418
+ # request: `organizations/`org`/appgroups/`app_group_name`/apps/`app`/keys/`key`/
2419
+ # apiproducts/`apiproduct``
2420
+ # @param [String] fields
2421
+ # Selector specifying which fields to include in a partial response.
2422
+ # @param [String] quota_user
2423
+ # Available to use for quota purposes for server-side applications. Can be any
2424
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2425
+ # @param [Google::Apis::RequestOptions] options
2426
+ # Request-specific options
2427
+ #
2428
+ # @yield [result, err] Result & error if block supplied
2429
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey] parsed result object
2430
+ # @yieldparam err [StandardError] error object if request failed
2431
+ #
2432
+ # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey]
2433
+ #
2434
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2435
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2436
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2437
+ def delete_organization_appgroup_app_key_apiproduct(name, fields: nil, quota_user: nil, options: nil, &block)
2438
+ command = make_simple_command(:delete, 'v1/{+name}', options)
2439
+ command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey::Representation
2440
+ command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1AppGroupAppKey
2441
+ command.params['name'] = name unless name.nil?
2442
+ command.query['fields'] = fields unless fields.nil?
2443
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2444
+ execute_or_queue_command(command, &block)
2445
+ end
2446
+
2447
+ # Approves or revokes the consumer key for an API product. After a consumer key
2448
+ # is approved, the app can use it to access APIs. A consumer key that is revoked
2449
+ # or pending cannot be used to access an API. Any access tokens associated with
2450
+ # a revoked consumer key will remain active. However, Apigee checks the status
2451
+ # of the consumer key and if set to `revoked` will not allow access to the API.
2452
+ # @param [String] name
2453
+ # Required. Name of the API product in the developer app key in the following
2454
+ # format: `organizations/`org`/appgroups/`app_group_name`/apps/`app`/keys/`key`/
2455
+ # apiproducts/`apiproduct``
2456
+ # @param [String] action
2457
+ # Approve or revoke the consumer key by setting this value to `approve` or `
2458
+ # revoke` respectively. The `Content-Type` header, if set, must be set to `
2459
+ # application/octet-stream`, with empty body.
2460
+ # @param [String] fields
2461
+ # Selector specifying which fields to include in a partial response.
2462
+ # @param [String] quota_user
2463
+ # Available to use for quota purposes for server-side applications. Can be any
2464
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2465
+ # @param [Google::Apis::RequestOptions] options
2466
+ # Request-specific options
2467
+ #
2468
+ # @yield [result, err] Result & error if block supplied
2469
+ # @yieldparam result [Google::Apis::ApigeeV1::GoogleProtobufEmpty] parsed result object
2470
+ # @yieldparam err [StandardError] error object if request failed
2471
+ #
2472
+ # @return [Google::Apis::ApigeeV1::GoogleProtobufEmpty]
2473
+ #
2474
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2475
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2476
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2477
+ def update_organization_appgroup_app_key_apiproduct_app_group_app_key_api_product(name, action: nil, fields: nil, quota_user: nil, options: nil, &block)
2478
+ command = make_simple_command(:post, 'v1/{+name}', options)
2479
+ command.response_representation = Google::Apis::ApigeeV1::GoogleProtobufEmpty::Representation
2480
+ command.response_class = Google::Apis::ApigeeV1::GoogleProtobufEmpty
2481
+ command.params['name'] = name unless name.nil?
2482
+ command.query['action'] = action unless action.nil?
2483
+ command.query['fields'] = fields unless fields.nil?
2484
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2485
+ execute_or_queue_command(command, &block)
2486
+ end
2487
+
1871
2488
  # Gets the app profile for the specified app ID.
1872
2489
  # @param [String] name
1873
2490
  # Required. App ID in the following format: `organizations/`org`/apps/`app``
@@ -1906,11 +2523,16 @@ module Google
1906
2523
  # @param [String] api_product
1907
2524
  # API product.
1908
2525
  # @param [String] apptype
1909
- # Optional. Filter by the type of the app. Valid values are `company` or `
1910
- # developer`. Defaults to `developer`.
2526
+ # Optional. 'apptype' is no longer available. Use a 'filter' instead.
1911
2527
  # @param [Boolean] expand
1912
2528
  # Optional. Flag that specifies whether to return an expanded list of apps for
1913
2529
  # the organization. Defaults to `false`.
2530
+ # @param [String] filter
2531
+ # Optional. The filter expression to be used to get the list of apps, where
2532
+ # filtering can be done on developerEmail, apiProduct, consumerKey, status,
2533
+ # appId, appName and appType. Examples: "developerEmail=foo@bar.com", "appType=
2534
+ # AppGroup", or "appType=Developer" "filter" is supported from ver 1.10.0 and
2535
+ # above.
1914
2536
  # @param [String] ids
1915
2537
  # Optional. Comma-separated list of app IDs on which to filter.
1916
2538
  # @param [Boolean] include_cred
@@ -1918,6 +2540,13 @@ module Google
1918
2540
  # @param [String] key_status
1919
2541
  # Optional. Key status of the app. Valid values include `approved` or `revoked`.
1920
2542
  # Defaults to `approved`.
2543
+ # @param [Fixnum] page_size
2544
+ # Optional. Count of apps a single page can have in the response. If unspecified,
2545
+ # at most 100 apps will be returned. The maximum value is 100; values above 100
2546
+ # will be coerced to 100. "page_size" is supported from ver 1.10.0 and above.
2547
+ # @param [String] page_token
2548
+ # Optional. The starting index record for listing the developers. "page_token"
2549
+ # is supported from ver 1.10.0 and above.
1921
2550
  # @param [Fixnum] rows
1922
2551
  # Optional. Maximum number of app IDs to return. Defaults to 10000.
1923
2552
  # @param [String] start_key
@@ -1942,7 +2571,7 @@ module Google
1942
2571
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1943
2572
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1944
2573
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1945
- def list_organization_apps(parent, api_product: nil, apptype: nil, expand: nil, ids: nil, include_cred: nil, key_status: nil, rows: nil, start_key: nil, status: nil, fields: nil, quota_user: nil, options: nil, &block)
2574
+ def list_organization_apps(parent, api_product: nil, apptype: nil, expand: nil, filter: nil, ids: nil, include_cred: nil, key_status: nil, page_size: nil, page_token: nil, rows: nil, start_key: nil, status: nil, fields: nil, quota_user: nil, options: nil, &block)
1946
2575
  command = make_simple_command(:get, 'v1/{+parent}/apps', options)
1947
2576
  command.response_representation = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppsResponse::Representation
1948
2577
  command.response_class = Google::Apis::ApigeeV1::GoogleCloudApigeeV1ListAppsResponse
@@ -1950,9 +2579,12 @@ module Google
1950
2579
  command.query['apiProduct'] = api_product unless api_product.nil?
1951
2580
  command.query['apptype'] = apptype unless apptype.nil?
1952
2581
  command.query['expand'] = expand unless expand.nil?
2582
+ command.query['filter'] = filter unless filter.nil?
1953
2583
  command.query['ids'] = ids unless ids.nil?
1954
2584
  command.query['includeCred'] = include_cred unless include_cred.nil?
1955
2585
  command.query['keyStatus'] = key_status unless key_status.nil?
2586
+ command.query['pageSize'] = page_size unless page_size.nil?
2587
+ command.query['pageToken'] = page_token unless page_token.nil?
1956
2588
  command.query['rows'] = rows unless rows.nil?
1957
2589
  command.query['startKey'] = start_key unless start_key.nil?
1958
2590
  command.query['status'] = status unless status.nil?
@@ -3018,7 +3650,9 @@ module Google
3018
3650
  # associated API products in your request. Instead, use the
3019
3651
  # UpdateDeveloperAppKey API to make the association after the consumer key and
3020
3652
  # secret are created. If a consumer key and secret already exist, you can keep
3021
- # them or delete them using the DeleteDeveloperAppKey API.
3653
+ # them or delete them using the DeleteDeveloperAppKey API. **Note**: All keys
3654
+ # start out with status=approved, even if status=revoked is passed when the key
3655
+ # is created. To revoke a key, use the UpdateDeveloperAppKey API.
3022
3656
  # @param [String] parent
3023
3657
  # Parent of the developer app key. Use the following structure in your request: `
3024
3658
  # organizations/`org`/developers/`developer_email`/apps`
@@ -3288,7 +3922,9 @@ module Google
3288
3922
  # associated API products in your request. Instead, use the
3289
3923
  # UpdateDeveloperAppKey API to make the association after the consumer key and
3290
3924
  # secret are created. If a consumer key and secret already exist, you can keep
3291
- # them or delete them using the DeleteDeveloperAppKey API.
3925
+ # them or delete them using the DeleteDeveloperAppKey API. **Note**: All keys
3926
+ # start out with status=approved, even if status=revoked is passed when the key
3927
+ # is created. To revoke a key, use the UpdateDeveloperAppKey API.
3292
3928
  # @param [String] parent
3293
3929
  # Parent of the developer app key. Use the following structure in your request: `
3294
3930
  # organizations/`org`/developers/`developer_email`/apps`