Struct PurchaseVoidedpurchaseListCall 

pub struct PurchaseVoidedpurchaseListCall<'a, C>
where
    C: 'a,
{ /* private fields */ }

Lists the purchases that were canceled, refunded or charged-back.

A builder for the voidedpurchases.list method supported by a purchase resource. It is not used directly, but through a PurchaseMethods instance.

Example

Instantiate a resource method builder

// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.purchases().voidedpurchases_list("packageName")
             .type_(-60)
             .token("ipsum")
             .start_time(-5)
             .start_index(77)
             .max_results(7)
             .include_quantity_based_partial_refund(false)
             .end_time(-4)
             .doit().await;

Implementations

impl<'a, C> PurchaseVoidedpurchaseListCall<'a, C>

where C: Connector,

pub async fn doit(self) -> Result<(Response, VoidedPurchasesListResponse)>

Perform the operation you have build so far.

pub fn package_name( self, new_value: &str, ) -> PurchaseVoidedpurchaseListCall<'a, C>

The package name of the application for which voided purchases need to be returned (for example, ‘com.some.thing’).

Sets the package name path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn type_(self, new_value: i32) -> PurchaseVoidedpurchaseListCall<'a, C>

The type of voided purchases that you want to see in the response. Possible values are: 0. Only voided in-app product purchases will be returned in the response. This is the default value. 1. Both voided in-app purchases and voided subscription purchases will be returned in the response. Note: Before requesting to receive voided subscription purchases, you must switch to use orderId in the response which uniquely identifies one-time purchases and subscriptions. Otherwise, you will receive multiple subscription orders with the same PurchaseToken, because subscription renewal orders share the same PurchaseToken.

Sets the type query property to the given value.

pub fn token(self, new_value: &str) -> PurchaseVoidedpurchaseListCall<'a, C>

Defines the token of the page to return, usually taken from TokenPagination. This can only be used if token paging is enabled.

Sets the token query property to the given value.

pub fn start_time(self, new_value: i64) -> PurchaseVoidedpurchaseListCall<'a, C>

The time, in milliseconds since the Epoch, of the oldest voided purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.

Sets the start time query property to the given value.

pub fn start_index( self, new_value: u32, ) -> PurchaseVoidedpurchaseListCall<'a, C>

Defines the index of the first element to return. This can only be used if indexed paging is enabled.

Sets the start index query property to the given value.

pub fn max_results( self, new_value: u32, ) -> PurchaseVoidedpurchaseListCall<'a, C>

Defines how many results the list operation should return. The default number depends on the resource collection.

Sets the max results query property to the given value.

pub fn include_quantity_based_partial_refund( self, new_value: bool, ) -> PurchaseVoidedpurchaseListCall<'a, C>

Optional. Whether to include voided purchases of quantity-based partial refunds, which are applicable only to multi-quantity purchases. If true, additional voided purchases may be returned with voidedQuantity that indicates the refund quantity of a quantity-based partial refund. The default value is false.

Sets the include quantity based partial refund query property to the given value.

pub fn end_time(self, new_value: i64) -> PurchaseVoidedpurchaseListCall<'a, C>

The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.

Sets the end time query property to the given value.

pub fn delegate( self, new_value: &'a mut dyn Delegate, ) -> PurchaseVoidedpurchaseListCall<'a, C>

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

                  It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

pub fn param<T>( self, name: T, value: T, ) -> PurchaseVoidedpurchaseListCall<'a, C>

where T: AsRef<str>,

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• $.xgafv (query-string) - V1 error format.
• access_token (query-string) - OAuth access token.
• alt (query-string) - Data format for response.
• callback (query-string) - JSONP
• fields (query-string) - Selector specifying which fields to include in a partial response.
• key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
• uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
• upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).

pub fn add_scope<St>(self, scope: St) -> PurchaseVoidedpurchaseListCall<'a, C>

where St: AsRef<str>,

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead of the default Scope variant Scope::Full.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope.

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

pub fn add_scopes<I, St>( self, scopes: I, ) -> PurchaseVoidedpurchaseListCall<'a, C>

where I: IntoIterator<Item = St>, St: AsRef<str>,

Identifies the authorization scope(s) for the method you are building.

See Self::add_scope() for details.

pub fn clear_scopes(self) -> PurchaseVoidedpurchaseListCall<'a, C>

Removes all scopes, and no default scope will be used either. In this case, you have to specify your API-key using the key parameter (see Self::param() for details).

Trait Implementations

impl<'a, C> CallBuilder for PurchaseVoidedpurchaseListCall<'a, C>