Class v1.OnlineReturnPolicyServiceClient (3.2.0)

3.2.0 (latest) 2.2.0 1.0.0

The service facilitates the management of a business's remorse return policy configuration, encompassing return policies for both ads and free listings ## programs. This API defines the following resource model:

v1

Package

@google-shopping/accounts

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of OnlineReturnPolicyServiceClient.

Parameters
Name	Description
opts	ClientOptions
gaxInstance	typeof gax | typeof fallback : loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new OnlineReturnPolicyServiceClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

onlineReturnPolicyServiceStub

onlineReturnPolicyServiceStub?: Promise<{
        [name: string]: Function;
    }>;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

accountIssuePath(account, issue)

accountIssuePath(account: string, issue: string): string;

Return a fully-qualified accountIssue resource name string.

Parameters
Name	Description
account	string
issue	string

Returns
Type	Description
string	{string} Resource name string.

accountPath(account)

accountPath(account: string): string;

Return a fully-qualified account resource name string.

Parameter
Name	Description
account	string

Returns
Type	Description
string	{string} Resource name string.

accountRelationshipPath(account, relationship)

accountRelationshipPath(account: string, relationship: string): string;

Return a fully-qualified accountRelationship resource name string.

Parameters
Name	Description
account	string
relationship	string

Returns
Type	Description
string	{string} Resource name string.

accountServicePath(account, service)

accountServicePath(account: string, service: string): string;

Return a fully-qualified accountService resource name string.

Parameters
Name	Description
account	string
service	string

Returns
Type	Description
string	{string} Resource name string.

autofeedSettingsPath(account)

autofeedSettingsPath(account: string): string;

Return a fully-qualified autofeedSettings resource name string.

Parameter
Name	Description
account	string

Returns
Type	Description
string	{string} Resource name string.

automaticImprovementsPath(account)

automaticImprovementsPath(account: string): string;

Return a fully-qualified automaticImprovements resource name string.

Parameter
Name	Description
account	string

Returns
Type	Description
string	{string} Resource name string.

businessIdentityPath(account)

businessIdentityPath(account: string): string;

Return a fully-qualified businessIdentity resource name string.

Parameter
Name	Description
account	string

Returns
Type	Description
string	{string} Resource name string.

businessInfoPath(account)

businessInfoPath(account: string): string;

Return a fully-qualified businessInfo resource name string.

Parameter
Name	Description
account	string

Returns
Type	Description
string	{string} Resource name string.

checkoutSettingsPath(account, program)

checkoutSettingsPath(account: string, program: string): string;

Return a fully-qualified checkoutSettings resource name string.

Parameters
Name	Description
account	string
program	string

Returns
Type	Description
string	{string} Resource name string.

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

createOnlineReturnPolicy(request, options)

createOnlineReturnPolicy(request?: protos.google.shopping.merchant.accounts.v1.ICreateOnlineReturnPolicyRequest, options?: CallOptions): Promise<[
        protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy,
        protos.google.shopping.merchant.accounts.v1.ICreateOnlineReturnPolicyRequest | undefined,
        {} | undefined
    ]>;

Creates a new return policy for a given business.

Parameters
Name	Description
request	ICreateOnlineReturnPolicyRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy, protos.google.shopping.merchant.accounts.v1.ICreateOnlineReturnPolicyRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Merchant Center account for which the return policy will be
   *  created. Format: `accounts/{account}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The return policy object to create.
   */
  // const onlineReturnPolicy = {}

  // Imports the Accounts library
  const {OnlineReturnPolicyServiceClient} = require('@google-shopping/accounts').v1;

  // Instantiates a client
  const accountsClient = new OnlineReturnPolicyServiceClient();

  async function callCreateOnlineReturnPolicy() {
    // Construct request
    const request = {
      parent,
      onlineReturnPolicy,
    };

    // Run request
    const response = await accountsClient.createOnlineReturnPolicy(request);
    console.log(response);
  }

  callCreateOnlineReturnPolicy();

createOnlineReturnPolicy(request, options, callback)

createOnlineReturnPolicy(request: protos.google.shopping.merchant.accounts.v1.ICreateOnlineReturnPolicyRequest, options: CallOptions, callback: Callback<protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy, protos.google.shopping.merchant.accounts.v1.ICreateOnlineReturnPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateOnlineReturnPolicyRequest
options	CallOptions
callback	Callback<protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy, protos.google.shopping.merchant.accounts.v1.ICreateOnlineReturnPolicyRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createOnlineReturnPolicy(request, callback)

createOnlineReturnPolicy(request: protos.google.shopping.merchant.accounts.v1.ICreateOnlineReturnPolicyRequest, callback: Callback<protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy, protos.google.shopping.merchant.accounts.v1.ICreateOnlineReturnPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateOnlineReturnPolicyRequest
callback	Callback<protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy, protos.google.shopping.merchant.accounts.v1.ICreateOnlineReturnPolicyRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteOnlineReturnPolicy(request, options)

deleteOnlineReturnPolicy(request?: protos.google.shopping.merchant.accounts.v1.IDeleteOnlineReturnPolicyRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.shopping.merchant.accounts.v1.IDeleteOnlineReturnPolicyRequest | undefined,
        {} | undefined
    ]>;

Deletes an existing return policy.

Parameters
Name	Description
request	IDeleteOnlineReturnPolicyRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.protobuf.IEmpty, protos.google.shopping.merchant.accounts.v1.IDeleteOnlineReturnPolicyRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the return policy to delete.
   *  Format: `accounts/{account}/onlineReturnPolicies/{return_policy}`
   */
  // const name = 'abc123'

  // Imports the Accounts library
  const {OnlineReturnPolicyServiceClient} = require('@google-shopping/accounts').v1;

  // Instantiates a client
  const accountsClient = new OnlineReturnPolicyServiceClient();

  async function callDeleteOnlineReturnPolicy() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await accountsClient.deleteOnlineReturnPolicy(request);
    console.log(response);
  }

  callDeleteOnlineReturnPolicy();

deleteOnlineReturnPolicy(request, options, callback)

deleteOnlineReturnPolicy(request: protos.google.shopping.merchant.accounts.v1.IDeleteOnlineReturnPolicyRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.shopping.merchant.accounts.v1.IDeleteOnlineReturnPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteOnlineReturnPolicyRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.shopping.merchant.accounts.v1.IDeleteOnlineReturnPolicyRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteOnlineReturnPolicy(request, callback)

deleteOnlineReturnPolicy(request: protos.google.shopping.merchant.accounts.v1.IDeleteOnlineReturnPolicyRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.shopping.merchant.accounts.v1.IDeleteOnlineReturnPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteOnlineReturnPolicyRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.shopping.merchant.accounts.v1.IDeleteOnlineReturnPolicyRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

developerRegistrationPath(account)

developerRegistrationPath(account: string): string;

Return a fully-qualified developerRegistration resource name string.

Parameter
Name	Description
account	string

Returns
Type	Description
string	{string} Resource name string.

emailPreferencesPath(account, email)

emailPreferencesPath(account: string, email: string): string;

Return a fully-qualified emailPreferences resource name string.

Parameters
Name	Description
account	string
email	string

Returns
Type	Description
string	{string} Resource name string.

gbpAccountPath(account, gbpAccount)

gbpAccountPath(account: string, gbpAccount: string): string;

Return a fully-qualified gbpAccount resource name string.

Parameters
Name	Description
account	string
gbpAccount	string

Returns
Type	Description
string	{string} Resource name string.

getOnlineReturnPolicy(request, options)

getOnlineReturnPolicy(request?: protos.google.shopping.merchant.accounts.v1.IGetOnlineReturnPolicyRequest, options?: CallOptions): Promise<[
        protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy,
        protos.google.shopping.merchant.accounts.v1.IGetOnlineReturnPolicyRequest | undefined,
        {} | undefined
    ]>;

Gets an existing return policy for a given business.

Parameters
Name	Description
request	IGetOnlineReturnPolicyRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy, protos.google.shopping.merchant.accounts.v1.IGetOnlineReturnPolicyRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the return policy to retrieve.
   *  Format: `accounts/{account}/onlineReturnPolicies/{return_policy}`
   */
  // const name = 'abc123'

  // Imports the Accounts library
  const {OnlineReturnPolicyServiceClient} = require('@google-shopping/accounts').v1;

  // Instantiates a client
  const accountsClient = new OnlineReturnPolicyServiceClient();

  async function callGetOnlineReturnPolicy() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await accountsClient.getOnlineReturnPolicy(request);
    console.log(response);
  }

  callGetOnlineReturnPolicy();

getOnlineReturnPolicy(request, options, callback)

getOnlineReturnPolicy(request: protos.google.shopping.merchant.accounts.v1.IGetOnlineReturnPolicyRequest, options: CallOptions, callback: Callback<protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy, protos.google.shopping.merchant.accounts.v1.IGetOnlineReturnPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetOnlineReturnPolicyRequest
options	CallOptions
callback	Callback<protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy, protos.google.shopping.merchant.accounts.v1.IGetOnlineReturnPolicyRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getOnlineReturnPolicy(request, callback)

getOnlineReturnPolicy(request: protos.google.shopping.merchant.accounts.v1.IGetOnlineReturnPolicyRequest, callback: Callback<protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy, protos.google.shopping.merchant.accounts.v1.IGetOnlineReturnPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetOnlineReturnPolicyRequest
callback	Callback<protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy, protos.google.shopping.merchant.accounts.v1.IGetOnlineReturnPolicyRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter
Name	Description
callback	Callback<string, undefined, undefined>

Returns
Type	Description
void

homepagePath(account)

homepagePath(account: string): string;

Return a fully-qualified homepage resource name string.

Parameter
Name	Description
account	string

Returns
Type	Description
string	{string} Resource name string.

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

lfpProviderPath(account, omnichannelSetting, lfpProvider)

lfpProviderPath(account: string, omnichannelSetting: string, lfpProvider: string): string;

Return a fully-qualified lfpProvider resource name string.

Parameters
Name	Description
account	string
omnichannelSetting	string
lfpProvider	string

Returns
Type	Description
string	{string} Resource name string.

listOnlineReturnPolicies(request, options)

listOnlineReturnPolicies(request?: protos.google.shopping.merchant.accounts.v1.IListOnlineReturnPoliciesRequest, options?: CallOptions): Promise<[
        protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy[],
        protos.google.shopping.merchant.accounts.v1.IListOnlineReturnPoliciesRequest | null,
        protos.google.shopping.merchant.accounts.v1.IListOnlineReturnPoliciesResponse
    ]>;

Lists all existing return policies for a given business.

Parameters
Name	Description
request	IListOnlineReturnPoliciesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy[], protos.google.shopping.merchant.accounts.v1.IListOnlineReturnPoliciesRequest | null, protos.google.shopping.merchant.accounts.v1.IListOnlineReturnPoliciesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listOnlineReturnPoliciesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listOnlineReturnPolicies(request, options, callback)

listOnlineReturnPolicies(request: protos.google.shopping.merchant.accounts.v1.IListOnlineReturnPoliciesRequest, options: CallOptions, callback: PaginationCallback<protos.google.shopping.merchant.accounts.v1.IListOnlineReturnPoliciesRequest, protos.google.shopping.merchant.accounts.v1.IListOnlineReturnPoliciesResponse | null | undefined, protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy>): void;

Parameters
Name	Description
request	IListOnlineReturnPoliciesRequest
options	CallOptions
callback	PaginationCallback<protos.google.shopping.merchant.accounts.v1.IListOnlineReturnPoliciesRequest, protos.google.shopping.merchant.accounts.v1.IListOnlineReturnPoliciesResponse | null | undefined, protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy>

Returns
Type	Description
void

listOnlineReturnPolicies(request, callback)

listOnlineReturnPolicies(request: protos.google.shopping.merchant.accounts.v1.IListOnlineReturnPoliciesRequest, callback: PaginationCallback<protos.google.shopping.merchant.accounts.v1.IListOnlineReturnPoliciesRequest, protos.google.shopping.merchant.accounts.v1.IListOnlineReturnPoliciesResponse | null | undefined, protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy>): void;

Parameters
Name	Description
request	IListOnlineReturnPoliciesRequest
callback	PaginationCallback<protos.google.shopping.merchant.accounts.v1.IListOnlineReturnPoliciesRequest, protos.google.shopping.merchant.accounts.v1.IListOnlineReturnPoliciesResponse | null | undefined, protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy>

Returns
Type	Description
void

listOnlineReturnPoliciesAsync(request, options)

listOnlineReturnPoliciesAsync(request?: protos.google.shopping.merchant.accounts.v1.IListOnlineReturnPoliciesRequest, options?: CallOptions): AsyncIterable<protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy>;

Equivalent to listOnlineReturnPolicies, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListOnlineReturnPoliciesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.shopping.merchant.accounts.v1.IOnlineReturnPolicy>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Merchant Center account for which to list return policies.
   *  Format: `accounts/{account}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of `OnlineReturnPolicy` resources to return.
   *  The service returns fewer than this value if the number of return policies
   *  for the given business is less that than the `pageSize`. The default value
   *  is 10. The maximum value is 100; If a value higher than the maximum is
   *  specified, then the `pageSize` will default to the maximum
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous `ListOnlineReturnPolicies`
   *  call. Provide the page token to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListOnlineReturnPolicies` must match the call that provided the page
   *  token. The token returned as
   *  nextPageToken google.shopping.merchant.accounts.v1.ListOnlineReturnPoliciesResponse.next_page_token 
   *  in the response to the previous request.
   */
  // const pageToken = 'abc123'

  // Imports the Accounts library
  const {OnlineReturnPolicyServiceClient} = require('@google-shopping/accounts').v1;

  // Instantiates a client
  const accountsClient = new OnlineReturnPolicyServiceClient();

  async function callListOnlineReturnPolicies() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = accountsClient.listOnlineReturnPoliciesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListOnlineReturnPolicies();

listOnlineReturnPoliciesStream(request, options)

listOnlineReturnPoliciesStream(request?: protos.google.shopping.merchant.accounts.v1.IListOnlineReturnPoliciesRequest, options?: CallOptions): Transform;

Equivalent to listOnlineReturnPolicies, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListOnlineReturnPoliciesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listOnlineReturnPoliciesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchAccountFromAccountIssueName(accountIssueName)

matchAccountFromAccountIssueName(accountIssueName: string): string | number;

Parse the account from AccountIssue resource.

Parameter
Name	Description
accountIssueName	string A fully-qualified path representing AccountIssue resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromAccountName(accountName)

matchAccountFromAccountName(accountName: string): string | number;

Parse the account from Account resource.

Parameter
Name	Description
accountName	string A fully-qualified path representing Account resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromAccountRelationshipName(accountRelationshipName)

matchAccountFromAccountRelationshipName(accountRelationshipName: string): string | number;

Parse the account from AccountRelationship resource.

Parameter
Name	Description
accountRelationshipName	string A fully-qualified path representing AccountRelationship resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromAccountServiceName(accountServiceName)

matchAccountFromAccountServiceName(accountServiceName: string): string | number;

Parse the account from AccountService resource.

Parameter
Name	Description
accountServiceName	string A fully-qualified path representing AccountService resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromAutofeedSettingsName(autofeedSettingsName)

matchAccountFromAutofeedSettingsName(autofeedSettingsName: string): string | number;

Parse the account from AutofeedSettings resource.

Parameter
Name	Description
autofeedSettingsName	string A fully-qualified path representing AutofeedSettings resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromAutomaticImprovementsName(automaticImprovementsName)

matchAccountFromAutomaticImprovementsName(automaticImprovementsName: string): string | number;

Parse the account from AutomaticImprovements resource.

Parameter
Name	Description
automaticImprovementsName	string A fully-qualified path representing AutomaticImprovements resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromBusinessIdentityName(businessIdentityName)

matchAccountFromBusinessIdentityName(businessIdentityName: string): string | number;

Parse the account from BusinessIdentity resource.

Parameter
Name	Description
businessIdentityName	string A fully-qualified path representing BusinessIdentity resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromBusinessInfoName(businessInfoName)

matchAccountFromBusinessInfoName(businessInfoName: string): string | number;

Parse the account from BusinessInfo resource.

Parameter
Name	Description
businessInfoName	string A fully-qualified path representing BusinessInfo resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromCheckoutSettingsName(checkoutSettingsName)

matchAccountFromCheckoutSettingsName(checkoutSettingsName: string): string | number;

Parse the account from CheckoutSettings resource.

Parameter
Name	Description
checkoutSettingsName	string A fully-qualified path representing CheckoutSettings resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromDeveloperRegistrationName(developerRegistrationName)

matchAccountFromDeveloperRegistrationName(developerRegistrationName: string): string | number;

Parse the account from DeveloperRegistration resource.

Parameter
Name	Description
developerRegistrationName	string A fully-qualified path representing DeveloperRegistration resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromEmailPreferencesName(emailPreferencesName)

matchAccountFromEmailPreferencesName(emailPreferencesName: string): string | number;

Parse the account from EmailPreferences resource.

Parameter
Name	Description
emailPreferencesName	string A fully-qualified path representing EmailPreferences resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromGbpAccountName(gbpAccountName)

matchAccountFromGbpAccountName(gbpAccountName: string): string | number;

Parse the account from GbpAccount resource.

Parameter
Name	Description
gbpAccountName	string A fully-qualified path representing GbpAccount resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromHomepageName(homepageName)

matchAccountFromHomepageName(homepageName: string): string | number;

Parse the account from Homepage resource.

Parameter
Name	Description
homepageName	string A fully-qualified path representing Homepage resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromLfpProviderName(lfpProviderName)

matchAccountFromLfpProviderName(lfpProviderName: string): string | number;

Parse the account from LfpProvider resource.

Parameter
Name	Description
lfpProviderName	string A fully-qualified path representing LfpProvider resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromOmnichannelSettingName(omnichannelSettingName)

matchAccountFromOmnichannelSettingName(omnichannelSettingName: string): string | number;

Parse the account from OmnichannelSetting resource.

Parameter
Name	Description
omnichannelSettingName	string A fully-qualified path representing OmnichannelSetting resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromOnlineReturnPolicyName(onlineReturnPolicyName)

matchAccountFromOnlineReturnPolicyName(onlineReturnPolicyName: string): string | number;

Parse the account from OnlineReturnPolicy resource.

Parameter
Name	Description
onlineReturnPolicyName	string A fully-qualified path representing OnlineReturnPolicy resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromProgramName(programName)

matchAccountFromProgramName(programName: string): string | number;

Parse the account from Program resource.

Parameter
Name	Description
programName	string A fully-qualified path representing Program resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromRegionName(regionName)

matchAccountFromRegionName(regionName: string): string | number;

Parse the account from Region resource.

Parameter
Name	Description
regionName	string A fully-qualified path representing Region resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromShippingSettingsName(shippingSettingsName)

matchAccountFromShippingSettingsName(shippingSettingsName: string): string | number;

Parse the account from ShippingSettings resource.

Parameter
Name	Description
shippingSettingsName	string A fully-qualified path representing ShippingSettings resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromTermsOfServiceAgreementStateName(termsOfServiceAgreementStateName)

matchAccountFromTermsOfServiceAgreementStateName(termsOfServiceAgreementStateName: string): string | number;

Parse the account from TermsOfServiceAgreementState resource.

Parameter
Name	Description
termsOfServiceAgreementStateName	string A fully-qualified path representing TermsOfServiceAgreementState resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromUserName(userName)

matchAccountFromUserName(userName: string): string | number;

Parse the account from User resource.

Parameter
Name	Description
userName	string A fully-qualified path representing User resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchEmailFromEmailPreferencesName(emailPreferencesName)

matchEmailFromEmailPreferencesName(emailPreferencesName: string): string | number;

Parse the email from EmailPreferences resource.

Parameter
Name	Description
emailPreferencesName	string A fully-qualified path representing EmailPreferences resource.

Returns
Type	Description
string | number	{string} A string representing the email.

matchEmailFromUserName(userName)

matchEmailFromUserName(userName: string): string | number;

Parse the email from User resource.

Parameter
Name	Description
userName	string A fully-qualified path representing User resource.

Returns
Type	Description
string | number	{string} A string representing the email.

matchGbpAccountFromGbpAccountName(gbpAccountName)

matchGbpAccountFromGbpAccountName(gbpAccountName: string): string | number;

Parse the gbp_account from GbpAccount resource.

Parameter
Name	Description
gbpAccountName	string A fully-qualified path representing GbpAccount resource.

Returns
Type	Description
string | number	{string} A string representing the gbp_account.

matchIdentifierFromTermsOfServiceAgreementStateName(termsOfServiceAgreementStateName)

matchIdentifierFromTermsOfServiceAgreementStateName(termsOfServiceAgreementStateName: string): string | number;

Parse the identifier from TermsOfServiceAgreementState resource.

Parameter
Name	Description
termsOfServiceAgreementStateName	string A fully-qualified path representing TermsOfServiceAgreementState resource.

Returns
Type	Description
string | number	{string} A string representing the identifier.

matchIssueFromAccountIssueName(accountIssueName)

matchIssueFromAccountIssueName(accountIssueName: string): string | number;

Parse the issue from AccountIssue resource.

Parameter
Name	Description
accountIssueName	string A fully-qualified path representing AccountIssue resource.

Returns
Type	Description
string | number	{string} A string representing the issue.

matchLfpProviderFromLfpProviderName(lfpProviderName)

matchLfpProviderFromLfpProviderName(lfpProviderName: string): string | number;

Parse the lfp_provider from LfpProvider resource.

Parameter
Name	Description
lfpProviderName	string A fully-qualified path representing LfpProvider resource.

Returns
Type	Description
string | number	{string} A string representing the lfp_provider.

matchOmnichannelSettingFromLfpProviderName(lfpProviderName)

matchOmnichannelSettingFromLfpProviderName(lfpProviderName: string): string | number;

Parse the omnichannel_setting from LfpProvider resource.

Parameter
Name	Description
lfpProviderName	string A fully-qualified path representing LfpProvider resource.

Returns
Type	Description
string | number	{string} A string representing the omnichannel_setting.

matchOmnichannelSettingFromOmnichannelSettingName(omnichannelSettingName)

matchOmnichannelSettingFromOmnichannelSettingName(omnichannelSettingName: string): string | number;

Parse the omnichannel_setting from OmnichannelSetting resource.

Parameter
Name	Description
omnichannelSettingName	string A fully-qualified path representing OmnichannelSetting resource.

Returns
Type	Description
string | number	{string} A string representing the omnichannel_setting.

matchProgramFromCheckoutSettingsName(checkoutSettingsName)

matchProgramFromCheckoutSettingsName(checkoutSettingsName: string): string | number;

Parse the program from CheckoutSettings resource.

Parameter
Name	Description
checkoutSettingsName	string A fully-qualified path representing CheckoutSettings resource.

Returns
Type	Description
string | number	{string} A string representing the program.

matchProgramFromProgramName(programName)

matchProgramFromProgramName(programName: string): string | number;

Parse the program from Program resource.

Parameter
Name	Description
programName	string A fully-qualified path representing Program resource.

Returns
Type	Description
string | number	{string} A string representing the program.

matchRegionFromRegionName(regionName)

matchRegionFromRegionName(regionName: string): string | number;

Parse the region from Region resource.

Parameter
Name	Description
regionName	string A fully-qualified path representing Region resource.

Returns
Type	Description
string | number	{string} A string representing the region.

matchRelationshipFromAccountRelationshipName(accountRelationshipName)

matchRelationshipFromAccountRelationshipName(accountRelationshipName: string): string | number;

Parse the relationship from AccountRelationship resource.

Parameter
Name	Description
accountRelationshipName	string A fully-qualified path representing AccountRelationship resource.

Returns
Type	Description
string | number	{string} A string representing the relationship.

matchReturnPolicyFromOnlineReturnPolicyName(onlineReturnPolicyName)

matchReturnPolicyFromOnlineReturnPolicyName(onlineReturnPolicyName: string): string | number;

Parse the return_policy from OnlineReturnPolicy resource.

Parameter
Name	Description
onlineReturnPolicyName	string A fully-qualified path representing OnlineReturnPolicy resource.

Returns
Type	Description
string | number	{string} A string representing the return_policy.

matchServiceFromAccountServiceName(accountServiceName)

matchServiceFromAccountServiceName(accountServiceName: string): string | number;

Parse the service from AccountService resource.

Parameter
Name	Description
accountServiceName	string A fully-qualified path representing AccountService resource.

Returns
Type	Description
string | number	{string} A string representing the service.

matchVersionFromTermsOfServiceName(termsOfServiceName)

matchVersionFromTermsOfServiceName(termsOfServiceName: string): string | number;

Parse the version from TermsOfService resource.

Parameter
Name	Description
termsOfServiceName	string A fully-qualified path representing TermsOfService resource.

Returns
Type	Description
string | number	{string} A string representing the version.

omnichannelSettingPath(account, omnichannelSetting)

omnichannelSettingPath(account: string, omnichannelSetting: string): string;

Return a fully-qualified omnichannelSetting resource name string.

Parameters
Name	Description
account	string
omnichannelSetting	string

Returns
Type	Description
string	{string} Resource name string.

onlineReturnPolicyPath(account, returnPolicy)

onlineReturnPolicyPath(account: string, returnPolicy: string): string;

Return a fully-qualified onlineReturnPolicy resource name string.

Parameters
Name	Description
account	string
returnPolicy	string

Returns
Type	Description
string	{string} Resource name string.

programPath(account, program)

programPath(account: string, program: string): string;

Return a fully-qualified program resource name string.

Parameters
Name	Description
account	string
program	string

Returns
Type	Description
string	{string} Resource name string.

regionPath(account, region)

regionPath(account: string, region: string): string;

Return a fully-qualified region resource name string.

Parameters
Name	Description
account	string
region	string

Returns
Type	Description
string	{string} Resource name string.

shippingSettingsPath(account)

shippingSettingsPath(account: string): string;

Return a fully-qualified shippingSettings resource name string.

Parameter
Name	Description
account	string

Returns
Type	Description
string	{string} Resource name string.

termsOfServiceAgreementStatePath(account, identifier)

termsOfServiceAgreementStatePath(account: string, identifier: string): string;

Return a fully-qualified termsOfServiceAgreementState resource name string.

Parameters
Name	Description
account	string
identifier	string

Returns
Type	Description
string	{string} Resource name string.

termsOfServicePath(version)

termsOfServicePath(version: string): string;

Return a fully-qualified termsOfService resource name string.

Parameter
Name	Description
version	string

Returns
Type	Description
string	{string} Resource name string.

userPath(account, email)

userPath(account: string, email: string): string;

Return a fully-qualified user resource name string.

Parameters
Name	Description
account	string
email	string

Returns
Type	Description
string	{string} Resource name string.