Apigee API . organizations . appgroups

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

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`.

Args:
  parent: string, Required. Name of the Apigee organization in which the AppGroup is created. Use the following structure in your request: `organizations/{org}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # AppGroup contains the request/response fields representing the logical grouping of apps. Note that appgroup_id, create_time and update_time cannot be changed by the user, and gets updated by the system. The name and the organization once provided cannot be edited subsequently.
  "appGroupId": "A String", # Output only. Internal identifier that cannot be edited
  "attributes": [ # A list of attributes
    { # Key-value pair to store extra metadata.
      "name": "A String", # API key of the attribute.
      "value": "A String", # Value of the attribute.
    },
  ],
  "channelId": "A String", # channel identifier identifies the owner maintaing this grouping.
  "channelUri": "A String", # A reference to the associated storefront/marketplace.
  "createdAt": "A String", # Output only. Created time as milliseconds since epoch.
  "displayName": "A String", # app group name displayed in the UI
  "email": "A String", # Optional. Email of the AppGroup.
  "lastModifiedAt": "A String", # Output only. Modified time as milliseconds since epoch.
  "name": "A String", # Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._\-$ %.
  "organization": "A String", # Immutable. the org the app group is created
  "status": "A String", # Valid values are `active` or `inactive`. Note that the status of the AppGroup should be updated via UpdateAppGroupRequest by setting the action as `active` or `inactive`.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AppGroup contains the request/response fields representing the logical grouping of apps. Note that appgroup_id, create_time and update_time cannot be changed by the user, and gets updated by the system. The name and the organization once provided cannot be edited subsequently.
  "appGroupId": "A String", # Output only. Internal identifier that cannot be edited
  "attributes": [ # A list of attributes
    { # Key-value pair to store extra metadata.
      "name": "A String", # API key of the attribute.
      "value": "A String", # Value of the attribute.
    },
  ],
  "channelId": "A String", # channel identifier identifies the owner maintaing this grouping.
  "channelUri": "A String", # A reference to the associated storefront/marketplace.
  "createdAt": "A String", # Output only. Created time as milliseconds since epoch.
  "displayName": "A String", # app group name displayed in the UI
  "email": "A String", # Optional. Email of the AppGroup.
  "lastModifiedAt": "A String", # Output only. Modified time as milliseconds since epoch.
  "name": "A String", # Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._\-$ %.
  "organization": "A String", # Immutable. the org the app group is created
  "status": "A String", # Valid values are `active` or `inactive`. Note that the status of the AppGroup should be updated via UpdateAppGroupRequest by setting the action as `active` or `inactive`.
}

delete(name, x__xgafv=None)

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 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.

Args:
  name: string, Required. Name of the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AppGroup contains the request/response fields representing the logical grouping of apps. Note that appgroup_id, create_time and update_time cannot be changed by the user, and gets updated by the system. The name and the organization once provided cannot be edited subsequently.
  "appGroupId": "A String", # Output only. Internal identifier that cannot be edited
  "attributes": [ # A list of attributes
    { # Key-value pair to store extra metadata.
      "name": "A String", # API key of the attribute.
      "value": "A String", # Value of the attribute.
    },
  ],
  "channelId": "A String", # channel identifier identifies the owner maintaing this grouping.
  "channelUri": "A String", # A reference to the associated storefront/marketplace.
  "createdAt": "A String", # Output only. Created time as milliseconds since epoch.
  "displayName": "A String", # app group name displayed in the UI
  "email": "A String", # Optional. Email of the AppGroup.
  "lastModifiedAt": "A String", # Output only. Modified time as milliseconds since epoch.
  "name": "A String", # Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._\-$ %.
  "organization": "A String", # Immutable. the org the app group is created
  "status": "A String", # Valid values are `active` or `inactive`. Note that the status of the AppGroup should be updated via UpdateAppGroupRequest by setting the action as `active` or `inactive`.
}

get(name, x__xgafv=None)

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

Args:
  name: string, Required. Name of the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AppGroup contains the request/response fields representing the logical grouping of apps. Note that appgroup_id, create_time and update_time cannot be changed by the user, and gets updated by the system. The name and the organization once provided cannot be edited subsequently.
  "appGroupId": "A String", # Output only. Internal identifier that cannot be edited
  "attributes": [ # A list of attributes
    { # Key-value pair to store extra metadata.
      "name": "A String", # API key of the attribute.
      "value": "A String", # Value of the attribute.
    },
  ],
  "channelId": "A String", # channel identifier identifies the owner maintaing this grouping.
  "channelUri": "A String", # A reference to the associated storefront/marketplace.
  "createdAt": "A String", # Output only. Created time as milliseconds since epoch.
  "displayName": "A String", # app group name displayed in the UI
  "email": "A String", # Optional. Email of the AppGroup.
  "lastModifiedAt": "A String", # Output only. Modified time as milliseconds since epoch.
  "name": "A String", # Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._\-$ %.
  "organization": "A String", # Immutable. the org the app group is created
  "status": "A String", # Valid values are `active` or `inactive`. Note that the status of the AppGroup should be updated via UpdateAppGroupRequest by setting the action as `active` or `inactive`.
}

getBalance(name, x__xgafv=None)

Gets the account balance for the AppGroup.

Args:
  name: string, Required. Account balance for the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group}/balance` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AppGroupBalance for the AppGroup.
  "wallets": [ # Output only. List of all wallets. Each individual wallet stores the account balance for a particular currency.
    { # Wallet used to manage an account balance for a particular currency.
      "balance": { # Represents an amount of money with its currency type. # Current remaining balance of the AppGroup for a particular currency.
        "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
        "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
        "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
      },
      "lastCreditTime": "A String", # Output only. Time at which the AppGroup last added credit to the account in milliseconds since epoch.
    },
  ],
}

getMonetizationConfig(name, x__xgafv=None)

Gets the monetization configuration for the AppGroup.

Args:
  name: string, Required. Monetization configuration for the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group}/monetizationConfig` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Monetization configuration for the AppGroup.
  "billingType": "A String", # Required. Billing type.
}

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

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.

Args:
  parent: string, Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`. (required)
  filter: string, 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: 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: string, The starting index record for listing the AppGroups.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # ListAppGroupsResponse contains the 0 or more AppGroups, along with the optional page token and the total count of apps.
  "appGroups": [ # List of AppGroups.
    { # AppGroup contains the request/response fields representing the logical grouping of apps. Note that appgroup_id, create_time and update_time cannot be changed by the user, and gets updated by the system. The name and the organization once provided cannot be edited subsequently.
      "appGroupId": "A String", # Output only. Internal identifier that cannot be edited
      "attributes": [ # A list of attributes
        { # Key-value pair to store extra metadata.
          "name": "A String", # API key of the attribute.
          "value": "A String", # Value of the attribute.
        },
      ],
      "channelId": "A String", # channel identifier identifies the owner maintaing this grouping.
      "channelUri": "A String", # A reference to the associated storefront/marketplace.
      "createdAt": "A String", # Output only. Created time as milliseconds since epoch.
      "displayName": "A String", # app group name displayed in the UI
      "email": "A String", # Optional. Email of the AppGroup.
      "lastModifiedAt": "A String", # Output only. Modified time as milliseconds since epoch.
      "name": "A String", # Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._\-$ %.
      "organization": "A String", # Immutable. the org the app group is created
      "status": "A String", # Valid values are `active` or `inactive`. Note that the status of the AppGroup should be updated via UpdateAppGroupRequest by setting the action as `active` or `inactive`.
    },
  ],
  "nextPageToken": "A String", # Token that can be sent as `next_page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "totalSize": 42, # Total count of AppGroups.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

update(name, action=None, body=None, x__xgafv=None)

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.

Args:
  name: string, Required. Name of the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}` (required)
  body: object, The request body.
    The object takes the form of:

{ # AppGroup contains the request/response fields representing the logical grouping of apps. Note that appgroup_id, create_time and update_time cannot be changed by the user, and gets updated by the system. The name and the organization once provided cannot be edited subsequently.
  "appGroupId": "A String", # Output only. Internal identifier that cannot be edited
  "attributes": [ # A list of attributes
    { # Key-value pair to store extra metadata.
      "name": "A String", # API key of the attribute.
      "value": "A String", # Value of the attribute.
    },
  ],
  "channelId": "A String", # channel identifier identifies the owner maintaing this grouping.
  "channelUri": "A String", # A reference to the associated storefront/marketplace.
  "createdAt": "A String", # Output only. Created time as milliseconds since epoch.
  "displayName": "A String", # app group name displayed in the UI
  "email": "A String", # Optional. Email of the AppGroup.
  "lastModifiedAt": "A String", # Output only. Modified time as milliseconds since epoch.
  "name": "A String", # Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._\-$ %.
  "organization": "A String", # Immutable. the org the app group is created
  "status": "A String", # Valid values are `active` or `inactive`. Note that the status of the AppGroup should be updated via UpdateAppGroupRequest by setting the action as `active` or `inactive`.
}

  action: string, 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AppGroup contains the request/response fields representing the logical grouping of apps. Note that appgroup_id, create_time and update_time cannot be changed by the user, and gets updated by the system. The name and the organization once provided cannot be edited subsequently.
  "appGroupId": "A String", # Output only. Internal identifier that cannot be edited
  "attributes": [ # A list of attributes
    { # Key-value pair to store extra metadata.
      "name": "A String", # API key of the attribute.
      "value": "A String", # Value of the attribute.
    },
  ],
  "channelId": "A String", # channel identifier identifies the owner maintaing this grouping.
  "channelUri": "A String", # A reference to the associated storefront/marketplace.
  "createdAt": "A String", # Output only. Created time as milliseconds since epoch.
  "displayName": "A String", # app group name displayed in the UI
  "email": "A String", # Optional. Email of the AppGroup.
  "lastModifiedAt": "A String", # Output only. Modified time as milliseconds since epoch.
  "name": "A String", # Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._\-$ %.
  "organization": "A String", # Immutable. the org the app group is created
  "status": "A String", # Valid values are `active` or `inactive`. Note that the status of the AppGroup should be updated via UpdateAppGroupRequest by setting the action as `active` or `inactive`.
}

updateMonetizationConfig(name, body=None, x__xgafv=None)

Updates the monetization configuration for the AppGroup.

Args:
  name: string, Required. Monetization configuration for the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group}/monetizationConfig` (required)
  body: object, The request body.
    The object takes the form of:

{ # Monetization configuration for the AppGroup.
  "billingType": "A String", # Required. Billing type.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Monetization configuration for the AppGroup.
  "billingType": "A String", # Required. Billing type.
}