@spec apigee_organizations_analytics_datastores_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Datastore.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Create a Datastore for an org

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. The parent organization name. Must be of the form organizations/{org}.
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Datastore.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Datastore{}} on success
• {:error, info} on failure

@spec apigee_organizations_analytics_datastores_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Delete a Datastore from an org.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Resource name of the Datastore to be deleted. Must be of the form organizations/{org}/analytics/datastores/{datastoreId}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty{}} on success
• {:error, info} on failure

@spec apigee_organizations_analytics_datastores_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Datastore.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get a Datastore

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Resource name of the Datastore to be get. Must be of the form organizations/{org}/analytics/datastores/{datastoreId}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Datastore{}} on success
• {:error, info} on failure

@spec apigee_organizations_analytics_datastores_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDatastoresResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List Datastores

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. The parent organization name. Must be of the form organizations/{org}.
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :targetType (type: String.t) - Optional. TargetType is used to fetch all Datastores that match the type
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDatastoresResponse{}} on success
• {:error, info} on failure

@spec apigee_organizations_analytics_datastores_test(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1TestDatastoreResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. The parent organization name Must be of the form organizations/{org}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Datastore.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1TestDatastoreResponse{}} on success
• {:error, info} on failure

@spec apigee_organizations_analytics_datastores_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Datastore.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update a Datastore

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. The resource name of datastore to be updated. Must be of the form organizations/{org}/analytics/datastores/{datastoreId}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Datastore.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Datastore{}} on success
• {:error, info} on failure

@spec apigee_organizations_apiproducts_attributes(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates or creates API product attributes. This API replaces the current list of attributes with the attributes specified in the request body. In this way, you can update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the API product. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes{}} on success
• {:error, info} on failure

@spec apigee_organizations_apiproducts_attributes_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an API product attribute.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the API product attribute. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute{}} on success
• {:error, info} on failure

@spec apigee_organizations_apiproducts_attributes_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the value of an API product attribute.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the API product attribute. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute{}} on success
• {:error, info} on failure

@spec apigee_organizations_apiproducts_attributes_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all API product attributes.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Name of the API product. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attributes{}} on success
• {:error, info} on failure

@spec apigee_organizations_apiproducts_attributes_update_api_product_attribute(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the value of an API product attribute. Note: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the API product. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Attribute{}} on success
• {:error, info} on failure

@spec apigee_organizations_apiproducts_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on the fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer-grained API products, defining different sets of API resources for each API product. WARNING: - If you don't specify an API proxy in the request body, any app associated with the product can make calls to any API in your entire organization. - If you don't specify an environment in the request body, the product allows access to all environments. For more information, see What is an API product?

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Name of the organization in which the API product will be created. Use the following structure in your request: organizations/{org}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct{}} on success
• {:error, info} on failure

@spec apigee_organizations_apiproducts_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an API product from an organization. Deleting an API product causes app requests to the resource URIs defined in the API product to fail. Ensure that you create a new API product to serve existing apps, unless your intention is to disable access to the resources defined in the API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the API product. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct{}} on success
• {:error, info} on failure

@spec apigee_organizations_apiproducts_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets configuration details for an API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the API product. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct{}} on success
• {:error, info} on failure

@spec apigee_organizations_apiproducts_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListApiProductsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all API product names for an organization. Filter the list by passing an attributename and attibutevalue. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the startKey and count query parameters.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Name of the organization. Use the following structure in your request: organizations/{org}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :attributename (type: String.t) - Name of the attribute used to filter the search.
  • :attributevalue (type: String.t) - Value of the attribute used to filter the search.
  • :count (type: String.t) - Enter the number of API products you want returned in the API call. The limit is 1000.
  • :expand (type: boolean()) - Flag that specifies whether to expand the results. Set to true to get expanded details about each API.
  • :startKey (type: String.t) - Gets a list of API products starting with a specific API product in the list. For example, if you're returning 50 API products at a time (using the count query parameter), you can view products 50-99 by entering the name of the 50th API product in the first API (without using startKey). Product name is case sensitive.
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListApiProductsResponse{}} on success
• {:error, info} on failure

@spec apigee_organizations_apiproducts_rateplans_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RatePlan.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Create a rate plan that is associated with an API product in an organization. Using rate plans, API product owners can monetize their API products by configuring one or more of the following: - Billing frequency - Initial setup fees for using an API product - Payment funding model (postpaid only) - Fixed recurring or consumption-based charges for using an API product - Revenue sharing with developer partners An API product can have multiple rate plans associated with it but only one rate plan can be active at any point of time. **Note: From the developer's perspective, they purchase API products not rate plans.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Name of the API product that is associated with the rate plan. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RatePlan.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RatePlan{}} on success
• {:error, info} on failure

@spec apigee_organizations_apiproducts_rateplans_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RatePlan.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a rate plan.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. ID of the rate plan. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RatePlan{}} on success
• {:error, info} on failure

@spec apigee_organizations_apiproducts_rateplans_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RatePlan.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the details of a rate plan.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the rate plan. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RatePlan{}} on success
• {:error, info} on failure

@spec apigee_organizations_apiproducts_rateplans_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListRatePlansResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all the rate plans for an API product.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Name of the API product. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct} Use organizations/{org}/apiproducts/- to return rate plans for all API products within the organization.
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :count (type: integer()) - Number of rate plans to return in the API call. Use with the startKey parameter to provide more targeted filtering. The maximum limit is 1000. Defaults to 100.
  • :expand (type: boolean()) - Flag that specifies whether to expand the results. Set to true to get expanded details about each API. Defaults to false.
  • :orderBy (type: String.t) - Name of the attribute used for sorting. Valid values include: name: Name of the rate plan. state: State of the rate plan (DRAFT, PUBLISHED). startTime: Time when the rate plan becomes active. endTime: Time when the rate plan expires. Note: Not supported by Apigee at this time.
  • :startKey (type: String.t) - Name of the rate plan from which to start displaying the list of rate plans. If omitted, the list starts from the first item. For example, to view the rate plans from 51-150, set the value of startKey to the name of the 51st rate plan and set the value of count to 100.
  • :state (type: String.t) - State of the rate plans (DRAFT, PUBLISHED) that you want to display.
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListRatePlansResponse{}} on success
• {:error, info} on failure

@spec apigee_organizations_apiproducts_rateplans_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RatePlan.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing rate plan.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the rate plan. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RatePlan.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RatePlan{}} on success
• {:error, info} on failure

@spec apigee_organizations_apiproducts_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the API product. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProduct{}} on success
• {:error, info} on failure

@spec apigee_organizations_apis_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxyRevision.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the name query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: Set the name query parameter to the name of the API proxy. Set the action query parameter to import. Set the Content-Type header to multipart/form-data. Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the file form field. Note: To validate the API proxy configuration bundle only without importing it, set the action query parameter to validate. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Name of the organization in the following format: organizations/{org}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :action (type: String.t) - Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: import to import the API proxy configuration bundle. validate to validate the API proxy configuration bundle without importing it.
  • :name (type: String.t) - Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-
  • :validate (type: boolean()) - Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleApiHttpBody.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxyRevision{}} on success
• {:error, info} on failure

@spec apigee_organizations_apis_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be undeployed before you can delete it.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the API proxy in the following format: organizations/{org}/apis/{api}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxy{}} on success
• {:error, info} on failure

@spec apigee_organizations_apis_deployments_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDeploymentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all deployments of an API proxy.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Name of the API proxy for which to return deployment information in the following format: organizations/{org}/apis/{api}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDeploymentsResponse{}} on success
• {:error, info} on failure

@spec apigee_organizations_apis_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets an API proxy including a list of existing revisions.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the API proxy in the following format: organizations/{org}/apis/{api}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxy{}} on success
• {:error, info} on failure

@spec apigee_organizations_apis_keyvaluemaps_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a key value map in an API proxy.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Name of the environment in which to create the key value map. Use the following structure in your request: organizations/{org}/apis/{api}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap{}} on success
• {:error, info} on failure

@spec apigee_organizations_apis_keyvaluemaps_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a key value map from an API proxy.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the key value map. Use the following structure in your request: organizations/{org}/apis/{api}/keyvaluemaps/{keyvaluemap}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueMap{}} on success
• {:error, info} on failure

@spec apigee_organizations_apis_keyvaluemaps_entries_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueEntry.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates key value entries in a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Scope as indicated by the URI in which to create the key value map entry. Use one of the following structures in your request: organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}. organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap} * organizations/{organization}/keyvaluemaps/{keyvaluemap}.
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueEntry.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueEntry{}} on success
• {:error, info} on failure

@spec apigee_organizations_apis_keyvaluemaps_entries_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueEntry.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. Notes: After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. Supported for Apigee hybrid 1.8.x and higher.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Scope as indicated by the URI in which to delete the key value map entry. Use one of the following structures in your request: organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}. organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry} * organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}.
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueEntry{}} on success
• {:error, info} on failure

@spec apigee_organizations_apis_keyvaluemaps_entries_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueEntry.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Scope as indicated by the URI in which to fetch the key value map entry/value. Use one of the following structures in your request: organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}. organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry} * organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}.
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueEntry{}} on success
• {:error, info} on failure

@spec apigee_organizations_apis_keyvaluemaps_entries_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListKeyValueEntriesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists key value entries for key values maps scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Scope as indicated by the URI in which to list key value maps. Use one of the following structures in your request: organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}. organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap} * organizations/{organization}/keyvaluemaps/{keyvaluemap}.
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :pageSize (type: integer()) - Optional. Maximum number of key value entries to return. If unspecified, at most 100 entries will be returned.
  • :pageToken (type: String.t) - Optional. Page token. If provides, must be a valid key value entry returned from a previous call that can be used to retrieve the next page.
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListKeyValueEntriesResponse{}} on success
• {:error, info} on failure

@spec apigee_organizations_apis_keyvaluemaps_entries_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueEntry.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update key value entry scoped to an organization, environment, or API proxy for an existing key.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Scope as indicated by the URI in which to create the key value map entry. Use one of the following structures in your request: organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}. organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap} * organizations/{organization}/keyvaluemaps/{keyvaluemap}.
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueEntry.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1KeyValueEntry{}} on success
• {:error, info} on failure

@spec apigee_organizations_apis_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListApiProxiesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Name of the organization in the following format: organizations/{org}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :includeMetaData (type: boolean()) - Flag that specifies whether to include API proxy metadata in the response.
  • :includeRevisions (type: boolean()) - Flag that specifies whether to include a list of revisions in the response.
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListApiProxiesResponse{}} on success
• {:error, info} on failure

@spec apigee_organizations_apis_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing API proxy.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. API proxy to update in the following format: organizations/{org}/apis/{api}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :updateMask (type: String.t) - Required. The list of fields to update.
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxy.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxy{}} on success
• {:error, info} on failure

@spec apigee_organizations_apis_revisions_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxyRevision.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an API proxy revision and all policies, resources, endpoints, and revisions associated with it. The API proxy revision must be undeployed before you can delete it.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. API proxy revision in the following format: organizations/{org}/apis/{api}/revisions/{rev}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxyRevision{}} on success
• {:error, info} on failure

@spec apigee_organizations_apis_revisions_deployments_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDeploymentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all deployments of an API proxy revision.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Name of the API proxy revision for which to return deployment information in the following format: organizations/{org}/apis/{api}/revisions/{rev}.
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListDeploymentsResponse{}} on success
• {:error, info} on failure

@spec apigee_organizations_apis_revisions_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleApiHttpBody.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets an API proxy revision. To download the API proxy configuration bundle for the specified revision as a zip file, set the format query parameter to bundle. If you are using curl, specify -o filename.zip to save the output to a file; otherwise, it displays to stdout. Then, develop the API proxy configuration locally and upload the updated API proxy configuration revision, as described in updateApiProxyRevision.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. API proxy revision in the following format: organizations/{org}/apis/{api}/revisions/{rev}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :format (type: String.t) - Format used when downloading the API proxy configuration revision. Set to bundle to download the API proxy configuration revision as a zip file.
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleApiHttpBody{}} on success
• {:error, info} on failure

@spec apigee_organizations_apis_revisions_update_api_proxy_revision(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxyRevision.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing API proxy revision by uploading the API proxy configuration bundle as a zip file from your local machine. You can update only API proxy revisions that have never been deployed. After deployment, an API proxy revision becomes immutable, even if it is undeployed. Set the Content-Type header to either multipart/form-data or application/octet-stream.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. API proxy revision to update in the following format: organizations/{org}/apis/{api}/revisions/{rev}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :validate (type: boolean()) - Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleApiHttpBody.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ApiProxyRevision{}} on success
• {:error, info} on failure

@spec apigee_organizations_appgroups_apps_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupApp.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an app and associates it with an AppGroup. This API associates the AppGroup app with the specified API product and auto-generates an API key for the app to use in calls to API proxies inside that API product. The name is the unique ID of the app that you can use in API calls.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Name of the AppGroup. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupApp.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupApp{}} on success
• {:error, info} on failure

@spec apigee_organizations_appgroups_apps_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupApp.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an AppGroup app. Note: The delete operation is asynchronous. The AppGroup app is deleted immediately, but its associated resources, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be deleted.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the AppGroup app. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}/apps/{app}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupApp{}} on success
• {:error, info} on failure

@spec apigee_organizations_appgroups_apps_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupApp.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the details for an AppGroup app.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the AppGroup app. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}/apps/{app}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupApp{}} on success
• {:error, info} on failure

@spec apigee_organizations_appgroups_apps_keys_apiproducts_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupAppKey.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Removes an API product from an app's consumer key. After the API product is removed, the app cannot access the API resources defined in that API product. Note: The consumer key is not removed, only its association with the API product.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Parent of the AppGroup app key. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}/apiproducts/{apiproduct}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupAppKey{}} on success
• {:error, info} on failure

@spec apigee_organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Approves or revokes the consumer key for an API product. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee checks the status of the consumer key and if set to revoked will not allow access to the API.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the API product in the developer app key in the following format: organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}/apiproducts/{apiproduct}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :action (type: String.t) - Approve or revoke the consumer key by setting this value to approve or revoke respectively. The Content-Type header, if set, must be set to application/octet-stream, with empty body.
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleProtobufEmpty{}} on success
• {:error, info} on failure

@spec apigee_organizations_appgroups_apps_keys_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupAppKey.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a custom consumer key and secret for a AppGroup app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. Note: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the ProductizeAppGroupAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteAppGroupAppKey API.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Parent of the AppGroup app key. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupAppKey.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupAppKey{}} on success
• {:error, info} on failure

@spec apigee_organizations_appgroups_apps_keys_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupAppKey.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an app's consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the AppGroup app key. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupAppKey{}} on success
• {:error, info} on failure

@spec apigee_organizations_appgroups_apps_keys_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupAppKey.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets details for a consumer key for a AppGroup app, including the key and secret value, associated API products, and other information.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the AppGroup app key. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupAppKey{}} on success
• {:error, info} on failure

@spec apigee_organizations_appgroups_apps_keys_update_app_group_app_key(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupAppKey.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Adds an API product to an AppGroupAppKey, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes to the AppGroupAppKey. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. You can use the same key to access all API products associated with the app.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the AppGroup app key. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupAppKey{}} on success
• {:error, info} on failure

@spec apigee_organizations_appgroups_apps_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListAppGroupAppsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all apps created by an AppGroup in an Apigee organization. Optionally, you can request an expanded view of the AppGroup apps. Lists all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Name of the AppGroup. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :pageSize (type: integer()) - Optional. Maximum number entries to return. If unspecified, at most 1000 entries will be returned.
  • :pageToken (type: String.t) - Optional. Page token. If provides, must be a valid AppGroup app returned from a previous call that can be used to retrieve the next page.
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListAppGroupAppsResponse{}} on success
• {:error, info} on failure

@spec apigee_organizations_appgroups_apps_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupApp.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the details for an AppGroup app. In addition, you can add an API product to an AppGroup app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateAppGroupAppKey API. Using this API, you cannot update the app name, as it is the primary key used to identify the app and cannot be changed. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the AppGroup app. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}/apps/{app}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :action (type: String.t) - Approve or revoke the consumer key by setting this value to approve or revoke. The Content-Type header must be set to application/octet-stream, with empty body.
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupApp.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroupApp{}} on success
• {:error, info} on failure

@spec apigee_organizations_appgroups_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroup.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an AppGroup. Once created, user can register apps under the AppGroup to obtain secret key and password. At creation time, the AppGroup's state is set as active.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Name of the Apigee organization in which the AppGroup is created. Use the following structure in your request: organizations/{org}.
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroup.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroup{}} on success
• {:error, info} on failure

@spec apigee_organizations_appgroups_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroup.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an AppGroup. All app and API keys associations with the AppGroup are also removed. Warning: This API will permanently delete the AppGroup and related artifacts. Note: The delete operation is asynchronous. The AppGroup app is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the AppGroup. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroup{}} on success
• {:error, info} on failure

@spec apigee_organizations_appgroups_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroup.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the AppGroup details for the provided AppGroup name in the request URI.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the AppGroup. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroup{}} on success
• {:error, info} on failure

@spec apigee_organizations_appgroups_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListAppGroupsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all AppGroups in an organization. A maximum of 1000 AppGroups are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Name of the Apigee organization. Use the following structure in your request: organizations/{org}.
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :filter (type: String.t) - The filter expression to be used to get the list of AppGroups, where filtering can be done on status, channelId or channelUri of the app group. Examples: filter=status=active", filter=channelId=, filter=channelUri=
  • :pageSize (type: integer()) - Count of AppGroups a single page can have in the response. If unspecified, at most 1000 AppGroups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • :pageToken (type: String.t) - The starting index record for listing the AppGroups.
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListAppGroupsResponse{}} on success
• {:error, info} on failure

@spec apigee_organizations_appgroups_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroup.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an AppGroup. This API replaces the existing AppGroup details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. Note that the state of the AppGroup should be updated using action, and not via AppGroup.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. Name of the AppGroup. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :action (type: String.t) - Activate or de-activate the AppGroup by setting the action as active or inactive. The Content-Type header must be set to application/octet-stream, with empty body.
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroup.t) -
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1AppGroup{}} on success
• {:error, info} on failure

@spec apigee_organizations_apps_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1App.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the app profile for the specified app ID.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• name (type: String.t) - Required. App ID in the following format: organizations/{org}/apps/{app}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1App{}} on success
• {:error, info} on failure

@spec apigee_organizations_apps_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListAppsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company).

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• parent (type: String.t) - Required. Resource path of the parent in the following format: organizations/{org}
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :apiProduct (type: String.t) - API product.
  • :apptype (type: String.t) - Optional. 'apptype' is no longer available. Use a 'filter' instead.
  • :expand (type: boolean()) - Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults to false.
  • :filter (type: String.t) - Optional. The filter expression to be used to get the list of apps, where filtering can be done on developerEmail, apiProduct, consumerKey, status, appId, appName, appType and appGroup. Examples: "developerEmail=foo@bar.com", "appType=AppGroup", or "appType=Developer" "filter" is supported from ver 1.10.0 and above.
  • :ids (type: String.t) - Optional. Comma-separated list of app IDs on which to filter.
  • :includeCred (type: boolean()) - Optional. Flag that specifies whether to include credentials in the response.
  • :keyStatus (type: String.t) - Optional. Key status of the app. Valid values include approved or revoked. Defaults to approved.
  • :pageSize (type: integer()) - Optional. Count of apps a single page can have in the response. If unspecified, at most 100 apps will be returned. The maximum value is 100; values above 100 will be coerced to 100. "page_size" is supported from ver 1.10.0 and above.
  • :pageToken (type: String.t) - Optional. The starting index record for listing the developers. "page_token" is supported from ver 1.10.0 and above.
  • :rows (type: String.t) - Optional. Maximum number of app IDs to return. Defaults to 10000.
  • :startKey (type: String.t) - Returns the list of apps starting from the specified app ID.
  • :status (type: String.t) - Optional. Filter by the status of the app. Valid values are approved or revoked. Defaults to approved.
• opts (type: keyword()) - Call options

Returns

• {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListAppsResponse{}} on success
• {:error, info} on failure

@spec apigee_organizations_create(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an Apigee organization. See Create an Apigee organization.

Parameters

• connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
• optional_params (type: keyword()) - Optional parameters
  • :"$.xgafv" (type: String.t) - V1 error format.
  • :access_token (type: String.t) - OAuth access token.
  • :alt (type: String.t) - Data format for response.
  • :callback (type: String.t) - JSONP
  • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
  • :key (type: String.t) - 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.
  • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
  • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
  • :quotaUser (type: String.t) - 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.
  • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
  • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • :parent (type: String.t) - Required. Name of the Google Cloud project in which to associate the Apigee organization. Pass the information as a query parameter using the following structure in your request: projects/
  • :body (type: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Organization.t) -
• opts (type: keyword()) - Call options