mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
4f8a3d571b
* Add Google APIs typings * [gapi.cliebt.* ] Add version as part of typings name and fix gapi.client tslint errors * versions should not get their own folders fixing a few typos using /** syntax so comments show up in editors export only actual (last) version for now * export only actual (last) version for now * merge namespaces and remove unnecessary namespace qualifiers * remove namespace qualifier for gapi.client.Request from nested namespaces and change Request base interface to Promise * disable await-promise rule * fix collision between gapi.client.Request and Request from nested namespace disable no-irregular-whitespace rule * sort properties and namespace resources * remove empty comments sort resources amd methods in tests and readme.md * update 'this is autogenerated file' banner to remove this text from gapi.client namespace hint use multiline comments when comment has several lines * implement no-trailing-whitespace, no-padding, max-line-length, await-promise, no-irregular-whitespace rules * add strictFunctionTypes to tsconfig * fix "Whitespace within parentheses is not allowed" rule * fix ts-lint rules * fixes * remove deprecated replicapool and replicapoolupdater api * fix no-irregular-whitespace * fix no-irregular-whitespace
388 lines
19 KiB
TypeScript
388 lines
19 KiB
TypeScript
/* This is stub file for gapi.client.{{=it.name}} definition tests */
|
|
/* IMPORTANT.
|
|
* This file was automatically generated by https://github.com/Bolisov/google-api-typings-generator. Please do not edit it manually.
|
|
* In case of any problems please post issue to https://github.com/Bolisov/google-api-typings-generator
|
|
**/
|
|
gapi.load('client', () => {
|
|
/** now we can use gapi.client */
|
|
gapi.client.load('content', 'v2', () => {
|
|
/** now we can use gapi.client.content */
|
|
|
|
/** don't forget to authenticate your client before sending any request to resources: */
|
|
/** declare client_id registered in Google Developers Console */
|
|
const client_id = '<<PUT YOUR CLIENT ID HERE>>';
|
|
const scope = [
|
|
/** Manage your product listings and accounts for Google Shopping */
|
|
'https://www.googleapis.com/auth/content',
|
|
];
|
|
const immediate = true;
|
|
gapi.auth.authorize({ client_id, scope, immediate }, authResult => {
|
|
if (authResult && !authResult.error) {
|
|
/** handle succesfull authorization */
|
|
run();
|
|
} else {
|
|
/** handle authorization error */
|
|
}
|
|
});
|
|
run();
|
|
});
|
|
|
|
async function run() {
|
|
/** Returns information about the authenticated user. */
|
|
await gapi.client.accounts.authinfo({
|
|
});
|
|
/**
|
|
* Claims the website of a Merchant Center sub-account. This method can only be called for accounts to which the managing account has access: either the
|
|
* managing account itself for any Merchant Center account, or any sub-account when the managing account is a multi-client account.
|
|
*/
|
|
await gapi.client.accounts.claimwebsite({
|
|
accountId: "accountId",
|
|
merchantId: "merchantId",
|
|
overwrite: true,
|
|
});
|
|
/** Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request. */
|
|
await gapi.client.accounts.custombatch({
|
|
dryRun: true,
|
|
});
|
|
/** Deletes a Merchant Center sub-account. This method can only be called for multi-client accounts. */
|
|
await gapi.client.accounts.delete({
|
|
accountId: "accountId",
|
|
dryRun: true,
|
|
force: true,
|
|
merchantId: "merchantId",
|
|
});
|
|
/**
|
|
* Retrieves a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account
|
|
* itself for any Merchant Center account, or any sub-account when the managing account is a multi-client account.
|
|
*/
|
|
await gapi.client.accounts.get({
|
|
accountId: "accountId",
|
|
merchantId: "merchantId",
|
|
});
|
|
/** Creates a Merchant Center sub-account. This method can only be called for multi-client accounts. */
|
|
await gapi.client.accounts.insert({
|
|
dryRun: true,
|
|
merchantId: "merchantId",
|
|
});
|
|
/** Lists the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts. */
|
|
await gapi.client.accounts.list({
|
|
maxResults: 1,
|
|
merchantId: "merchantId",
|
|
pageToken: "pageToken",
|
|
});
|
|
/**
|
|
* Updates a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account
|
|
* itself for any Merchant Center account, or any sub-account when the managing account is a multi-client account. This method supports patch semantics.
|
|
*/
|
|
await gapi.client.accounts.patch({
|
|
accountId: "accountId",
|
|
dryRun: true,
|
|
merchantId: "merchantId",
|
|
});
|
|
/**
|
|
* Updates a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account
|
|
* itself for any Merchant Center account, or any sub-account when the managing account is a multi-client account.
|
|
*/
|
|
await gapi.client.accounts.update({
|
|
accountId: "accountId",
|
|
dryRun: true,
|
|
merchantId: "merchantId",
|
|
});
|
|
await gapi.client.accountstatuses.custombatch({
|
|
});
|
|
/**
|
|
* Retrieves the status of a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the
|
|
* managing account itself for any Merchant Center account, or any sub-account when the managing account is a multi-client account.
|
|
*/
|
|
await gapi.client.accountstatuses.get({
|
|
accountId: "accountId",
|
|
merchantId: "merchantId",
|
|
});
|
|
/** Lists the statuses of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts. */
|
|
await gapi.client.accountstatuses.list({
|
|
maxResults: 1,
|
|
merchantId: "merchantId",
|
|
pageToken: "pageToken",
|
|
});
|
|
/** Retrieves and updates tax settings of multiple accounts in a single request. */
|
|
await gapi.client.accounttax.custombatch({
|
|
dryRun: true,
|
|
});
|
|
/**
|
|
* Retrieves the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing
|
|
* account itself for any Merchant Center account, or any sub-account when the managing account is a multi-client account.
|
|
*/
|
|
await gapi.client.accounttax.get({
|
|
accountId: "accountId",
|
|
merchantId: "merchantId",
|
|
});
|
|
/** Lists the tax settings of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts. */
|
|
await gapi.client.accounttax.list({
|
|
maxResults: 1,
|
|
merchantId: "merchantId",
|
|
pageToken: "pageToken",
|
|
});
|
|
/**
|
|
* Updates the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing
|
|
* account itself for any Merchant Center account, or any sub-account when the managing account is a multi-client account. This method supports patch
|
|
* semantics.
|
|
*/
|
|
await gapi.client.accounttax.patch({
|
|
accountId: "accountId",
|
|
dryRun: true,
|
|
merchantId: "merchantId",
|
|
});
|
|
/**
|
|
* Updates the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing
|
|
* account itself for any Merchant Center account, or any sub-account when the managing account is a multi-client account.
|
|
*/
|
|
await gapi.client.accounttax.update({
|
|
accountId: "accountId",
|
|
dryRun: true,
|
|
merchantId: "merchantId",
|
|
});
|
|
await gapi.client.datafeeds.custombatch({
|
|
dryRun: true,
|
|
});
|
|
/** Deletes a datafeed configuration from your Merchant Center account. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.datafeeds.delete({
|
|
datafeedId: "datafeedId",
|
|
dryRun: true,
|
|
merchantId: "merchantId",
|
|
});
|
|
/** Retrieves a datafeed configuration from your Merchant Center account. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.datafeeds.get({
|
|
datafeedId: "datafeedId",
|
|
merchantId: "merchantId",
|
|
});
|
|
/** Registers a datafeed configuration with your Merchant Center account. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.datafeeds.insert({
|
|
dryRun: true,
|
|
merchantId: "merchantId",
|
|
});
|
|
/** Lists the datafeeds in your Merchant Center account. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.datafeeds.list({
|
|
maxResults: 1,
|
|
merchantId: "merchantId",
|
|
pageToken: "pageToken",
|
|
});
|
|
/**
|
|
* Updates a datafeed configuration of your Merchant Center account. This method can only be called for non-multi-client accounts. This method supports
|
|
* patch semantics.
|
|
*/
|
|
await gapi.client.datafeeds.patch({
|
|
datafeedId: "datafeedId",
|
|
dryRun: true,
|
|
merchantId: "merchantId",
|
|
});
|
|
/** Updates a datafeed configuration of your Merchant Center account. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.datafeeds.update({
|
|
datafeedId: "datafeedId",
|
|
dryRun: true,
|
|
merchantId: "merchantId",
|
|
});
|
|
await gapi.client.datafeedstatuses.custombatch({
|
|
});
|
|
/** Retrieves the status of a datafeed from your Merchant Center account. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.datafeedstatuses.get({
|
|
country: "country",
|
|
datafeedId: "datafeedId",
|
|
language: "language",
|
|
merchantId: "merchantId",
|
|
});
|
|
/** Lists the statuses of the datafeeds in your Merchant Center account. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.datafeedstatuses.list({
|
|
maxResults: 1,
|
|
merchantId: "merchantId",
|
|
pageToken: "pageToken",
|
|
});
|
|
/**
|
|
* Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products.
|
|
* This method can only be called for non-multi-client accounts.
|
|
*/
|
|
await gapi.client.inventory.custombatch({
|
|
dryRun: true,
|
|
});
|
|
/**
|
|
* Updates price and availability of a product in your Merchant Center account. This operation does not update the expiration date of the product. This
|
|
* method can only be called for non-multi-client accounts.
|
|
*/
|
|
await gapi.client.inventory.set({
|
|
dryRun: true,
|
|
merchantId: "merchantId",
|
|
productId: "productId",
|
|
storeCode: "storeCode",
|
|
});
|
|
/** Marks an order as acknowledged. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.orders.acknowledge({
|
|
merchantId: "merchantId",
|
|
orderId: "orderId",
|
|
});
|
|
/** Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment". This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.orders.advancetestorder({
|
|
merchantId: "merchantId",
|
|
orderId: "orderId",
|
|
});
|
|
/** Cancels all line items in an order, making a full refund. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.orders.cancel({
|
|
merchantId: "merchantId",
|
|
orderId: "orderId",
|
|
});
|
|
/** Cancels a line item, making a full refund. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.orders.cancellineitem({
|
|
merchantId: "merchantId",
|
|
orderId: "orderId",
|
|
});
|
|
/** Sandbox only. Creates a test order. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.orders.createtestorder({
|
|
merchantId: "merchantId",
|
|
});
|
|
/** Retrieves or modifies multiple orders in a single request. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.orders.custombatch({
|
|
});
|
|
/** Retrieves an order from your Merchant Center account. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.orders.get({
|
|
merchantId: "merchantId",
|
|
orderId: "orderId",
|
|
});
|
|
/** Retrieves an order using merchant order id. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.orders.getbymerchantorderid({
|
|
merchantId: "merchantId",
|
|
merchantOrderId: "merchantOrderId",
|
|
});
|
|
/**
|
|
* Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox. This method can only be called for
|
|
* non-multi-client accounts.
|
|
*/
|
|
await gapi.client.orders.gettestordertemplate({
|
|
merchantId: "merchantId",
|
|
templateName: "templateName",
|
|
});
|
|
/** Lists the orders in your Merchant Center account. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.orders.list({
|
|
acknowledged: true,
|
|
maxResults: 2,
|
|
merchantId: "merchantId",
|
|
orderBy: "orderBy",
|
|
pageToken: "pageToken",
|
|
placedDateEnd: "placedDateEnd",
|
|
placedDateStart: "placedDateStart",
|
|
statuses: "statuses",
|
|
});
|
|
/** Refund a portion of the order, up to the full amount paid. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.orders.refund({
|
|
merchantId: "merchantId",
|
|
orderId: "orderId",
|
|
});
|
|
/** Returns a line item. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.orders.returnlineitem({
|
|
merchantId: "merchantId",
|
|
orderId: "orderId",
|
|
});
|
|
/** Marks line item(s) as shipped. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.orders.shiplineitems({
|
|
merchantId: "merchantId",
|
|
orderId: "orderId",
|
|
});
|
|
/** Updates the merchant order ID for a given order. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.orders.updatemerchantorderid({
|
|
merchantId: "merchantId",
|
|
orderId: "orderId",
|
|
});
|
|
/** Updates a shipment's status, carrier, and/or tracking ID. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.orders.updateshipment({
|
|
merchantId: "merchantId",
|
|
orderId: "orderId",
|
|
});
|
|
/** Retrieves, inserts, and deletes multiple products in a single request. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.products.custombatch({
|
|
dryRun: true,
|
|
});
|
|
/** Deletes a product from your Merchant Center account. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.products.delete({
|
|
dryRun: true,
|
|
merchantId: "merchantId",
|
|
productId: "productId",
|
|
});
|
|
/** Retrieves a product from your Merchant Center account. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.products.get({
|
|
merchantId: "merchantId",
|
|
productId: "productId",
|
|
});
|
|
/**
|
|
* Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this
|
|
* method updates that entry. This method can only be called for non-multi-client accounts.
|
|
*/
|
|
await gapi.client.products.insert({
|
|
dryRun: true,
|
|
merchantId: "merchantId",
|
|
});
|
|
/** Lists the products in your Merchant Center account. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.products.list({
|
|
includeInvalidInsertedItems: true,
|
|
maxResults: 2,
|
|
merchantId: "merchantId",
|
|
pageToken: "pageToken",
|
|
});
|
|
/** Gets the statuses of multiple products in a single request. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.productstatuses.custombatch({
|
|
includeAttributes: true,
|
|
});
|
|
/** Gets the status of a product from your Merchant Center account. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.productstatuses.get({
|
|
includeAttributes: true,
|
|
merchantId: "merchantId",
|
|
productId: "productId",
|
|
});
|
|
/** Lists the statuses of the products in your Merchant Center account. This method can only be called for non-multi-client accounts. */
|
|
await gapi.client.productstatuses.list({
|
|
includeAttributes: true,
|
|
includeInvalidInsertedItems: true,
|
|
maxResults: 3,
|
|
merchantId: "merchantId",
|
|
pageToken: "pageToken",
|
|
});
|
|
/** Retrieves and updates the shipping settings of multiple accounts in a single request. */
|
|
await gapi.client.shippingsettings.custombatch({
|
|
dryRun: true,
|
|
});
|
|
/**
|
|
* Retrieves the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the
|
|
* managing account itself for any Merchant Center account, or any sub-account when the managing account is a multi-client account.
|
|
*/
|
|
await gapi.client.shippingsettings.get({
|
|
accountId: "accountId",
|
|
merchantId: "merchantId",
|
|
});
|
|
/** Retrieves supported carriers and carrier services for an account. */
|
|
await gapi.client.shippingsettings.getsupportedcarriers({
|
|
merchantId: "merchantId",
|
|
});
|
|
/** Lists the shipping settings of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts. */
|
|
await gapi.client.shippingsettings.list({
|
|
maxResults: 1,
|
|
merchantId: "merchantId",
|
|
pageToken: "pageToken",
|
|
});
|
|
/**
|
|
* Updates the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing
|
|
* account itself for any Merchant Center account, or any sub-account when the managing account is a multi-client account. This method supports patch
|
|
* semantics.
|
|
*/
|
|
await gapi.client.shippingsettings.patch({
|
|
accountId: "accountId",
|
|
dryRun: true,
|
|
merchantId: "merchantId",
|
|
});
|
|
/**
|
|
* Updates the shipping settings of the account. This method can only be called for accounts to which the managing account has access: either the managing
|
|
* account itself for any Merchant Center account, or any sub-account when the managing account is a multi-client account.
|
|
*/
|
|
await gapi.client.shippingsettings.update({
|
|
accountId: "accountId",
|
|
dryRun: true,
|
|
merchantId: "merchantId",
|
|
});
|
|
}
|
|
});
|