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