google-apis-merchantapi_accounts_v1beta 0.12.0 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -82,11 +82,12 @@ module Google
82
82
  execute_or_queue_command(command, &block)
83
83
  end
84
84
 
85
- # Deletes the specified account regardless of its type: standalone, MCA or sub-
86
- # account. Deleting an MCA leads to the deletion of all of its sub-accounts.
87
- # Executing this method requires admin access. The deletion succeeds only if the
88
- # account does not provide services to any other account and has no processed
89
- # offers. You can use the `force` parameter to override this.
85
+ # Deletes the specified account regardless of its type: standalone, advanced
86
+ # account or sub-account. Deleting an advanced account leads to the deletion of
87
+ # all of its sub-accounts. Executing this method requires admin access. The
88
+ # deletion succeeds only if the account does not provide services to any other
89
+ # account and has no processed offers. You can use the `force` parameter to
90
+ # override this.
90
91
  # @param [String] name
91
92
  # Required. The name of the account to delete. Format: `accounts/`account``
92
93
  # @param [Boolean] force
@@ -152,17 +153,10 @@ module Google
152
153
  execute_or_queue_command(command, &block)
153
154
  end
154
155
 
155
- # Lists accounts accessible to the calling user and matching the constraints of
156
- # the request such as page size or filters. This is not just listing the sub-
157
- # accounts of an MCA, but all accounts the calling user has access to including
158
- # other MCAs, linked accounts, standalone accounts and so on. If no filter is
159
- # provided, then it returns all the accounts the user has access to. This method
160
- # is eventually consistent, meaning changes such as creating, updating an
161
- # account or a change of relationships between accounts may not show up in the
162
- # results immediately. Instead, these changes propagate over a short period,
163
- # after which the updated information can match the associated predicates. That
164
- # means, that searching by account name might not return a recently changed
165
- # account even though it satisfies the predicate.
156
+ # Note: For the `accounts.list` method, quota and limits usage are charged for
157
+ # each user, and not for the Merchant Center ID or the advanced account ID. To
158
+ # list several sub-accounts, you should use the `accounts.listSubaccounts`
159
+ # method, which is more suitable for advanced accounts use case.
166
160
  # @param [String] filter
167
161
  # Optional. Returns only accounts that match the [filter](https://developers.
168
162
  # google.com/merchant/api/guides/accounts/filter). For more details, see the [
@@ -248,8 +242,8 @@ module Google
248
242
  execute_or_queue_command(command, &block)
249
243
  end
250
244
 
251
- # Updates an account regardless of its type: standalone, MCA or sub-account.
252
- # Executing this method requires admin access.
245
+ # Updates an account regardless of its type: standalone, advanced account or sub-
246
+ # account. Executing this method requires admin access.
253
247
  # @param [String] name
254
248
  # Identifier. The resource name of the account. Format: `accounts/`account``
255
249
  # @param [Google::Apis::MerchantapiAccountsV1beta::Account] account_object
@@ -430,7 +424,7 @@ module Google
430
424
  # Retrieves the business identity of an account.
431
425
  # @param [String] name
432
426
  # Required. The resource name of the business identity. Format: `accounts/`
433
- # account`/businessIdentity`
427
+ # account`/businessIdentity`. For example, `accounts/123456/businessIdentity`.
434
428
  # @param [String] fields
435
429
  # Selector specifying which fields to include in a partial response.
436
430
  # @param [String] quota_user
@@ -501,7 +495,7 @@ module Google
501
495
  # Retrieves the business info of an account.
502
496
  # @param [String] name
503
497
  # Required. The resource name of the business info. Format: `accounts/`account`/
504
- # businessInfo`
498
+ # businessInfo`. For example, `accounts/123456/businessInfo`.
505
499
  # @param [String] fields
506
500
  # Selector specifying which fields to include in a partial response.
507
501
  # @param [String] quota_user
@@ -603,12 +597,12 @@ module Google
603
597
  execute_or_queue_command(command, &block)
604
598
  end
605
599
 
606
- # Updates the email preferences for a Merchant Center account user. MCA users
607
- # should specify the MCA account rather than a sub-account of the MCA.
608
- # Preferences which are not explicitly selected in the update mask will not be
609
- # updated. It is invalid for updates to specify an UNCONFIRMED opt-in status
610
- # value. Use the name=accounts/*/users/me/emailPreferences alias to update
611
- # preferences for the authenticated user.
600
+ # Updates the email preferences for a Merchant Center account user. Advanced
601
+ # account users should specify the advanced account rather than a sub-account of
602
+ # the advanced account. Preferences which are not explicitly selected in the
603
+ # update mask will not be updated. It is invalid for updates to specify an
604
+ # UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/
605
+ # emailPreferences alias to update preferences for the authenticated user.
612
606
  # @param [String] name
613
607
  # Identifier. The name of the EmailPreferences. The endpoint is only supported
614
608
  # for the authenticated user.
@@ -646,9 +640,90 @@ module Google
646
640
  execute_or_queue_command(command, &block)
647
641
  end
648
642
 
643
+ # Link the specified merchant to a GBP account for all countries. To run this
644
+ # method, you must have admin access to the Merchant Center account. If you don'
645
+ # t have admin access, the request fails with the error message `User is not an
646
+ # administrator of account `ACCOUNT_ID``.
647
+ # @param [String] parent
648
+ # Required. The name of the parent resource to which the GBP account is linked.
649
+ # Format: `accounts/`account``.
650
+ # @param [Google::Apis::MerchantapiAccountsV1beta::LinkGbpAccountRequest] link_gbp_account_request_object
651
+ # @param [String] fields
652
+ # Selector specifying which fields to include in a partial response.
653
+ # @param [String] quota_user
654
+ # Available to use for quota purposes for server-side applications. Can be any
655
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
656
+ # @param [Google::Apis::RequestOptions] options
657
+ # Request-specific options
658
+ #
659
+ # @yield [result, err] Result & error if block supplied
660
+ # @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::LinkGbpAccountResponse] parsed result object
661
+ # @yieldparam err [StandardError] error object if request failed
662
+ #
663
+ # @return [Google::Apis::MerchantapiAccountsV1beta::LinkGbpAccountResponse]
664
+ #
665
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
666
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
667
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
668
+ def link_gbp_account(parent, link_gbp_account_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
669
+ command = make_simple_command(:post, 'accounts/v1beta/{+parent}/gbpAccounts:linkGbpAccount', options)
670
+ command.request_representation = Google::Apis::MerchantapiAccountsV1beta::LinkGbpAccountRequest::Representation
671
+ command.request_object = link_gbp_account_request_object
672
+ command.response_representation = Google::Apis::MerchantapiAccountsV1beta::LinkGbpAccountResponse::Representation
673
+ command.response_class = Google::Apis::MerchantapiAccountsV1beta::LinkGbpAccountResponse
674
+ command.params['parent'] = parent unless parent.nil?
675
+ command.query['fields'] = fields unless fields.nil?
676
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
677
+ execute_or_queue_command(command, &block)
678
+ end
679
+
680
+ # List the GBP accounts for a given merchant.
681
+ # @param [String] parent
682
+ # Required. The name of the parent resource under which the GBP accounts are
683
+ # listed. Format: `accounts/`account``.
684
+ # @param [Fixnum] page_size
685
+ # Optional. The maximum number of `GbpAccount` resources to return. The service
686
+ # returns fewer than this value if the number of gbp accounts is less that than
687
+ # the `pageSize`. The default value is 50. The maximum value is 1000; If a value
688
+ # higher than the maximum is specified, then the `pageSize` will default to the
689
+ # maximum.
690
+ # @param [String] page_token
691
+ # Optional. A page token, received from a previous `ListGbpAccounts` call.
692
+ # Provide the page token to retrieve the subsequent page. When paginating, all
693
+ # other parameters provided to `ListGbpAccounts` must match the call that
694
+ # provided the page token.
695
+ # @param [String] fields
696
+ # Selector specifying which fields to include in a partial response.
697
+ # @param [String] quota_user
698
+ # Available to use for quota purposes for server-side applications. Can be any
699
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
700
+ # @param [Google::Apis::RequestOptions] options
701
+ # Request-specific options
702
+ #
703
+ # @yield [result, err] Result & error if block supplied
704
+ # @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::ListGbpAccountsResponse] parsed result object
705
+ # @yieldparam err [StandardError] error object if request failed
706
+ #
707
+ # @return [Google::Apis::MerchantapiAccountsV1beta::ListGbpAccountsResponse]
708
+ #
709
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
710
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
711
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
712
+ def list_account_gbp_accounts(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
713
+ command = make_simple_command(:get, 'accounts/v1beta/{+parent}/gbpAccounts', options)
714
+ command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ListGbpAccountsResponse::Representation
715
+ command.response_class = Google::Apis::MerchantapiAccountsV1beta::ListGbpAccountsResponse
716
+ command.params['parent'] = parent unless parent.nil?
717
+ command.query['pageSize'] = page_size unless page_size.nil?
718
+ command.query['pageToken'] = page_token unless page_token.nil?
719
+ command.query['fields'] = fields unless fields.nil?
720
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
721
+ execute_or_queue_command(command, &block)
722
+ end
723
+
649
724
  # Claims a store's homepage. Executing this method requires admin access. If the
650
725
  # homepage is already claimed, this will recheck the verification (unless the
651
- # merchant is exempted from claiming, which also exempts from verification) and
726
+ # business is exempted from claiming, which also exempts from verification) and
652
727
  # return a successful response. If ownership can no longer be verified, it will
653
728
  # return an error, but it won't clear the claim. In case of failure, a canonical
654
729
  # error message is returned: * PERMISSION_DENIED: User doesn't have the
@@ -848,7 +923,334 @@ module Google
848
923
  execute_or_queue_command(command, &block)
849
924
  end
850
925
 
851
- # Gets an existing return policy for a given merchant.
926
+ # Create the omnichannel settings for a given merchant.
927
+ # @param [String] parent
928
+ # Required. The parent resource where this omnichannel setting will be created.
929
+ # Format: `accounts/`account``
930
+ # @param [Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting] omnichannel_setting_object
931
+ # @param [String] fields
932
+ # Selector specifying which fields to include in a partial response.
933
+ # @param [String] quota_user
934
+ # Available to use for quota purposes for server-side applications. Can be any
935
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
936
+ # @param [Google::Apis::RequestOptions] options
937
+ # Request-specific options
938
+ #
939
+ # @yield [result, err] Result & error if block supplied
940
+ # @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting] parsed result object
941
+ # @yieldparam err [StandardError] error object if request failed
942
+ #
943
+ # @return [Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting]
944
+ #
945
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
946
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
947
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
948
+ def create_account_omnichannel_setting(parent, omnichannel_setting_object = nil, fields: nil, quota_user: nil, options: nil, &block)
949
+ command = make_simple_command(:post, 'accounts/v1beta/{+parent}/omnichannelSettings', options)
950
+ command.request_representation = Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting::Representation
951
+ command.request_object = omnichannel_setting_object
952
+ command.response_representation = Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting::Representation
953
+ command.response_class = Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting
954
+ command.params['parent'] = parent unless parent.nil?
955
+ command.query['fields'] = fields unless fields.nil?
956
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
957
+ execute_or_queue_command(command, &block)
958
+ end
959
+
960
+ # Get the omnichannel settings for a given merchant.
961
+ # @param [String] name
962
+ # Required. The name of the omnichannel setting to retrieve. Format: `accounts/`
963
+ # account`/omnichannelSettings/`omnichannel_setting``
964
+ # @param [String] fields
965
+ # Selector specifying which fields to include in a partial response.
966
+ # @param [String] quota_user
967
+ # Available to use for quota purposes for server-side applications. Can be any
968
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
969
+ # @param [Google::Apis::RequestOptions] options
970
+ # Request-specific options
971
+ #
972
+ # @yield [result, err] Result & error if block supplied
973
+ # @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting] parsed result object
974
+ # @yieldparam err [StandardError] error object if request failed
975
+ #
976
+ # @return [Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting]
977
+ #
978
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
979
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
980
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
981
+ def get_account_omnichannel_setting(name, fields: nil, quota_user: nil, options: nil, &block)
982
+ command = make_simple_command(:get, 'accounts/v1beta/{+name}', options)
983
+ command.response_representation = Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting::Representation
984
+ command.response_class = Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting
985
+ command.params['name'] = name unless name.nil?
986
+ command.query['fields'] = fields unless fields.nil?
987
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
988
+ execute_or_queue_command(command, &block)
989
+ end
990
+
991
+ # List all the omnichannel settings for a given merchant.
992
+ # @param [String] parent
993
+ # Required. The parent, which owns this collection of omnichannel settings.
994
+ # Format: `accounts/`account``
995
+ # @param [Fixnum] page_size
996
+ # Optional. The maximum number of omnichannel settings to return. The service
997
+ # may return fewer than this value. If unspecified, at most 50 omnichannel
998
+ # settings will be returned. The maximum value is 1000; values above 1000 will
999
+ # be coerced to 1000.
1000
+ # @param [String] page_token
1001
+ # Optional. A page token, received from a previous `ListOmnichannelSettings`
1002
+ # call. Provide this to retrieve the subsequent page. When paginating, all other
1003
+ # parameters provided to `ListOmnichannelSettings` must match the call that
1004
+ # provided the page token.
1005
+ # @param [String] fields
1006
+ # Selector specifying which fields to include in a partial response.
1007
+ # @param [String] quota_user
1008
+ # Available to use for quota purposes for server-side applications. Can be any
1009
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1010
+ # @param [Google::Apis::RequestOptions] options
1011
+ # Request-specific options
1012
+ #
1013
+ # @yield [result, err] Result & error if block supplied
1014
+ # @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::ListOmnichannelSettingsResponse] parsed result object
1015
+ # @yieldparam err [StandardError] error object if request failed
1016
+ #
1017
+ # @return [Google::Apis::MerchantapiAccountsV1beta::ListOmnichannelSettingsResponse]
1018
+ #
1019
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1020
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1021
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1022
+ def list_account_omnichannel_settings(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1023
+ command = make_simple_command(:get, 'accounts/v1beta/{+parent}/omnichannelSettings', options)
1024
+ command.response_representation = Google::Apis::MerchantapiAccountsV1beta::ListOmnichannelSettingsResponse::Representation
1025
+ command.response_class = Google::Apis::MerchantapiAccountsV1beta::ListOmnichannelSettingsResponse
1026
+ command.params['parent'] = parent unless parent.nil?
1027
+ command.query['pageSize'] = page_size unless page_size.nil?
1028
+ command.query['pageToken'] = page_token unless page_token.nil?
1029
+ command.query['fields'] = fields unless fields.nil?
1030
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1031
+ execute_or_queue_command(command, &block)
1032
+ end
1033
+
1034
+ # Update the omnichannel setting for a given merchant in a given country.
1035
+ # @param [String] name
1036
+ # Identifier. The resource name of the omnichannel setting. Format: `accounts/`
1037
+ # account`/omnichannelSettings/`omnichannel_setting``
1038
+ # @param [Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting] omnichannel_setting_object
1039
+ # @param [String] update_mask
1040
+ # Required. The list of fields to be updated. The following fields are supported
1041
+ # in snake_case only: - `lsf_type` - `in_stock` - `pickup` - `odo` - `about` - `
1042
+ # inventory_verification` Full replacement with wildcard `*`is supported, while
1043
+ # empty/implied update mask is not.
1044
+ # @param [String] fields
1045
+ # Selector specifying which fields to include in a partial response.
1046
+ # @param [String] quota_user
1047
+ # Available to use for quota purposes for server-side applications. Can be any
1048
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1049
+ # @param [Google::Apis::RequestOptions] options
1050
+ # Request-specific options
1051
+ #
1052
+ # @yield [result, err] Result & error if block supplied
1053
+ # @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting] parsed result object
1054
+ # @yieldparam err [StandardError] error object if request failed
1055
+ #
1056
+ # @return [Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting]
1057
+ #
1058
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1059
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1060
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1061
+ def patch_account_omnichannel_setting(name, omnichannel_setting_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1062
+ command = make_simple_command(:patch, 'accounts/v1beta/{+name}', options)
1063
+ command.request_representation = Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting::Representation
1064
+ command.request_object = omnichannel_setting_object
1065
+ command.response_representation = Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting::Representation
1066
+ command.response_class = Google::Apis::MerchantapiAccountsV1beta::OmnichannelSetting
1067
+ command.params['name'] = name unless name.nil?
1068
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1069
+ command.query['fields'] = fields unless fields.nil?
1070
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1071
+ execute_or_queue_command(command, &block)
1072
+ end
1073
+
1074
+ # Requests inventory verification for a given merchant in a given country.
1075
+ # @param [String] name
1076
+ # Required. The name of the omnichannel setting to request inventory
1077
+ # verification. Format: `accounts/`account`/omnichannelSettings/`
1078
+ # omnichannel_setting``
1079
+ # @param [Google::Apis::MerchantapiAccountsV1beta::RequestInventoryVerificationRequest] request_inventory_verification_request_object
1080
+ # @param [String] fields
1081
+ # Selector specifying which fields to include in a partial response.
1082
+ # @param [String] quota_user
1083
+ # Available to use for quota purposes for server-side applications. Can be any
1084
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1085
+ # @param [Google::Apis::RequestOptions] options
1086
+ # Request-specific options
1087
+ #
1088
+ # @yield [result, err] Result & error if block supplied
1089
+ # @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::RequestInventoryVerificationResponse] parsed result object
1090
+ # @yieldparam err [StandardError] error object if request failed
1091
+ #
1092
+ # @return [Google::Apis::MerchantapiAccountsV1beta::RequestInventoryVerificationResponse]
1093
+ #
1094
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1095
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1096
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1097
+ def request_omnichannel_setting_inventory_verification(name, request_inventory_verification_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1098
+ command = make_simple_command(:post, 'accounts/v1beta/{+name}:requestInventoryVerification', options)
1099
+ command.request_representation = Google::Apis::MerchantapiAccountsV1beta::RequestInventoryVerificationRequest::Representation
1100
+ command.request_object = request_inventory_verification_request_object
1101
+ command.response_representation = Google::Apis::MerchantapiAccountsV1beta::RequestInventoryVerificationResponse::Representation
1102
+ command.response_class = Google::Apis::MerchantapiAccountsV1beta::RequestInventoryVerificationResponse
1103
+ command.params['name'] = name unless name.nil?
1104
+ command.query['fields'] = fields unless fields.nil?
1105
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1106
+ execute_or_queue_command(command, &block)
1107
+ end
1108
+
1109
+ # Find the LFP provider candidates in a given country.
1110
+ # @param [String] parent
1111
+ # Required. The name of the parent resource under which the LFP providers are
1112
+ # found. Format: `accounts/`account`/omnichannelSettings/`omnichannel_setting``.
1113
+ # @param [Fixnum] page_size
1114
+ # Optional. The maximum number of `LfpProvider` resources to return. The service
1115
+ # returns fewer than this value if the number of lfp providers is less that than
1116
+ # the `pageSize`. The default value is 50. The maximum value is 1000; If a value
1117
+ # higher than the maximum is specified, then the `pageSize` will default to the
1118
+ # maximum.
1119
+ # @param [String] page_token
1120
+ # Optional. A page token, received from a previous `FindLfpProviders` call.
1121
+ # Provide the page token to retrieve the subsequent page. When paginating, all
1122
+ # other parameters provided to `FindLfpProviders` must match the call that
1123
+ # provided the page token.
1124
+ # @param [String] fields
1125
+ # Selector specifying which fields to include in a partial response.
1126
+ # @param [String] quota_user
1127
+ # Available to use for quota purposes for server-side applications. Can be any
1128
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1129
+ # @param [Google::Apis::RequestOptions] options
1130
+ # Request-specific options
1131
+ #
1132
+ # @yield [result, err] Result & error if block supplied
1133
+ # @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::FindLfpProvidersResponse] parsed result object
1134
+ # @yieldparam err [StandardError] error object if request failed
1135
+ #
1136
+ # @return [Google::Apis::MerchantapiAccountsV1beta::FindLfpProvidersResponse]
1137
+ #
1138
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1139
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1140
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1141
+ def find_account_omnichannel_setting_lfp_provider(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1142
+ command = make_simple_command(:get, 'accounts/v1beta/{+parent}/lfpProviders:find', options)
1143
+ command.response_representation = Google::Apis::MerchantapiAccountsV1beta::FindLfpProvidersResponse::Representation
1144
+ command.response_class = Google::Apis::MerchantapiAccountsV1beta::FindLfpProvidersResponse
1145
+ command.params['parent'] = parent unless parent.nil?
1146
+ command.query['pageSize'] = page_size unless page_size.nil?
1147
+ command.query['pageToken'] = page_token unless page_token.nil?
1148
+ command.query['fields'] = fields unless fields.nil?
1149
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1150
+ execute_or_queue_command(command, &block)
1151
+ end
1152
+
1153
+ # Link the specified merchant to a LFP provider for the specified country.
1154
+ # @param [String] name
1155
+ # Required. The name of the LFP provider resource to link. Format: `accounts/`
1156
+ # account`/omnichannelSettings/`omnichannel_setting`/lfpProviders/`lfp_provider``
1157
+ # . The `lfp_provider` is the LFP provider ID.
1158
+ # @param [Google::Apis::MerchantapiAccountsV1beta::LinkLfpProviderRequest] link_lfp_provider_request_object
1159
+ # @param [String] fields
1160
+ # Selector specifying which fields to include in a partial response.
1161
+ # @param [String] quota_user
1162
+ # Available to use for quota purposes for server-side applications. Can be any
1163
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1164
+ # @param [Google::Apis::RequestOptions] options
1165
+ # Request-specific options
1166
+ #
1167
+ # @yield [result, err] Result & error if block supplied
1168
+ # @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::LinkLfpProviderResponse] parsed result object
1169
+ # @yieldparam err [StandardError] error object if request failed
1170
+ #
1171
+ # @return [Google::Apis::MerchantapiAccountsV1beta::LinkLfpProviderResponse]
1172
+ #
1173
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1174
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1175
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1176
+ def link_lfp_provider(name, link_lfp_provider_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1177
+ command = make_simple_command(:post, 'accounts/v1beta/{+name}:linkLfpProvider', options)
1178
+ command.request_representation = Google::Apis::MerchantapiAccountsV1beta::LinkLfpProviderRequest::Representation
1179
+ command.request_object = link_lfp_provider_request_object
1180
+ command.response_representation = Google::Apis::MerchantapiAccountsV1beta::LinkLfpProviderResponse::Representation
1181
+ command.response_class = Google::Apis::MerchantapiAccountsV1beta::LinkLfpProviderResponse
1182
+ command.params['name'] = name unless name.nil?
1183
+ command.query['fields'] = fields unless fields.nil?
1184
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1185
+ execute_or_queue_command(command, &block)
1186
+ end
1187
+
1188
+ # Creates a new return policy for a given business.
1189
+ # @param [String] parent
1190
+ # Required. The Merchant Center account for which the return policy will be
1191
+ # created. Format: `accounts/`account``
1192
+ # @param [Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy] online_return_policy_object
1193
+ # @param [String] fields
1194
+ # Selector specifying which fields to include in a partial response.
1195
+ # @param [String] quota_user
1196
+ # Available to use for quota purposes for server-side applications. Can be any
1197
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1198
+ # @param [Google::Apis::RequestOptions] options
1199
+ # Request-specific options
1200
+ #
1201
+ # @yield [result, err] Result & error if block supplied
1202
+ # @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy] parsed result object
1203
+ # @yieldparam err [StandardError] error object if request failed
1204
+ #
1205
+ # @return [Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy]
1206
+ #
1207
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1208
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1209
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1210
+ def create_account_online_return_policy(parent, online_return_policy_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1211
+ command = make_simple_command(:post, 'accounts/v1beta/{+parent}/onlineReturnPolicies', options)
1212
+ command.request_representation = Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy::Representation
1213
+ command.request_object = online_return_policy_object
1214
+ command.response_representation = Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy::Representation
1215
+ command.response_class = Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy
1216
+ command.params['parent'] = parent unless parent.nil?
1217
+ command.query['fields'] = fields unless fields.nil?
1218
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1219
+ execute_or_queue_command(command, &block)
1220
+ end
1221
+
1222
+ # Deletes an existing return policy.
1223
+ # @param [String] name
1224
+ # Required. The name of the return policy to delete. Format: `accounts/`account`/
1225
+ # onlineReturnPolicies/`return_policy``
1226
+ # @param [String] fields
1227
+ # Selector specifying which fields to include in a partial response.
1228
+ # @param [String] quota_user
1229
+ # Available to use for quota purposes for server-side applications. Can be any
1230
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1231
+ # @param [Google::Apis::RequestOptions] options
1232
+ # Request-specific options
1233
+ #
1234
+ # @yield [result, err] Result & error if block supplied
1235
+ # @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::Empty] parsed result object
1236
+ # @yieldparam err [StandardError] error object if request failed
1237
+ #
1238
+ # @return [Google::Apis::MerchantapiAccountsV1beta::Empty]
1239
+ #
1240
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1241
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1242
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1243
+ def delete_account_online_return_policy(name, fields: nil, quota_user: nil, options: nil, &block)
1244
+ command = make_simple_command(:delete, 'accounts/v1beta/{+name}', options)
1245
+ command.response_representation = Google::Apis::MerchantapiAccountsV1beta::Empty::Representation
1246
+ command.response_class = Google::Apis::MerchantapiAccountsV1beta::Empty
1247
+ command.params['name'] = name unless name.nil?
1248
+ command.query['fields'] = fields unless fields.nil?
1249
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1250
+ execute_or_queue_command(command, &block)
1251
+ end
1252
+
1253
+ # Gets an existing return policy for a given business.
852
1254
  # @param [String] name
853
1255
  # Required. The name of the return policy to retrieve. Format: `accounts/`
854
1256
  # account`/onlineReturnPolicies/`return_policy``
@@ -879,14 +1281,14 @@ module Google
879
1281
  execute_or_queue_command(command, &block)
880
1282
  end
881
1283
 
882
- # Lists all existing return policies for a given merchant.
1284
+ # Lists all existing return policies for a given business.
883
1285
  # @param [String] parent
884
- # Required. The merchant account for which to list return policies. Format: `
885
- # accounts/`account``
1286
+ # Required. The Merchant Center account for which to list return policies.
1287
+ # Format: `accounts/`account``
886
1288
  # @param [Fixnum] page_size
887
1289
  # Optional. The maximum number of `OnlineReturnPolicy` resources to return. The
888
1290
  # service returns fewer than this value if the number of return policies for the
889
- # given merchant is less that than the `pageSize`. The default value is 10. The
1291
+ # given business is less that than the `pageSize`. The default value is 10. The
890
1292
  # maximum value is 100; If a value higher than the maximum is specified, then
891
1293
  # the `pageSize` will default to the maximum
892
1294
  # @param [String] page_token
@@ -924,11 +1326,52 @@ module Google
924
1326
  execute_or_queue_command(command, &block)
925
1327
  end
926
1328
 
927
- # Disable participation in the specified program for the account. Executing this
928
- # method requires admin access.
1329
+ # Updates an existing return policy for a given business.
1330
+ # @param [String] name
1331
+ # Identifier. The name of the `OnlineReturnPolicy` resource. Format: `accounts/`
1332
+ # account`/onlineReturnPolicies/`return_policy``
1333
+ # @param [Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy] online_return_policy_object
1334
+ # @param [String] update_mask
1335
+ # Optional. List of fields being updated. The following fields are supported (in
1336
+ # both `snake_case` and `lowerCamelCase`): - `accept_defective_only` - `
1337
+ # accept_exchange` - `item_conditions` - `policy` - `process_refund_days` - `
1338
+ # restocking_fee` - `return_methods` - `return_policy_uri` - `
1339
+ # return_shipping_fee`
1340
+ # @param [String] fields
1341
+ # Selector specifying which fields to include in a partial response.
1342
+ # @param [String] quota_user
1343
+ # Available to use for quota purposes for server-side applications. Can be any
1344
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1345
+ # @param [Google::Apis::RequestOptions] options
1346
+ # Request-specific options
1347
+ #
1348
+ # @yield [result, err] Result & error if block supplied
1349
+ # @yieldparam result [Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy] parsed result object
1350
+ # @yieldparam err [StandardError] error object if request failed
1351
+ #
1352
+ # @return [Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy]
1353
+ #
1354
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1355
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1356
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1357
+ def patch_account_online_return_policy(name, online_return_policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1358
+ command = make_simple_command(:patch, 'accounts/v1beta/{+name}', options)
1359
+ command.request_representation = Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy::Representation
1360
+ command.request_object = online_return_policy_object
1361
+ command.response_representation = Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy::Representation
1362
+ command.response_class = Google::Apis::MerchantapiAccountsV1beta::OnlineReturnPolicy
1363
+ command.params['name'] = name unless name.nil?
1364
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1365
+ command.query['fields'] = fields unless fields.nil?
1366
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1367
+ execute_or_queue_command(command, &block)
1368
+ end
1369
+
1370
+ # Disable participation in the specified program for the account.
929
1371
  # @param [String] name
930
1372
  # Required. The name of the program for which to disable participation for the
931
- # given account. Format: `accounts/`account`/programs/`program``
1373
+ # given account. Format: `accounts/`account`/programs/`program``. For example, `
1374
+ # accounts/123456/programs/free-listings`.
932
1375
  # @param [Google::Apis::MerchantapiAccountsV1beta::DisableProgramRequest] disable_program_request_object
933
1376
  # @param [String] fields
934
1377
  # Selector specifying which fields to include in a partial response.
@@ -959,11 +1402,11 @@ module Google
959
1402
  execute_or_queue_command(command, &block)
960
1403
  end
961
1404
 
962
- # Enable participation in the specified program for the account. Executing this
963
- # method requires admin access.
1405
+ # Enable participation in the specified program for the account.
964
1406
  # @param [String] name
965
1407
  # Required. The name of the program for which to enable participation for the
966
- # given account. Format: `accounts/`account`/programs/`program``
1408
+ # given account. Format: `accounts/`account`/programs/`program``. For example, `
1409
+ # accounts/123456/programs/free-listings`.
967
1410
  # @param [Google::Apis::MerchantapiAccountsV1beta::EnableProgramRequest] enable_program_request_object
968
1411
  # @param [String] fields
969
1412
  # Selector specifying which fields to include in a partial response.
@@ -997,7 +1440,7 @@ module Google
997
1440
  # Retrieves the specified program for the account.
998
1441
  # @param [String] name
999
1442
  # Required. The name of the program to retrieve. Format: `accounts/`account`/
1000
- # programs/`program``
1443
+ # programs/`program``. For example, `accounts/123456/programs/free-listings`.
1001
1444
  # @param [String] fields
1002
1445
  # Selector specifying which fields to include in a partial response.
1003
1446
  # @param [String] quota_user
@@ -1248,7 +1691,8 @@ module Google
1248
1691
  # Retrieve an account relationship.
1249
1692
  # @param [String] name
1250
1693
  # Required. The resource name of the account relationship to get. Format: `
1251
- # accounts/`account`/relationships/`relationship``
1694
+ # accounts/`account`/relationships/`relationship``. For example, `accounts/
1695
+ # 123456/relationships/567890`.
1252
1696
  # @param [String] fields
1253
1697
  # Selector specifying which fields to include in a partial response.
1254
1698
  # @param [String] quota_user
@@ -1318,7 +1762,8 @@ module Google
1318
1762
  # Updates the account relationship. Executing this method requires admin access.
1319
1763
  # @param [String] name
1320
1764
  # Identifier. The resource name of the account relationship. Format: `accounts/`
1321
- # account`/relationships/`relationship``
1765
+ # account`/relationships/`relationship``. For example, `accounts/123456/
1766
+ # relationships/567890`.
1322
1767
  # @param [Google::Apis::MerchantapiAccountsV1beta::AccountRelationship] account_relationship_object
1323
1768
  # @param [String] update_mask
1324
1769
  # Optional. List of fields being updated. The following fields are supported (in
@@ -1556,7 +2001,7 @@ module Google
1556
2001
  execute_or_queue_command(command, &block)
1557
2002
  end
1558
2003
 
1559
- # Replace the shipping setting of a merchant with the request shipping setting.
2004
+ # Replace the shipping setting of a business with the request shipping setting.
1560
2005
  # Executing this method requires admin access.
1561
2006
  # @param [String] parent
1562
2007
  # Required. The account for which this shipping setting will be inserted. If you
@@ -1626,6 +2071,8 @@ module Google
1626
2071
  end
1627
2072
 
1628
2073
  # Retrieves the state of the agreement for the application terms of service.
2074
+ # Application terms of service covers permissions related to the usage of data
2075
+ # provided through Merchant Center, CSS Center, Manufacturer Center, and more.
1629
2076
  # @param [String] parent
1630
2077
  # Required. The account for which to get a TermsOfServiceAgreementState Format: `
1631
2078
  # accounts/`account``