Apigee API . organizations . appgroups . balance

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

Adjust the prepaid balance for the AppGroup. This API will be used in scenarios where the AppGroup has been under-charged or over-charged.

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

{ # Request for AdjustAppGroupBalance.
  "adjustment": { # Represents an amount of money with its currency type. # Required. * A positive value of `adjustment` means that that the API provider wants to adjust the balance for an under-charged AppGroup i.e. the balance of the AppGroup will decrease. * A negative value of `adjustment` is not supported. Use credit balance API instead.
    "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.
  },
}

  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.
    },
  ],
}

close()

Close httplib2 connections.

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

Credits 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)
  body: object, The request body.
    The object takes the form of:

{ # Request for CreditAppGroupBalance.
  "transactionAmount": { # Represents an amount of money with its currency type. # Required. The amount of money to be credited. The wallet corresponding to the currency specified within `transaction_amount` will be updated. For example, if you specified `currency_code` within `transaction_amount` as "USD", then the amount would be added to the wallet which has the "USD" currency or if no such wallet exists, a new wallet will be created with the "USD" 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.
  },
  "transactionId": "A String", # Required. Each transaction_id uniquely identifies a credit balance request. If multiple requests are received with the same transaction_id, only one of them will be considered.
}

  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.
    },
  ],
}