google-api-client 0.24.3 → 0.25.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (262) hide show
  1. checksums.yaml +4 -4
  2. data/.travis.yml +0 -2
  3. data/CHANGELOG.md +99 -0
  4. data/Gemfile +1 -0
  5. data/generated/google/apis/abusiveexperiencereport_v1.rb +2 -2
  6. data/generated/google/apis/abusiveexperiencereport_v1/classes.rb +0 -1
  7. data/generated/google/apis/abusiveexperiencereport_v1/service.rb +1 -1
  8. data/generated/google/apis/{content_v2sandbox.rb → accesscontextmanager_v1beta.rb} +11 -12
  9. data/generated/google/apis/accesscontextmanager_v1beta/classes.rb +697 -0
  10. data/generated/google/apis/accesscontextmanager_v1beta/representations.rb +240 -0
  11. data/generated/google/apis/accesscontextmanager_v1beta/service.rb +666 -0
  12. data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
  13. data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +16 -0
  14. data/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb +2 -0
  15. data/generated/google/apis/adexchangebuyer2_v2beta1/service.rb +2 -2
  16. data/generated/google/apis/adexperiencereport_v1.rb +2 -2
  17. data/generated/google/apis/adexperiencereport_v1/service.rb +1 -1
  18. data/generated/google/apis/alertcenter_v1beta1.rb +4 -3
  19. data/generated/google/apis/alertcenter_v1beta1/classes.rb +9 -2
  20. data/generated/google/apis/alertcenter_v1beta1/representations.rb +1 -0
  21. data/generated/google/apis/alertcenter_v1beta1/service.rb +3 -2
  22. data/generated/google/apis/androiddeviceprovisioning_v1.rb +1 -1
  23. data/generated/google/apis/androiddeviceprovisioning_v1/service.rb +3 -2
  24. data/generated/google/apis/androidenterprise_v1.rb +1 -1
  25. data/generated/google/apis/androidenterprise_v1/classes.rb +68 -6
  26. data/generated/google/apis/androidenterprise_v1/representations.rb +20 -0
  27. data/generated/google/apis/androidmanagement_v1.rb +1 -1
  28. data/generated/google/apis/androidmanagement_v1/classes.rb +92 -0
  29. data/generated/google/apis/androidmanagement_v1/representations.rb +36 -0
  30. data/generated/google/apis/androidpublisher_v1.rb +2 -2
  31. data/generated/google/apis/androidpublisher_v1/service.rb +1 -1
  32. data/generated/google/apis/androidpublisher_v1_1.rb +2 -2
  33. data/generated/google/apis/androidpublisher_v1_1/service.rb +1 -1
  34. data/generated/google/apis/androidpublisher_v2.rb +2 -2
  35. data/generated/google/apis/androidpublisher_v2/service.rb +3 -2
  36. data/generated/google/apis/androidpublisher_v3.rb +2 -2
  37. data/generated/google/apis/androidpublisher_v3/service.rb +3 -2
  38. data/generated/google/apis/appengine_v1.rb +2 -3
  39. data/generated/google/apis/appengine_v1/service.rb +1 -2
  40. data/generated/google/apis/appengine_v1alpha.rb +2 -3
  41. data/generated/google/apis/appengine_v1alpha/service.rb +1 -2
  42. data/generated/google/apis/appengine_v1beta.rb +2 -3
  43. data/generated/google/apis/appengine_v1beta/service.rb +1 -2
  44. data/generated/google/apis/appengine_v1beta4.rb +2 -3
  45. data/generated/google/apis/appengine_v1beta4/service.rb +1 -2
  46. data/generated/google/apis/appengine_v1beta5.rb +2 -3
  47. data/generated/google/apis/appengine_v1beta5/service.rb +1 -2
  48. data/generated/google/apis/bigquery_v2.rb +1 -1
  49. data/generated/google/apis/bigquery_v2/classes.rb +98 -7
  50. data/generated/google/apis/bigquery_v2/representations.rb +35 -0
  51. data/generated/google/apis/bigquerydatatransfer_v1.rb +1 -1
  52. data/generated/google/apis/civicinfo_v2.rb +1 -1
  53. data/generated/google/apis/civicinfo_v2/classes.rb +18 -0
  54. data/generated/google/apis/civicinfo_v2/representations.rb +2 -0
  55. data/generated/google/apis/cloudasset_v1beta1.rb +1 -1
  56. data/generated/google/apis/cloudasset_v1beta1/classes.rb +5 -5
  57. data/generated/google/apis/cloudbuild_v1.rb +1 -1
  58. data/generated/google/apis/cloudbuild_v1/classes.rb +10 -1
  59. data/generated/google/apis/cloudbuild_v1/representations.rb +1 -0
  60. data/generated/google/apis/cloudfunctions_v1.rb +1 -1
  61. data/generated/google/apis/cloudfunctions_v1/classes.rb +418 -0
  62. data/generated/google/apis/cloudfunctions_v1/representations.rb +121 -0
  63. data/generated/google/apis/cloudfunctions_v1/service.rb +107 -0
  64. data/generated/google/apis/cloudfunctions_v1beta2.rb +1 -1
  65. data/generated/google/apis/cloudfunctions_v1beta2/classes.rb +16 -0
  66. data/generated/google/apis/cloudfunctions_v1beta2/representations.rb +1 -0
  67. data/generated/google/apis/cloudkms_v1.rb +1 -1
  68. data/generated/google/apis/cloudresourcemanager_v1.rb +3 -3
  69. data/generated/google/apis/cloudresourcemanager_v1/classes.rb +2 -1
  70. data/generated/google/apis/cloudresourcemanager_v1/service.rb +2 -2
  71. data/generated/google/apis/cloudresourcemanager_v1beta1.rb +3 -3
  72. data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +2 -1
  73. data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +2 -2
  74. data/generated/google/apis/cloudresourcemanager_v2.rb +3 -3
  75. data/generated/google/apis/cloudresourcemanager_v2/service.rb +2 -2
  76. data/generated/google/apis/cloudresourcemanager_v2beta1.rb +3 -3
  77. data/generated/google/apis/cloudresourcemanager_v2beta1/service.rb +2 -2
  78. data/generated/google/apis/cloudsearch_v1.rb +59 -0
  79. data/generated/google/apis/cloudsearch_v1/classes.rb +4697 -0
  80. data/generated/google/apis/cloudsearch_v1/representations.rb +2151 -0
  81. data/generated/google/apis/cloudsearch_v1/service.rb +1351 -0
  82. data/generated/google/apis/cloudtasks_v2beta2.rb +1 -1
  83. data/generated/google/apis/cloudtasks_v2beta2/classes.rb +34 -0
  84. data/generated/google/apis/cloudtasks_v2beta3.rb +1 -1
  85. data/generated/google/apis/cloudtasks_v2beta3/classes.rb +34 -30
  86. data/generated/google/apis/composer_v1beta1.rb +1 -1
  87. data/generated/google/apis/composer_v1beta1/classes.rb +5 -8
  88. data/generated/google/apis/compute_alpha.rb +1 -1
  89. data/generated/google/apis/compute_beta.rb +1 -1
  90. data/generated/google/apis/compute_v1.rb +1 -1
  91. data/generated/google/apis/content_v2.rb +1 -1
  92. data/generated/google/apis/content_v2/classes.rb +197 -69
  93. data/generated/google/apis/content_v2/representations.rb +64 -33
  94. data/generated/google/apis/content_v2/service.rb +1 -1
  95. data/generated/google/apis/dataflow_v1b3.rb +1 -1
  96. data/generated/google/apis/dataflow_v1b3/classes.rb +42 -0
  97. data/generated/google/apis/dataflow_v1b3/representations.rb +17 -0
  98. data/generated/google/apis/dataproc_v1.rb +1 -1
  99. data/generated/google/apis/dataproc_v1/classes.rb +19 -19
  100. data/generated/google/apis/dataproc_v1beta2.rb +1 -1
  101. data/generated/google/apis/dataproc_v1beta2/classes.rb +19 -19
  102. data/generated/google/apis/dialogflow_v2.rb +6 -3
  103. data/generated/google/apis/dialogflow_v2/classes.rb +112 -8
  104. data/generated/google/apis/dialogflow_v2/representations.rb +30 -0
  105. data/generated/google/apis/dialogflow_v2/service.rb +7 -2
  106. data/generated/google/apis/dialogflow_v2beta1.rb +6 -3
  107. data/generated/google/apis/dialogflow_v2beta1/classes.rb +116 -8
  108. data/generated/google/apis/dialogflow_v2beta1/representations.rb +30 -0
  109. data/generated/google/apis/dialogflow_v2beta1/service.rb +19 -8
  110. data/generated/google/apis/digitalassetlinks_v1.rb +2 -3
  111. data/generated/google/apis/digitalassetlinks_v1/service.rb +1 -2
  112. data/generated/google/apis/dlp_v2.rb +1 -1
  113. data/generated/google/apis/dlp_v2/classes.rb +17 -5
  114. data/generated/google/apis/dlp_v2/representations.rb +2 -0
  115. data/generated/google/apis/dns_v1beta2.rb +1 -1
  116. data/generated/google/apis/dns_v1beta2/classes.rb +81 -0
  117. data/generated/google/apis/dns_v1beta2/representations.rb +34 -0
  118. data/generated/google/apis/doubleclicksearch_v2.rb +1 -1
  119. data/generated/google/apis/doubleclicksearch_v2/classes.rb +1 -1
  120. data/generated/google/apis/drive_v2.rb +1 -1
  121. data/generated/google/apis/drive_v2/classes.rb +3 -1
  122. data/generated/google/apis/firebaserules_v1.rb +1 -1
  123. data/generated/google/apis/firestore_v1.rb +1 -1
  124. data/generated/google/apis/firestore_v1/classes.rb +637 -0
  125. data/generated/google/apis/firestore_v1/representations.rb +260 -0
  126. data/generated/google/apis/firestore_v1/service.rb +377 -0
  127. data/generated/google/apis/firestore_v1beta2.rb +1 -1
  128. data/generated/google/apis/firestore_v1beta2/classes.rb +205 -0
  129. data/generated/google/apis/firestore_v1beta2/representations.rb +83 -0
  130. data/generated/google/apis/firestore_v1beta2/service.rb +79 -0
  131. data/generated/google/apis/genomics_v1.rb +2 -2
  132. data/generated/google/apis/genomics_v1/service.rb +1 -1
  133. data/generated/google/apis/genomics_v1alpha2.rb +2 -2
  134. data/generated/google/apis/genomics_v1alpha2/service.rb +1 -1
  135. data/generated/google/apis/genomics_v2alpha1.rb +2 -2
  136. data/generated/google/apis/genomics_v2alpha1/service.rb +1 -1
  137. data/generated/google/apis/iam_v1.rb +1 -1
  138. data/generated/google/apis/iam_v1/classes.rb +4 -3
  139. data/generated/google/apis/iamcredentials_v1.rb +2 -2
  140. data/generated/google/apis/iamcredentials_v1/service.rb +1 -1
  141. data/generated/google/apis/indexing_v3.rb +2 -3
  142. data/generated/google/apis/indexing_v3/service.rb +1 -2
  143. data/generated/google/apis/jobs_v2.rb +1 -1
  144. data/generated/google/apis/jobs_v2/classes.rb +2 -2
  145. data/generated/google/apis/jobs_v3.rb +1 -1
  146. data/generated/google/apis/jobs_v3/classes.rb +3 -3
  147. data/generated/google/apis/jobs_v3/service.rb +20 -2
  148. data/generated/google/apis/jobs_v3p1beta1.rb +1 -1
  149. data/generated/google/apis/jobs_v3p1beta1/classes.rb +3 -3
  150. data/generated/google/apis/jobs_v3p1beta1/service.rb +20 -2
  151. data/generated/google/apis/language_v1.rb +4 -4
  152. data/generated/google/apis/language_v1/service.rb +3 -3
  153. data/generated/google/apis/language_v1beta1.rb +4 -4
  154. data/generated/google/apis/language_v1beta1/service.rb +3 -3
  155. data/generated/google/apis/language_v1beta2.rb +4 -4
  156. data/generated/google/apis/language_v1beta2/service.rb +3 -3
  157. data/generated/google/apis/logging_v2.rb +1 -1
  158. data/generated/google/apis/logging_v2/classes.rb +2 -13
  159. data/generated/google/apis/logging_v2/representations.rb +0 -2
  160. data/generated/google/apis/logging_v2beta1.rb +1 -1
  161. data/generated/google/apis/logging_v2beta1/classes.rb +2 -41
  162. data/generated/google/apis/logging_v2beta1/representations.rb +0 -16
  163. data/generated/google/apis/logging_v2beta1/service.rb +0 -255
  164. data/generated/google/apis/monitoring_v3.rb +1 -1
  165. data/generated/google/apis/monitoring_v3/classes.rb +25 -15
  166. data/generated/google/apis/monitoring_v3/representations.rb +1 -0
  167. data/generated/google/apis/monitoring_v3/service.rb +366 -1
  168. data/generated/google/apis/oslogin_v1.rb +1 -1
  169. data/generated/google/apis/oslogin_v1/service.rb +7 -1
  170. data/generated/google/apis/oslogin_v1alpha.rb +1 -1
  171. data/generated/google/apis/oslogin_v1alpha/service.rb +10 -1
  172. data/generated/google/apis/oslogin_v1beta.rb +1 -1
  173. data/generated/google/apis/oslogin_v1beta/service.rb +7 -1
  174. data/generated/google/apis/redis_v1.rb +1 -1
  175. data/generated/google/apis/redis_v1/classes.rb +6 -0
  176. data/generated/google/apis/redis_v1/representations.rb +1 -0
  177. data/generated/google/apis/redis_v1beta1.rb +1 -1
  178. data/generated/google/apis/redis_v1beta1/classes.rb +6 -0
  179. data/generated/google/apis/redis_v1beta1/representations.rb +1 -0
  180. data/generated/google/apis/runtimeconfig_v1beta1.rb +1 -1
  181. data/generated/google/apis/runtimeconfig_v1beta1/classes.rb +7 -6
  182. data/generated/google/apis/script_v1.rb +2 -2
  183. data/generated/google/apis/script_v1/service.rb +7 -3
  184. data/generated/google/apis/serviceconsumermanagement_v1.rb +2 -3
  185. data/generated/google/apis/serviceconsumermanagement_v1/classes.rb +7 -0
  186. data/generated/google/apis/serviceconsumermanagement_v1/representations.rb +1 -0
  187. data/generated/google/apis/serviceconsumermanagement_v1/service.rb +1 -2
  188. data/generated/google/apis/servicecontrol_v1.rb +3 -3
  189. data/generated/google/apis/servicecontrol_v1/classes.rb +18 -230
  190. data/generated/google/apis/servicecontrol_v1/representations.rb +2 -99
  191. data/generated/google/apis/servicecontrol_v1/service.rb +2 -140
  192. data/generated/google/apis/servicemanagement_v1.rb +1 -1
  193. data/generated/google/apis/servicemanagement_v1/classes.rb +1 -1
  194. data/generated/google/apis/servicenetworking_v1beta.rb +1 -1
  195. data/generated/google/apis/servicenetworking_v1beta/classes.rb +24 -0
  196. data/generated/google/apis/servicenetworking_v1beta/representations.rb +3 -0
  197. data/generated/google/apis/serviceusage_v1.rb +1 -1
  198. data/generated/google/apis/serviceusage_v1/classes.rb +7 -0
  199. data/generated/google/apis/serviceusage_v1/representations.rb +1 -0
  200. data/generated/google/apis/serviceusage_v1beta1.rb +1 -1
  201. data/generated/google/apis/serviceusage_v1beta1/classes.rb +7 -0
  202. data/generated/google/apis/serviceusage_v1beta1/representations.rb +1 -0
  203. data/generated/google/apis/slides_v1.rb +2 -2
  204. data/generated/google/apis/slides_v1/classes.rb +4 -3
  205. data/generated/google/apis/slides_v1/service.rb +1 -1
  206. data/generated/google/apis/storage_v1.rb +1 -1
  207. data/generated/google/apis/storage_v1/service.rb +2 -3
  208. data/generated/google/apis/testing_v1.rb +1 -1
  209. data/generated/google/apis/testing_v1/classes.rb +9 -0
  210. data/generated/google/apis/testing_v1/representations.rb +1 -0
  211. data/generated/google/apis/toolresults_v1beta3.rb +1 -1
  212. data/generated/google/apis/toolresults_v1beta3/service.rb +1 -1
  213. data/generated/google/apis/tpu_v1.rb +1 -1
  214. data/generated/google/apis/tpu_v1/classes.rb +6 -0
  215. data/generated/google/apis/tpu_v1/representations.rb +1 -0
  216. data/generated/google/apis/tpu_v1alpha1.rb +1 -1
  217. data/generated/google/apis/tpu_v1alpha1/classes.rb +6 -0
  218. data/generated/google/apis/tpu_v1alpha1/representations.rb +1 -0
  219. data/generated/google/apis/vault_v1.rb +1 -1
  220. data/generated/google/apis/vault_v1/classes.rb +7 -0
  221. data/generated/google/apis/vault_v1/representations.rb +1 -0
  222. data/generated/google/apis/videointelligence_v1.rb +3 -2
  223. data/generated/google/apis/videointelligence_v1/classes.rb +547 -12
  224. data/generated/google/apis/videointelligence_v1/representations.rb +190 -2
  225. data/generated/google/apis/videointelligence_v1/service.rb +2 -1
  226. data/generated/google/apis/videointelligence_v1beta2.rb +3 -2
  227. data/generated/google/apis/videointelligence_v1beta2/classes.rb +547 -12
  228. data/generated/google/apis/videointelligence_v1beta2/representations.rb +190 -2
  229. data/generated/google/apis/videointelligence_v1beta2/service.rb +2 -1
  230. data/generated/google/apis/videointelligence_v1p1beta1.rb +3 -2
  231. data/generated/google/apis/videointelligence_v1p1beta1/classes.rb +418 -13
  232. data/generated/google/apis/videointelligence_v1p1beta1/representations.rb +153 -2
  233. data/generated/google/apis/videointelligence_v1p1beta1/service.rb +2 -1
  234. data/generated/google/apis/vision_v1.rb +1 -1
  235. data/generated/google/apis/vision_v1/classes.rb +1139 -54
  236. data/generated/google/apis/vision_v1/representations.rb +478 -0
  237. data/generated/google/apis/vision_v1/service.rb +744 -0
  238. data/generated/google/apis/vision_v1p1beta1.rb +1 -1
  239. data/generated/google/apis/vision_v1p1beta1/classes.rb +761 -16
  240. data/generated/google/apis/vision_v1p1beta1/representations.rb +333 -0
  241. data/generated/google/apis/vision_v1p2beta1.rb +1 -1
  242. data/generated/google/apis/vision_v1p2beta1/classes.rb +758 -13
  243. data/generated/google/apis/vision_v1p2beta1/representations.rb +333 -0
  244. data/generated/google/apis/websecurityscanner_v1alpha.rb +2 -2
  245. data/generated/google/apis/websecurityscanner_v1alpha/service.rb +1 -1
  246. data/generated/google/apis/youtube_partner_v1.rb +1 -1
  247. data/generated/google/apis/youtube_v3.rb +1 -1
  248. data/lib/google/apis/core/http_command.rb +83 -10
  249. data/lib/google/apis/options.rb +5 -1
  250. data/lib/google/apis/version.rb +1 -1
  251. metadata +10 -14
  252. data/generated/google/apis/content_v2sandbox/classes.rb +0 -4436
  253. data/generated/google/apis/content_v2sandbox/representations.rb +0 -1956
  254. data/generated/google/apis/content_v2sandbox/service.rb +0 -1296
  255. data/generated/google/apis/dfareporting_v2_8.rb +0 -40
  256. data/generated/google/apis/dfareporting_v2_8/classes.rb +0 -12043
  257. data/generated/google/apis/dfareporting_v2_8/representations.rb +0 -4311
  258. data/generated/google/apis/dfareporting_v2_8/service.rb +0 -8727
  259. data/generated/google/apis/serviceuser_v1.rb +0 -42
  260. data/generated/google/apis/serviceuser_v1/classes.rb +0 -3472
  261. data/generated/google/apis/serviceuser_v1/representations.rb +0 -1030
  262. data/generated/google/apis/serviceuser_v1/service.rb +0 -215
@@ -20,12 +20,12 @@ module Google
20
20
  module Apis
21
21
  # Web Security Scanner API
22
22
  #
23
- # Web Security Scanner API (under development).
23
+ # Scans your Compute and App Engine apps for common web vulnerabilities.
24
24
  #
25
25
  # @see https://cloud.google.com/security-scanner/
26
26
  module WebsecurityscannerV1alpha
27
27
  VERSION = 'V1alpha'
28
- REVISION = '20180905'
28
+ REVISION = '20181024'
29
29
 
30
30
  # View and manage your data across Google Cloud Platform services
31
31
  AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
@@ -22,7 +22,7 @@ module Google
22
22
  module WebsecurityscannerV1alpha
23
23
  # Web Security Scanner API
24
24
  #
25
- # Web Security Scanner API (under development).
25
+ # Scans your Compute and App Engine apps for common web vulnerabilities.
26
26
  #
27
27
  # @example
28
28
  # require 'google/apis/websecurityscanner_v1alpha'
@@ -25,7 +25,7 @@ module Google
25
25
  # @see https://developers.google.com/youtube/partner/
26
26
  module YoutubePartnerV1
27
27
  VERSION = 'V1'
28
- REVISION = '20180925'
28
+ REVISION = '20181029'
29
29
 
30
30
  # View and manage your assets and associated content on YouTube
31
31
  AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner'
@@ -31,7 +31,7 @@ module Google
31
31
  # Manage your YouTube account
32
32
  AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube'
33
33
 
34
- # Manage your YouTube account
34
+ # See, edit, and permanently delete your YouTube videos, ratings, comments and captions
35
35
  AUTH_YOUTUBE_FORCE_SSL = 'https://www.googleapis.com/auth/youtube.force-ssl'
36
36
 
37
37
  # View your YouTube account
@@ -29,6 +29,13 @@ module Google
29
29
 
30
30
  RETRIABLE_ERRORS = [Google::Apis::ServerError, Google::Apis::RateLimitError, Google::Apis::TransmissionError]
31
31
 
32
+ begin
33
+ require 'opencensus'
34
+ OPENCENSUS_AVAILABLE = true
35
+ rescue LoadError
36
+ OPENCENSUS_AVAILABLE = false
37
+ end
38
+
32
39
  # Request options
33
40
  # @return [Google::Apis::RequestOptions]
34
41
  attr_accessor :options
@@ -76,6 +83,7 @@ module Google
76
83
  self.body = body
77
84
  self.query = {}
78
85
  self.params = {}
86
+ @opencensus_span = nil
79
87
  end
80
88
 
81
89
  # Execute the command, retrying as necessary
@@ -89,6 +97,7 @@ module Google
89
97
  # @raise [Google::Apis::AuthorizationError] Authorization is required
90
98
  def execute(client)
91
99
  prepare!
100
+ opencensus_begin_span
92
101
  begin
93
102
  Retriable.retriable tries: options.retries + 1,
94
103
  base_interval: 1,
@@ -116,6 +125,8 @@ module Google
116
125
  end
117
126
  end
118
127
  ensure
128
+ opencensus_end_span
129
+ @http_res = nil
119
130
  release!
120
131
  end
121
132
 
@@ -157,7 +168,6 @@ module Google
157
168
  end
158
169
 
159
170
  self.body = '' unless self.body
160
-
161
171
  end
162
172
 
163
173
  # Release any resources used by this command
@@ -288,15 +298,15 @@ module Google
288
298
  request_header = header.dup
289
299
  apply_request_options(request_header)
290
300
 
291
- http_res = client.request(method.to_s.upcase,
292
- url.to_s,
293
- query: nil,
294
- body: body,
295
- header: request_header,
296
- follow_redirect: true)
297
- logger.debug { http_res.status }
298
- logger.debug { http_res.inspect }
299
- response = process_response(http_res.status.to_i, http_res.header, http_res.body)
301
+ @http_res = client.request(method.to_s.upcase,
302
+ url.to_s,
303
+ query: nil,
304
+ body: body,
305
+ header: request_header,
306
+ follow_redirect: true)
307
+ logger.debug { @http_res.status }
308
+ logger.debug { @http_res.inspect }
309
+ response = process_response(@http_res.status.to_i, @http_res.header, @http_res.body)
300
310
  success(response)
301
311
  rescue => e
302
312
  logger.debug { sprintf('Caught error %s', e) }
@@ -323,10 +333,73 @@ module Google
323
333
 
324
334
  private
325
335
 
336
+ def opencensus_begin_span
337
+ return unless OPENCENSUS_AVAILABLE && options.use_opencensus
338
+ return if @opencensus_span
339
+ return unless OpenCensus::Trace.span_context
340
+
341
+ @opencensus_span = OpenCensus::Trace.start_span url.path.to_s
342
+ @opencensus_span.kind = OpenCensus::Trace::SpanBuilder::CLIENT
343
+ @opencensus_span.put_attribute "http.host", url.host.to_s
344
+ @opencensus_span.put_attribute "http.method", method.to_s.upcase
345
+ @opencensus_span.put_attribute "http.path", url.path.to_s
346
+ if body.respond_to? :bytesize
347
+ @opencensus_span.put_message_event \
348
+ OpenCensus::Trace::SpanBuilder::SENT, 1, body.bytesize
349
+ end
350
+
351
+ formatter = OpenCensus::Trace.config.http_formatter
352
+ if formatter.respond_to? :header_name
353
+ header[formatter.header_name] = formatter.serialize @opencensus_span.context.trace_context
354
+ end
355
+ rescue StandardError => e
356
+ # Log exceptions and continue, so opencensus failures don't cause
357
+ # the entire request to fail.
358
+ logger.debug { sprintf('Error opening OpenCensus span: %s', e) }
359
+ end
360
+
361
+ def opencensus_end_span
362
+ return unless OPENCENSUS_AVAILABLE
363
+ return unless @opencensus_span
364
+ return unless OpenCensus::Trace.span_context
365
+
366
+ if @http_res.body.respond_to? :bytesize
367
+ @opencensus_span.put_message_event \
368
+ OpenCensus::Trace::SpanBuilder::RECEIVED, 1, @http_res.body.bytesize
369
+ end
370
+ status = @http_res.status.to_i
371
+ if status > 0
372
+ @opencensus_span.set_status map_http_status status
373
+ @opencensus_span.put_attribute "http.status_code", status
374
+ end
375
+
376
+ OpenCensus::Trace.end_span @opencensus_span
377
+ @opencensus_span = nil
378
+ rescue StandardError => e
379
+ # Log exceptions and continue, so failures don't cause leaks by
380
+ # aborting cleanup.
381
+ logger.debug { sprintf('Error finishing OpenCensus span: %s', e) }
382
+ end
383
+
326
384
  def form_encoded?
327
385
  @form_encoded
328
386
  end
329
387
 
388
+ def map_http_status http_status
389
+ case http_status
390
+ when 200..399 then 0 # OK
391
+ when 400 then 3 # INVALID_ARGUMENT
392
+ when 401 then 16 # UNAUTHENTICATED
393
+ when 403 then 7 # PERMISSION_DENIED
394
+ when 404 then 5 # NOT_FOUND
395
+ when 429 then 8 # RESOURCE_EXHAUSTED
396
+ when 501 then 12 # UNIMPLEMENTED
397
+ when 503 then 14 # UNAVAILABLE
398
+ when 504 then 4 # DEADLINE_EXCEEDED
399
+ else 2 # UNKNOWN
400
+ end
401
+ end
402
+
330
403
  def normalize_query_value(v)
331
404
  case v
332
405
  when Array
@@ -32,7 +32,8 @@ module Google
32
32
  :normalize_unicode,
33
33
  :skip_serialization,
34
34
  :skip_deserialization,
35
- :api_format_version)
35
+ :api_format_version,
36
+ :use_opencensus)
36
37
 
37
38
  # General client options
38
39
  class ClientOptions
@@ -73,6 +74,8 @@ module Google
73
74
  # @return [Boolean] True if response should be returned in raw form instead of deserialized.
74
75
  # @!attribute [rw] api_format_version
75
76
  # @return [Fixnum] Version of the error format to request/expect.
77
+ # @!attribute [rw] use_opencensus
78
+ # @return [Boolean] Whether OpenCensus spans should be generated for requests. Default is true.
76
79
 
77
80
  # Get the default options
78
81
  # @return [Google::Apis::RequestOptions]
@@ -101,5 +104,6 @@ module Google
101
104
  RequestOptions.default.skip_serialization = false
102
105
  RequestOptions.default.skip_deserialization = false
103
106
  RequestOptions.default.api_format_version = nil
107
+ RequestOptions.default.use_opencensus = true
104
108
  end
105
109
  end
@@ -15,7 +15,7 @@
15
15
  module Google
16
16
  module Apis
17
17
  # Client library version
18
- VERSION = '0.24.3'.freeze
18
+ VERSION = '0.25.0'.freeze
19
19
 
20
20
  # Current operating system
21
21
  # @private
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-api-client
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.24.3
4
+ version: 0.25.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Steven Bazyl
@@ -11,7 +11,7 @@ authors:
11
11
  autorequire:
12
12
  bindir: bin
13
13
  cert_chain: []
14
- date: 2018-10-09 00:00:00.000000000 Z
14
+ date: 2018-11-06 00:00:00.000000000 Z
15
15
  dependencies:
16
16
  - !ruby/object:Gem::Dependency
17
17
  name: representable
@@ -201,6 +201,10 @@ files:
201
201
  - generated/google/apis/acceleratedmobilepageurl_v1/classes.rb
202
202
  - generated/google/apis/acceleratedmobilepageurl_v1/representations.rb
203
203
  - generated/google/apis/acceleratedmobilepageurl_v1/service.rb
204
+ - generated/google/apis/accesscontextmanager_v1beta.rb
205
+ - generated/google/apis/accesscontextmanager_v1beta/classes.rb
206
+ - generated/google/apis/accesscontextmanager_v1beta/representations.rb
207
+ - generated/google/apis/accesscontextmanager_v1beta/service.rb
204
208
  - generated/google/apis/adexchangebuyer2_v2beta1.rb
205
209
  - generated/google/apis/adexchangebuyer2_v2beta1/classes.rb
206
210
  - generated/google/apis/adexchangebuyer2_v2beta1/representations.rb
@@ -417,6 +421,10 @@ files:
417
421
  - generated/google/apis/cloudresourcemanager_v2beta1/classes.rb
418
422
  - generated/google/apis/cloudresourcemanager_v2beta1/representations.rb
419
423
  - generated/google/apis/cloudresourcemanager_v2beta1/service.rb
424
+ - generated/google/apis/cloudsearch_v1.rb
425
+ - generated/google/apis/cloudsearch_v1/classes.rb
426
+ - generated/google/apis/cloudsearch_v1/representations.rb
427
+ - generated/google/apis/cloudsearch_v1/service.rb
420
428
  - generated/google/apis/cloudshell_v1.rb
421
429
  - generated/google/apis/cloudshell_v1/classes.rb
422
430
  - generated/google/apis/cloudshell_v1/representations.rb
@@ -473,10 +481,6 @@ files:
473
481
  - generated/google/apis/content_v2/classes.rb
474
482
  - generated/google/apis/content_v2/representations.rb
475
483
  - generated/google/apis/content_v2/service.rb
476
- - generated/google/apis/content_v2sandbox.rb
477
- - generated/google/apis/content_v2sandbox/classes.rb
478
- - generated/google/apis/content_v2sandbox/representations.rb
479
- - generated/google/apis/content_v2sandbox/service.rb
480
484
  - generated/google/apis/customsearch_v1.rb
481
485
  - generated/google/apis/customsearch_v1/classes.rb
482
486
  - generated/google/apis/customsearch_v1/representations.rb
@@ -517,10 +521,6 @@ files:
517
521
  - generated/google/apis/deploymentmanager_v2beta/classes.rb
518
522
  - generated/google/apis/deploymentmanager_v2beta/representations.rb
519
523
  - generated/google/apis/deploymentmanager_v2beta/service.rb
520
- - generated/google/apis/dfareporting_v2_8.rb
521
- - generated/google/apis/dfareporting_v2_8/classes.rb
522
- - generated/google/apis/dfareporting_v2_8/representations.rb
523
- - generated/google/apis/dfareporting_v2_8/service.rb
524
524
  - generated/google/apis/dfareporting_v3_0.rb
525
525
  - generated/google/apis/dfareporting_v3_0/classes.rb
526
526
  - generated/google/apis/dfareporting_v3_0/representations.rb
@@ -881,10 +881,6 @@ files:
881
881
  - generated/google/apis/serviceusage_v1beta1/classes.rb
882
882
  - generated/google/apis/serviceusage_v1beta1/representations.rb
883
883
  - generated/google/apis/serviceusage_v1beta1/service.rb
884
- - generated/google/apis/serviceuser_v1.rb
885
- - generated/google/apis/serviceuser_v1/classes.rb
886
- - generated/google/apis/serviceuser_v1/representations.rb
887
- - generated/google/apis/serviceuser_v1/service.rb
888
884
  - generated/google/apis/sheets_v4.rb
889
885
  - generated/google/apis/sheets_v4/classes.rb
890
886
  - generated/google/apis/sheets_v4/representations.rb
@@ -1,4436 +0,0 @@
1
- # Copyright 2015 Google Inc.
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # http://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
- require 'date'
16
- require 'google/apis/core/base_service'
17
- require 'google/apis/core/json_representation'
18
- require 'google/apis/core/hashable'
19
- require 'google/apis/errors'
20
-
21
- module Google
22
- module Apis
23
- module ContentV2sandbox
24
-
25
- #
26
- class Amount
27
- include Google::Apis::Core::Hashable
28
-
29
- # [required] Value before taxes.
30
- # Corresponds to the JSON property `pretax`
31
- # @return [Google::Apis::ContentV2sandbox::Price]
32
- attr_accessor :pretax
33
-
34
- # [required] Tax value.
35
- # Corresponds to the JSON property `tax`
36
- # @return [Google::Apis::ContentV2sandbox::Price]
37
- attr_accessor :tax
38
-
39
- def initialize(**args)
40
- update!(**args)
41
- end
42
-
43
- # Update properties of this object
44
- def update!(**args)
45
- @pretax = args[:pretax] if args.key?(:pretax)
46
- @tax = args[:tax] if args.key?(:tax)
47
- end
48
- end
49
-
50
- #
51
- class CustomerReturnReason
52
- include Google::Apis::Core::Hashable
53
-
54
- #
55
- # Corresponds to the JSON property `description`
56
- # @return [String]
57
- attr_accessor :description
58
-
59
- #
60
- # Corresponds to the JSON property `reasonCode`
61
- # @return [String]
62
- attr_accessor :reason_code
63
-
64
- def initialize(**args)
65
- update!(**args)
66
- end
67
-
68
- # Update properties of this object
69
- def update!(**args)
70
- @description = args[:description] if args.key?(:description)
71
- @reason_code = args[:reason_code] if args.key?(:reason_code)
72
- end
73
- end
74
-
75
- # An error returned by the API.
76
- class Error
77
- include Google::Apis::Core::Hashable
78
-
79
- # The domain of the error.
80
- # Corresponds to the JSON property `domain`
81
- # @return [String]
82
- attr_accessor :domain
83
-
84
- # A description of the error.
85
- # Corresponds to the JSON property `message`
86
- # @return [String]
87
- attr_accessor :message
88
-
89
- # The error code.
90
- # Corresponds to the JSON property `reason`
91
- # @return [String]
92
- attr_accessor :reason
93
-
94
- def initialize(**args)
95
- update!(**args)
96
- end
97
-
98
- # Update properties of this object
99
- def update!(**args)
100
- @domain = args[:domain] if args.key?(:domain)
101
- @message = args[:message] if args.key?(:message)
102
- @reason = args[:reason] if args.key?(:reason)
103
- end
104
- end
105
-
106
- # A list of errors returned by a failed batch entry.
107
- class Errors
108
- include Google::Apis::Core::Hashable
109
-
110
- # The HTTP status of the first error in errors.
111
- # Corresponds to the JSON property `code`
112
- # @return [Fixnum]
113
- attr_accessor :code
114
-
115
- # A list of errors.
116
- # Corresponds to the JSON property `errors`
117
- # @return [Array<Google::Apis::ContentV2sandbox::Error>]
118
- attr_accessor :errors
119
-
120
- # The message of the first error in errors.
121
- # Corresponds to the JSON property `message`
122
- # @return [String]
123
- attr_accessor :message
124
-
125
- def initialize(**args)
126
- update!(**args)
127
- end
128
-
129
- # Update properties of this object
130
- def update!(**args)
131
- @code = args[:code] if args.key?(:code)
132
- @errors = args[:errors] if args.key?(:errors)
133
- @message = args[:message] if args.key?(:message)
134
- end
135
- end
136
-
137
- #
138
- class InvoiceSummary
139
- include Google::Apis::Core::Hashable
140
-
141
- # Summary of the total amounts of the additional charges.
142
- # Corresponds to the JSON property `additionalChargeSummaries`
143
- # @return [Array<Google::Apis::ContentV2sandbox::InvoiceSummaryAdditionalChargeSummary>]
144
- attr_accessor :additional_charge_summaries
145
-
146
- # [required] Customer balance on this invoice. A negative amount means the
147
- # customer is paying, a positive one means the customer is receiving money. Note:
148
- # the sum of merchant_balance, customer_balance and google_balance must always
149
- # be zero.
150
- # Furthermore the absolute value of this amount is expected to be equal to the
151
- # sum of product amount and additional charges, minus promotions.
152
- # Corresponds to the JSON property `customerBalance`
153
- # @return [Google::Apis::ContentV2sandbox::Amount]
154
- attr_accessor :customer_balance
155
-
156
- # [required] Google balance on this invoice. A negative amount means Google is
157
- # paying, a positive one means Google is receiving money. Note: the sum of
158
- # merchant_balance, customer_balance and google_balance must always be zero.
159
- # Corresponds to the JSON property `googleBalance`
160
- # @return [Google::Apis::ContentV2sandbox::Amount]
161
- attr_accessor :google_balance
162
-
163
- # [required] Merchant balance on this invoice. A negative amount means the
164
- # merchant is paying, a positive one means the merchant is receiving money. Note:
165
- # the sum of merchant_balance, customer_balance and google_balance must always
166
- # be zero.
167
- # Corresponds to the JSON property `merchantBalance`
168
- # @return [Google::Apis::ContentV2sandbox::Amount]
169
- attr_accessor :merchant_balance
170
-
171
- # [required] Total price for the product.
172
- # Corresponds to the JSON property `productTotal`
173
- # @return [Google::Apis::ContentV2sandbox::Amount]
174
- attr_accessor :product_total
175
-
176
- # Summary for each promotion.
177
- # Corresponds to the JSON property `promotionSummaries`
178
- # @return [Array<Google::Apis::ContentV2sandbox::Promotion>]
179
- attr_accessor :promotion_summaries
180
-
181
- def initialize(**args)
182
- update!(**args)
183
- end
184
-
185
- # Update properties of this object
186
- def update!(**args)
187
- @additional_charge_summaries = args[:additional_charge_summaries] if args.key?(:additional_charge_summaries)
188
- @customer_balance = args[:customer_balance] if args.key?(:customer_balance)
189
- @google_balance = args[:google_balance] if args.key?(:google_balance)
190
- @merchant_balance = args[:merchant_balance] if args.key?(:merchant_balance)
191
- @product_total = args[:product_total] if args.key?(:product_total)
192
- @promotion_summaries = args[:promotion_summaries] if args.key?(:promotion_summaries)
193
- end
194
- end
195
-
196
- #
197
- class InvoiceSummaryAdditionalChargeSummary
198
- include Google::Apis::Core::Hashable
199
-
200
- # [required] Total additional charge for this type.
201
- # Corresponds to the JSON property `totalAmount`
202
- # @return [Google::Apis::ContentV2sandbox::Amount]
203
- attr_accessor :total_amount
204
-
205
- # [required] Type of the additional charge.
206
- # Corresponds to the JSON property `type`
207
- # @return [String]
208
- attr_accessor :type
209
-
210
- def initialize(**args)
211
- update!(**args)
212
- end
213
-
214
- # Update properties of this object
215
- def update!(**args)
216
- @total_amount = args[:total_amount] if args.key?(:total_amount)
217
- @type = args[:type] if args.key?(:type)
218
- end
219
- end
220
-
221
- #
222
- class MerchantOrderReturn
223
- include Google::Apis::Core::Hashable
224
-
225
- #
226
- # Corresponds to the JSON property `creationDate`
227
- # @return [String]
228
- attr_accessor :creation_date
229
-
230
- #
231
- # Corresponds to the JSON property `merchantOrderId`
232
- # @return [String]
233
- attr_accessor :merchant_order_id
234
-
235
- #
236
- # Corresponds to the JSON property `orderId`
237
- # @return [String]
238
- attr_accessor :order_id
239
-
240
- #
241
- # Corresponds to the JSON property `orderReturnId`
242
- # @return [String]
243
- attr_accessor :order_return_id
244
-
245
- #
246
- # Corresponds to the JSON property `returnItems`
247
- # @return [Array<Google::Apis::ContentV2sandbox::MerchantOrderReturnItem>]
248
- attr_accessor :return_items
249
-
250
- #
251
- # Corresponds to the JSON property `returnShipments`
252
- # @return [Array<Google::Apis::ContentV2sandbox::ReturnShipment>]
253
- attr_accessor :return_shipments
254
-
255
- def initialize(**args)
256
- update!(**args)
257
- end
258
-
259
- # Update properties of this object
260
- def update!(**args)
261
- @creation_date = args[:creation_date] if args.key?(:creation_date)
262
- @merchant_order_id = args[:merchant_order_id] if args.key?(:merchant_order_id)
263
- @order_id = args[:order_id] if args.key?(:order_id)
264
- @order_return_id = args[:order_return_id] if args.key?(:order_return_id)
265
- @return_items = args[:return_items] if args.key?(:return_items)
266
- @return_shipments = args[:return_shipments] if args.key?(:return_shipments)
267
- end
268
- end
269
-
270
- #
271
- class MerchantOrderReturnItem
272
- include Google::Apis::Core::Hashable
273
-
274
- #
275
- # Corresponds to the JSON property `customerReturnReason`
276
- # @return [Google::Apis::ContentV2sandbox::CustomerReturnReason]
277
- attr_accessor :customer_return_reason
278
-
279
- #
280
- # Corresponds to the JSON property `itemId`
281
- # @return [String]
282
- attr_accessor :item_id
283
-
284
- #
285
- # Corresponds to the JSON property `merchantReturnReason`
286
- # @return [Google::Apis::ContentV2sandbox::RefundReason]
287
- attr_accessor :merchant_return_reason
288
-
289
- #
290
- # Corresponds to the JSON property `product`
291
- # @return [Google::Apis::ContentV2sandbox::OrderLineItemProduct]
292
- attr_accessor :product
293
-
294
- #
295
- # Corresponds to the JSON property `returnShipmentIds`
296
- # @return [Array<String>]
297
- attr_accessor :return_shipment_ids
298
-
299
- #
300
- # Corresponds to the JSON property `state`
301
- # @return [String]
302
- attr_accessor :state
303
-
304
- def initialize(**args)
305
- update!(**args)
306
- end
307
-
308
- # Update properties of this object
309
- def update!(**args)
310
- @customer_return_reason = args[:customer_return_reason] if args.key?(:customer_return_reason)
311
- @item_id = args[:item_id] if args.key?(:item_id)
312
- @merchant_return_reason = args[:merchant_return_reason] if args.key?(:merchant_return_reason)
313
- @product = args[:product] if args.key?(:product)
314
- @return_shipment_ids = args[:return_shipment_ids] if args.key?(:return_shipment_ids)
315
- @state = args[:state] if args.key?(:state)
316
- end
317
- end
318
-
319
- #
320
- class Order
321
- include Google::Apis::Core::Hashable
322
-
323
- # Whether the order was acknowledged.
324
- # Corresponds to the JSON property `acknowledged`
325
- # @return [Boolean]
326
- attr_accessor :acknowledged
327
- alias_method :acknowledged?, :acknowledged
328
-
329
- # The channel type of the order: "purchaseOnGoogle" or "googleExpress".
330
- # Corresponds to the JSON property `channelType`
331
- # @return [String]
332
- attr_accessor :channel_type
333
-
334
- # The details of the customer who placed the order.
335
- # Corresponds to the JSON property `customer`
336
- # @return [Google::Apis::ContentV2sandbox::OrderCustomer]
337
- attr_accessor :customer
338
-
339
- # The details for the delivery.
340
- # Corresponds to the JSON property `deliveryDetails`
341
- # @return [Google::Apis::ContentV2sandbox::OrderDeliveryDetails]
342
- attr_accessor :delivery_details
343
-
344
- # The REST id of the order. Globally unique.
345
- # Corresponds to the JSON property `id`
346
- # @return [String]
347
- attr_accessor :id
348
-
349
- # Identifies what kind of resource this is. Value: the fixed string "content#
350
- # order".
351
- # Corresponds to the JSON property `kind`
352
- # @return [String]
353
- attr_accessor :kind
354
-
355
- # Line items that are ordered.
356
- # Corresponds to the JSON property `lineItems`
357
- # @return [Array<Google::Apis::ContentV2sandbox::OrderLineItem>]
358
- attr_accessor :line_items
359
-
360
- #
361
- # Corresponds to the JSON property `merchantId`
362
- # @return [Fixnum]
363
- attr_accessor :merchant_id
364
-
365
- # Merchant-provided id of the order.
366
- # Corresponds to the JSON property `merchantOrderId`
367
- # @return [String]
368
- attr_accessor :merchant_order_id
369
-
370
- # The net amount for the order. For example, if an order was originally for a
371
- # grand total of $100 and a refund was issued for $20, the net amount will be $
372
- # 80.
373
- # Corresponds to the JSON property `netAmount`
374
- # @return [Google::Apis::ContentV2sandbox::Price]
375
- attr_accessor :net_amount
376
-
377
- # The details of the payment method.
378
- # Corresponds to the JSON property `paymentMethod`
379
- # @return [Google::Apis::ContentV2sandbox::OrderPaymentMethod]
380
- attr_accessor :payment_method
381
-
382
- # The status of the payment.
383
- # Corresponds to the JSON property `paymentStatus`
384
- # @return [String]
385
- attr_accessor :payment_status
386
-
387
- # The date when the order was placed, in ISO 8601 format.
388
- # Corresponds to the JSON property `placedDate`
389
- # @return [String]
390
- attr_accessor :placed_date
391
-
392
- # Deprecated. The details of the merchant provided promotions applied to the
393
- # order. More details about the program are here.
394
- # Corresponds to the JSON property `promotions`
395
- # @return [Array<Google::Apis::ContentV2sandbox::OrderLegacyPromotion>]
396
- attr_accessor :promotions
397
-
398
- # Refunds for the order.
399
- # Corresponds to the JSON property `refunds`
400
- # @return [Array<Google::Apis::ContentV2sandbox::OrderRefund>]
401
- attr_accessor :refunds
402
-
403
- # Shipments of the order.
404
- # Corresponds to the JSON property `shipments`
405
- # @return [Array<Google::Apis::ContentV2sandbox::OrderShipment>]
406
- attr_accessor :shipments
407
-
408
- # The total cost of shipping for all items.
409
- # Corresponds to the JSON property `shippingCost`
410
- # @return [Google::Apis::ContentV2sandbox::Price]
411
- attr_accessor :shipping_cost
412
-
413
- # The tax for the total shipping cost.
414
- # Corresponds to the JSON property `shippingCostTax`
415
- # @return [Google::Apis::ContentV2sandbox::Price]
416
- attr_accessor :shipping_cost_tax
417
-
418
- # The requested shipping option.
419
- # Corresponds to the JSON property `shippingOption`
420
- # @return [String]
421
- attr_accessor :shipping_option
422
-
423
- # The status of the order.
424
- # Corresponds to the JSON property `status`
425
- # @return [String]
426
- attr_accessor :status
427
-
428
- def initialize(**args)
429
- update!(**args)
430
- end
431
-
432
- # Update properties of this object
433
- def update!(**args)
434
- @acknowledged = args[:acknowledged] if args.key?(:acknowledged)
435
- @channel_type = args[:channel_type] if args.key?(:channel_type)
436
- @customer = args[:customer] if args.key?(:customer)
437
- @delivery_details = args[:delivery_details] if args.key?(:delivery_details)
438
- @id = args[:id] if args.key?(:id)
439
- @kind = args[:kind] if args.key?(:kind)
440
- @line_items = args[:line_items] if args.key?(:line_items)
441
- @merchant_id = args[:merchant_id] if args.key?(:merchant_id)
442
- @merchant_order_id = args[:merchant_order_id] if args.key?(:merchant_order_id)
443
- @net_amount = args[:net_amount] if args.key?(:net_amount)
444
- @payment_method = args[:payment_method] if args.key?(:payment_method)
445
- @payment_status = args[:payment_status] if args.key?(:payment_status)
446
- @placed_date = args[:placed_date] if args.key?(:placed_date)
447
- @promotions = args[:promotions] if args.key?(:promotions)
448
- @refunds = args[:refunds] if args.key?(:refunds)
449
- @shipments = args[:shipments] if args.key?(:shipments)
450
- @shipping_cost = args[:shipping_cost] if args.key?(:shipping_cost)
451
- @shipping_cost_tax = args[:shipping_cost_tax] if args.key?(:shipping_cost_tax)
452
- @shipping_option = args[:shipping_option] if args.key?(:shipping_option)
453
- @status = args[:status] if args.key?(:status)
454
- end
455
- end
456
-
457
- #
458
- class OrderAddress
459
- include Google::Apis::Core::Hashable
460
-
461
- # CLDR country code (e.g. "US").
462
- # Corresponds to the JSON property `country`
463
- # @return [String]
464
- attr_accessor :country
465
-
466
- # Strings representing the lines of the printed label for mailing the order, for
467
- # example:
468
- # John Smith
469
- # 1600 Amphitheatre Parkway
470
- # Mountain View, CA, 94043
471
- # United States
472
- # Corresponds to the JSON property `fullAddress`
473
- # @return [Array<String>]
474
- attr_accessor :full_address
475
-
476
- # Whether the address is a post office box.
477
- # Corresponds to the JSON property `isPostOfficeBox`
478
- # @return [Boolean]
479
- attr_accessor :is_post_office_box
480
- alias_method :is_post_office_box?, :is_post_office_box
481
-
482
- # City, town or commune. May also include dependent localities or sublocalities (
483
- # e.g. neighborhoods or suburbs).
484
- # Corresponds to the JSON property `locality`
485
- # @return [String]
486
- attr_accessor :locality
487
-
488
- # Postal Code or ZIP (e.g. "94043").
489
- # Corresponds to the JSON property `postalCode`
490
- # @return [String]
491
- attr_accessor :postal_code
492
-
493
- # Name of the recipient.
494
- # Corresponds to the JSON property `recipientName`
495
- # @return [String]
496
- attr_accessor :recipient_name
497
-
498
- # Top-level administrative subdivision of the country. For example, a state like
499
- # California ("CA") or a province like Quebec ("QC").
500
- # Corresponds to the JSON property `region`
501
- # @return [String]
502
- attr_accessor :region
503
-
504
- # Street-level part of the address.
505
- # Corresponds to the JSON property `streetAddress`
506
- # @return [Array<String>]
507
- attr_accessor :street_address
508
-
509
- def initialize(**args)
510
- update!(**args)
511
- end
512
-
513
- # Update properties of this object
514
- def update!(**args)
515
- @country = args[:country] if args.key?(:country)
516
- @full_address = args[:full_address] if args.key?(:full_address)
517
- @is_post_office_box = args[:is_post_office_box] if args.key?(:is_post_office_box)
518
- @locality = args[:locality] if args.key?(:locality)
519
- @postal_code = args[:postal_code] if args.key?(:postal_code)
520
- @recipient_name = args[:recipient_name] if args.key?(:recipient_name)
521
- @region = args[:region] if args.key?(:region)
522
- @street_address = args[:street_address] if args.key?(:street_address)
523
- end
524
- end
525
-
526
- #
527
- class OrderCancellation
528
- include Google::Apis::Core::Hashable
529
-
530
- # The actor that created the cancellation.
531
- # Corresponds to the JSON property `actor`
532
- # @return [String]
533
- attr_accessor :actor
534
-
535
- # Date on which the cancellation has been created, in ISO 8601 format.
536
- # Corresponds to the JSON property `creationDate`
537
- # @return [String]
538
- attr_accessor :creation_date
539
-
540
- # The quantity that was canceled.
541
- # Corresponds to the JSON property `quantity`
542
- # @return [Fixnum]
543
- attr_accessor :quantity
544
-
545
- # The reason for the cancellation. Orders that are cancelled with a noInventory
546
- # reason will lead to the removal of the product from Shopping Actions until you
547
- # make an update to that product. This will not affect your Shopping ads.
548
- # Corresponds to the JSON property `reason`
549
- # @return [String]
550
- attr_accessor :reason
551
-
552
- # The explanation of the reason.
553
- # Corresponds to the JSON property `reasonText`
554
- # @return [String]
555
- attr_accessor :reason_text
556
-
557
- def initialize(**args)
558
- update!(**args)
559
- end
560
-
561
- # Update properties of this object
562
- def update!(**args)
563
- @actor = args[:actor] if args.key?(:actor)
564
- @creation_date = args[:creation_date] if args.key?(:creation_date)
565
- @quantity = args[:quantity] if args.key?(:quantity)
566
- @reason = args[:reason] if args.key?(:reason)
567
- @reason_text = args[:reason_text] if args.key?(:reason_text)
568
- end
569
- end
570
-
571
- #
572
- class OrderCustomer
573
- include Google::Apis::Core::Hashable
574
-
575
- # Deprecated.
576
- # Corresponds to the JSON property `email`
577
- # @return [String]
578
- attr_accessor :email
579
-
580
- # Deprecated. Please use marketingRightsInfo instead.
581
- # Corresponds to the JSON property `explicitMarketingPreference`
582
- # @return [Boolean]
583
- attr_accessor :explicit_marketing_preference
584
- alias_method :explicit_marketing_preference?, :explicit_marketing_preference
585
-
586
- # Full name of the customer.
587
- # Corresponds to the JSON property `fullName`
588
- # @return [String]
589
- attr_accessor :full_name
590
-
591
- # Customer's marketing preferences.
592
- # Corresponds to the JSON property `marketingRightsInfo`
593
- # @return [Google::Apis::ContentV2sandbox::OrderCustomerMarketingRightsInfo]
594
- attr_accessor :marketing_rights_info
595
-
596
- def initialize(**args)
597
- update!(**args)
598
- end
599
-
600
- # Update properties of this object
601
- def update!(**args)
602
- @email = args[:email] if args.key?(:email)
603
- @explicit_marketing_preference = args[:explicit_marketing_preference] if args.key?(:explicit_marketing_preference)
604
- @full_name = args[:full_name] if args.key?(:full_name)
605
- @marketing_rights_info = args[:marketing_rights_info] if args.key?(:marketing_rights_info)
606
- end
607
- end
608
-
609
- #
610
- class OrderCustomerMarketingRightsInfo
611
- include Google::Apis::Core::Hashable
612
-
613
- # Last known user selection regarding marketing preferences. In certain cases
614
- # this selection might not be known, so this field would be empty.
615
- # Corresponds to the JSON property `explicitMarketingPreference`
616
- # @return [String]
617
- attr_accessor :explicit_marketing_preference
618
-
619
- # Timestamp when last time marketing preference was updated. Could be empty, if
620
- # user wasn't offered a selection yet.
621
- # Corresponds to the JSON property `lastUpdatedTimestamp`
622
- # @return [String]
623
- attr_accessor :last_updated_timestamp
624
-
625
- # Email address that can be used for marketing purposes. This field is only
626
- # filled when explicitMarketingPreference is equal to 'granted'.
627
- # Corresponds to the JSON property `marketingEmailAddress`
628
- # @return [String]
629
- attr_accessor :marketing_email_address
630
-
631
- def initialize(**args)
632
- update!(**args)
633
- end
634
-
635
- # Update properties of this object
636
- def update!(**args)
637
- @explicit_marketing_preference = args[:explicit_marketing_preference] if args.key?(:explicit_marketing_preference)
638
- @last_updated_timestamp = args[:last_updated_timestamp] if args.key?(:last_updated_timestamp)
639
- @marketing_email_address = args[:marketing_email_address] if args.key?(:marketing_email_address)
640
- end
641
- end
642
-
643
- #
644
- class OrderDeliveryDetails
645
- include Google::Apis::Core::Hashable
646
-
647
- # The delivery address
648
- # Corresponds to the JSON property `address`
649
- # @return [Google::Apis::ContentV2sandbox::OrderAddress]
650
- attr_accessor :address
651
-
652
- # The phone number of the person receiving the delivery.
653
- # Corresponds to the JSON property `phoneNumber`
654
- # @return [String]
655
- attr_accessor :phone_number
656
-
657
- def initialize(**args)
658
- update!(**args)
659
- end
660
-
661
- # Update properties of this object
662
- def update!(**args)
663
- @address = args[:address] if args.key?(:address)
664
- @phone_number = args[:phone_number] if args.key?(:phone_number)
665
- end
666
- end
667
-
668
- #
669
- class OrderLegacyPromotion
670
- include Google::Apis::Core::Hashable
671
-
672
- #
673
- # Corresponds to the JSON property `benefits`
674
- # @return [Array<Google::Apis::ContentV2sandbox::OrderLegacyPromotionBenefit>]
675
- attr_accessor :benefits
676
-
677
- # The date and time frame when the promotion is active and ready for validation
678
- # review. Note that the promotion live time may be delayed for a few hours due
679
- # to the validation review.
680
- # Start date and end date are separated by a forward slash (/). The start date
681
- # is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time
682
- # of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an
683
- # expression of the time zone for the sale. The end date is in the same format.
684
- # Corresponds to the JSON property `effectiveDates`
685
- # @return [String]
686
- attr_accessor :effective_dates
687
-
688
- # Optional. The text code that corresponds to the promotion when applied on the
689
- # retailer?s website.
690
- # Corresponds to the JSON property `genericRedemptionCode`
691
- # @return [String]
692
- attr_accessor :generic_redemption_code
693
-
694
- # The unique ID of the promotion.
695
- # Corresponds to the JSON property `id`
696
- # @return [String]
697
- attr_accessor :id
698
-
699
- # The full title of the promotion.
700
- # Corresponds to the JSON property `longTitle`
701
- # @return [String]
702
- attr_accessor :long_title
703
-
704
- # Whether the promotion is applicable to all products or only specific products.
705
- # Corresponds to the JSON property `productApplicability`
706
- # @return [String]
707
- attr_accessor :product_applicability
708
-
709
- # Indicates that the promotion is valid online.
710
- # Corresponds to the JSON property `redemptionChannel`
711
- # @return [String]
712
- attr_accessor :redemption_channel
713
-
714
- def initialize(**args)
715
- update!(**args)
716
- end
717
-
718
- # Update properties of this object
719
- def update!(**args)
720
- @benefits = args[:benefits] if args.key?(:benefits)
721
- @effective_dates = args[:effective_dates] if args.key?(:effective_dates)
722
- @generic_redemption_code = args[:generic_redemption_code] if args.key?(:generic_redemption_code)
723
- @id = args[:id] if args.key?(:id)
724
- @long_title = args[:long_title] if args.key?(:long_title)
725
- @product_applicability = args[:product_applicability] if args.key?(:product_applicability)
726
- @redemption_channel = args[:redemption_channel] if args.key?(:redemption_channel)
727
- end
728
- end
729
-
730
- #
731
- class OrderLegacyPromotionBenefit
732
- include Google::Apis::Core::Hashable
733
-
734
- # The discount in the order price when the promotion is applied.
735
- # Corresponds to the JSON property `discount`
736
- # @return [Google::Apis::ContentV2sandbox::Price]
737
- attr_accessor :discount
738
-
739
- # The OfferId(s) that were purchased in this order and map to this specific
740
- # benefit of the promotion.
741
- # Corresponds to the JSON property `offerIds`
742
- # @return [Array<String>]
743
- attr_accessor :offer_ids
744
-
745
- # Further describes the benefit of the promotion. Note that we will expand on
746
- # this enumeration as we support new promotion sub-types.
747
- # Corresponds to the JSON property `subType`
748
- # @return [String]
749
- attr_accessor :sub_type
750
-
751
- # The impact on tax when the promotion is applied.
752
- # Corresponds to the JSON property `taxImpact`
753
- # @return [Google::Apis::ContentV2sandbox::Price]
754
- attr_accessor :tax_impact
755
-
756
- # Describes whether the promotion applies to products (e.g. 20% off) or to
757
- # shipping (e.g. Free Shipping).
758
- # Corresponds to the JSON property `type`
759
- # @return [String]
760
- attr_accessor :type
761
-
762
- def initialize(**args)
763
- update!(**args)
764
- end
765
-
766
- # Update properties of this object
767
- def update!(**args)
768
- @discount = args[:discount] if args.key?(:discount)
769
- @offer_ids = args[:offer_ids] if args.key?(:offer_ids)
770
- @sub_type = args[:sub_type] if args.key?(:sub_type)
771
- @tax_impact = args[:tax_impact] if args.key?(:tax_impact)
772
- @type = args[:type] if args.key?(:type)
773
- end
774
- end
775
-
776
- #
777
- class OrderLineItem
778
- include Google::Apis::Core::Hashable
779
-
780
- # Annotations that are attached to the line item.
781
- # Corresponds to the JSON property `annotations`
782
- # @return [Array<Google::Apis::ContentV2sandbox::OrderMerchantProvidedAnnotation>]
783
- attr_accessor :annotations
784
-
785
- # Cancellations of the line item.
786
- # Corresponds to the JSON property `cancellations`
787
- # @return [Array<Google::Apis::ContentV2sandbox::OrderCancellation>]
788
- attr_accessor :cancellations
789
-
790
- # The id of the line item.
791
- # Corresponds to the JSON property `id`
792
- # @return [String]
793
- attr_accessor :id
794
-
795
- # Total price for the line item. For example, if two items for $10 are purchased,
796
- # the total price will be $20.
797
- # Corresponds to the JSON property `price`
798
- # @return [Google::Apis::ContentV2sandbox::Price]
799
- attr_accessor :price
800
-
801
- # Product data from the time of the order placement.
802
- # Corresponds to the JSON property `product`
803
- # @return [Google::Apis::ContentV2sandbox::OrderLineItemProduct]
804
- attr_accessor :product
805
-
806
- # Number of items canceled.
807
- # Corresponds to the JSON property `quantityCanceled`
808
- # @return [Fixnum]
809
- attr_accessor :quantity_canceled
810
-
811
- # Number of items delivered.
812
- # Corresponds to the JSON property `quantityDelivered`
813
- # @return [Fixnum]
814
- attr_accessor :quantity_delivered
815
-
816
- # Number of items ordered.
817
- # Corresponds to the JSON property `quantityOrdered`
818
- # @return [Fixnum]
819
- attr_accessor :quantity_ordered
820
-
821
- # Number of items pending.
822
- # Corresponds to the JSON property `quantityPending`
823
- # @return [Fixnum]
824
- attr_accessor :quantity_pending
825
-
826
- # Number of items returned.
827
- # Corresponds to the JSON property `quantityReturned`
828
- # @return [Fixnum]
829
- attr_accessor :quantity_returned
830
-
831
- # Number of items shipped.
832
- # Corresponds to the JSON property `quantityShipped`
833
- # @return [Fixnum]
834
- attr_accessor :quantity_shipped
835
-
836
- # Details of the return policy for the line item.
837
- # Corresponds to the JSON property `returnInfo`
838
- # @return [Google::Apis::ContentV2sandbox::OrderLineItemReturnInfo]
839
- attr_accessor :return_info
840
-
841
- # Returns of the line item.
842
- # Corresponds to the JSON property `returns`
843
- # @return [Array<Google::Apis::ContentV2sandbox::OrderReturn>]
844
- attr_accessor :returns
845
-
846
- # Details of the requested shipping for the line item.
847
- # Corresponds to the JSON property `shippingDetails`
848
- # @return [Google::Apis::ContentV2sandbox::OrderLineItemShippingDetails]
849
- attr_accessor :shipping_details
850
-
851
- # Total tax amount for the line item. For example, if two items are purchased,
852
- # and each have a cost tax of $2, the total tax amount will be $4.
853
- # Corresponds to the JSON property `tax`
854
- # @return [Google::Apis::ContentV2sandbox::Price]
855
- attr_accessor :tax
856
-
857
- def initialize(**args)
858
- update!(**args)
859
- end
860
-
861
- # Update properties of this object
862
- def update!(**args)
863
- @annotations = args[:annotations] if args.key?(:annotations)
864
- @cancellations = args[:cancellations] if args.key?(:cancellations)
865
- @id = args[:id] if args.key?(:id)
866
- @price = args[:price] if args.key?(:price)
867
- @product = args[:product] if args.key?(:product)
868
- @quantity_canceled = args[:quantity_canceled] if args.key?(:quantity_canceled)
869
- @quantity_delivered = args[:quantity_delivered] if args.key?(:quantity_delivered)
870
- @quantity_ordered = args[:quantity_ordered] if args.key?(:quantity_ordered)
871
- @quantity_pending = args[:quantity_pending] if args.key?(:quantity_pending)
872
- @quantity_returned = args[:quantity_returned] if args.key?(:quantity_returned)
873
- @quantity_shipped = args[:quantity_shipped] if args.key?(:quantity_shipped)
874
- @return_info = args[:return_info] if args.key?(:return_info)
875
- @returns = args[:returns] if args.key?(:returns)
876
- @shipping_details = args[:shipping_details] if args.key?(:shipping_details)
877
- @tax = args[:tax] if args.key?(:tax)
878
- end
879
- end
880
-
881
- #
882
- class OrderLineItemProduct
883
- include Google::Apis::Core::Hashable
884
-
885
- # Brand of the item.
886
- # Corresponds to the JSON property `brand`
887
- # @return [String]
888
- attr_accessor :brand
889
-
890
- # The item's channel (online or local).
891
- # Corresponds to the JSON property `channel`
892
- # @return [String]
893
- attr_accessor :channel
894
-
895
- # Condition or state of the item.
896
- # Corresponds to the JSON property `condition`
897
- # @return [String]
898
- attr_accessor :condition
899
-
900
- # The two-letter ISO 639-1 language code for the item.
901
- # Corresponds to the JSON property `contentLanguage`
902
- # @return [String]
903
- attr_accessor :content_language
904
-
905
- # Global Trade Item Number (GTIN) of the item.
906
- # Corresponds to the JSON property `gtin`
907
- # @return [String]
908
- attr_accessor :gtin
909
-
910
- # The REST id of the product.
911
- # Corresponds to the JSON property `id`
912
- # @return [String]
913
- attr_accessor :id
914
-
915
- # URL of an image of the item.
916
- # Corresponds to the JSON property `imageLink`
917
- # @return [String]
918
- attr_accessor :image_link
919
-
920
- # Shared identifier for all variants of the same product.
921
- # Corresponds to the JSON property `itemGroupId`
922
- # @return [String]
923
- attr_accessor :item_group_id
924
-
925
- # Manufacturer Part Number (MPN) of the item.
926
- # Corresponds to the JSON property `mpn`
927
- # @return [String]
928
- attr_accessor :mpn
929
-
930
- # An identifier of the item.
931
- # Corresponds to the JSON property `offerId`
932
- # @return [String]
933
- attr_accessor :offer_id
934
-
935
- # Price of the item.
936
- # Corresponds to the JSON property `price`
937
- # @return [Google::Apis::ContentV2sandbox::Price]
938
- attr_accessor :price
939
-
940
- # URL to the cached image shown to the user when order was placed.
941
- # Corresponds to the JSON property `shownImage`
942
- # @return [String]
943
- attr_accessor :shown_image
944
-
945
- # The CLDR territory code of the target country of the product.
946
- # Corresponds to the JSON property `targetCountry`
947
- # @return [String]
948
- attr_accessor :target_country
949
-
950
- # The title of the product.
951
- # Corresponds to the JSON property `title`
952
- # @return [String]
953
- attr_accessor :title
954
-
955
- # Variant attributes for the item. These are dimensions of the product, such as
956
- # color, gender, material, pattern, and size. You can find a comprehensive list
957
- # of variant attributes here.
958
- # Corresponds to the JSON property `variantAttributes`
959
- # @return [Array<Google::Apis::ContentV2sandbox::OrderLineItemProductVariantAttribute>]
960
- attr_accessor :variant_attributes
961
-
962
- def initialize(**args)
963
- update!(**args)
964
- end
965
-
966
- # Update properties of this object
967
- def update!(**args)
968
- @brand = args[:brand] if args.key?(:brand)
969
- @channel = args[:channel] if args.key?(:channel)
970
- @condition = args[:condition] if args.key?(:condition)
971
- @content_language = args[:content_language] if args.key?(:content_language)
972
- @gtin = args[:gtin] if args.key?(:gtin)
973
- @id = args[:id] if args.key?(:id)
974
- @image_link = args[:image_link] if args.key?(:image_link)
975
- @item_group_id = args[:item_group_id] if args.key?(:item_group_id)
976
- @mpn = args[:mpn] if args.key?(:mpn)
977
- @offer_id = args[:offer_id] if args.key?(:offer_id)
978
- @price = args[:price] if args.key?(:price)
979
- @shown_image = args[:shown_image] if args.key?(:shown_image)
980
- @target_country = args[:target_country] if args.key?(:target_country)
981
- @title = args[:title] if args.key?(:title)
982
- @variant_attributes = args[:variant_attributes] if args.key?(:variant_attributes)
983
- end
984
- end
985
-
986
- #
987
- class OrderLineItemProductVariantAttribute
988
- include Google::Apis::Core::Hashable
989
-
990
- # The dimension of the variant.
991
- # Corresponds to the JSON property `dimension`
992
- # @return [String]
993
- attr_accessor :dimension
994
-
995
- # The value for the dimension.
996
- # Corresponds to the JSON property `value`
997
- # @return [String]
998
- attr_accessor :value
999
-
1000
- def initialize(**args)
1001
- update!(**args)
1002
- end
1003
-
1004
- # Update properties of this object
1005
- def update!(**args)
1006
- @dimension = args[:dimension] if args.key?(:dimension)
1007
- @value = args[:value] if args.key?(:value)
1008
- end
1009
- end
1010
-
1011
- #
1012
- class OrderLineItemReturnInfo
1013
- include Google::Apis::Core::Hashable
1014
-
1015
- # How many days later the item can be returned.
1016
- # Corresponds to the JSON property `daysToReturn`
1017
- # @return [Fixnum]
1018
- attr_accessor :days_to_return
1019
-
1020
- # Whether the item is returnable.
1021
- # Corresponds to the JSON property `isReturnable`
1022
- # @return [Boolean]
1023
- attr_accessor :is_returnable
1024
- alias_method :is_returnable?, :is_returnable
1025
-
1026
- # URL of the item return policy.
1027
- # Corresponds to the JSON property `policyUrl`
1028
- # @return [String]
1029
- attr_accessor :policy_url
1030
-
1031
- def initialize(**args)
1032
- update!(**args)
1033
- end
1034
-
1035
- # Update properties of this object
1036
- def update!(**args)
1037
- @days_to_return = args[:days_to_return] if args.key?(:days_to_return)
1038
- @is_returnable = args[:is_returnable] if args.key?(:is_returnable)
1039
- @policy_url = args[:policy_url] if args.key?(:policy_url)
1040
- end
1041
- end
1042
-
1043
- #
1044
- class OrderLineItemShippingDetails
1045
- include Google::Apis::Core::Hashable
1046
-
1047
- # The delivery by date, in ISO 8601 format.
1048
- # Corresponds to the JSON property `deliverByDate`
1049
- # @return [String]
1050
- attr_accessor :deliver_by_date
1051
-
1052
- # Details of the shipping method.
1053
- # Corresponds to the JSON property `method`
1054
- # @return [Google::Apis::ContentV2sandbox::OrderLineItemShippingDetailsMethod]
1055
- attr_accessor :method_prop
1056
-
1057
- # The ship by date, in ISO 8601 format.
1058
- # Corresponds to the JSON property `shipByDate`
1059
- # @return [String]
1060
- attr_accessor :ship_by_date
1061
-
1062
- def initialize(**args)
1063
- update!(**args)
1064
- end
1065
-
1066
- # Update properties of this object
1067
- def update!(**args)
1068
- @deliver_by_date = args[:deliver_by_date] if args.key?(:deliver_by_date)
1069
- @method_prop = args[:method_prop] if args.key?(:method_prop)
1070
- @ship_by_date = args[:ship_by_date] if args.key?(:ship_by_date)
1071
- end
1072
- end
1073
-
1074
- #
1075
- class OrderLineItemShippingDetailsMethod
1076
- include Google::Apis::Core::Hashable
1077
-
1078
- # The carrier for the shipping. Optional. See shipments[].carrier for a list of
1079
- # acceptable values.
1080
- # Corresponds to the JSON property `carrier`
1081
- # @return [String]
1082
- attr_accessor :carrier
1083
-
1084
- # Maximum transit time.
1085
- # Corresponds to the JSON property `maxDaysInTransit`
1086
- # @return [Fixnum]
1087
- attr_accessor :max_days_in_transit
1088
-
1089
- # The name of the shipping method.
1090
- # Corresponds to the JSON property `methodName`
1091
- # @return [String]
1092
- attr_accessor :method_name
1093
-
1094
- # Minimum transit time.
1095
- # Corresponds to the JSON property `minDaysInTransit`
1096
- # @return [Fixnum]
1097
- attr_accessor :min_days_in_transit
1098
-
1099
- def initialize(**args)
1100
- update!(**args)
1101
- end
1102
-
1103
- # Update properties of this object
1104
- def update!(**args)
1105
- @carrier = args[:carrier] if args.key?(:carrier)
1106
- @max_days_in_transit = args[:max_days_in_transit] if args.key?(:max_days_in_transit)
1107
- @method_name = args[:method_name] if args.key?(:method_name)
1108
- @min_days_in_transit = args[:min_days_in_transit] if args.key?(:min_days_in_transit)
1109
- end
1110
- end
1111
-
1112
- #
1113
- class OrderMerchantProvidedAnnotation
1114
- include Google::Apis::Core::Hashable
1115
-
1116
- # Key for additional merchant provided (as key-value pairs) annotation about the
1117
- # line item.
1118
- # Corresponds to the JSON property `key`
1119
- # @return [String]
1120
- attr_accessor :key
1121
-
1122
- # Value for additional merchant provided (as key-value pairs) annotation about
1123
- # the line item.
1124
- # Corresponds to the JSON property `value`
1125
- # @return [String]
1126
- attr_accessor :value
1127
-
1128
- def initialize(**args)
1129
- update!(**args)
1130
- end
1131
-
1132
- # Update properties of this object
1133
- def update!(**args)
1134
- @key = args[:key] if args.key?(:key)
1135
- @value = args[:value] if args.key?(:value)
1136
- end
1137
- end
1138
-
1139
- #
1140
- class OrderPaymentMethod
1141
- include Google::Apis::Core::Hashable
1142
-
1143
- # The billing address.
1144
- # Corresponds to the JSON property `billingAddress`
1145
- # @return [Google::Apis::ContentV2sandbox::OrderAddress]
1146
- attr_accessor :billing_address
1147
-
1148
- # The card expiration month (January = 1, February = 2 etc.).
1149
- # Corresponds to the JSON property `expirationMonth`
1150
- # @return [Fixnum]
1151
- attr_accessor :expiration_month
1152
-
1153
- # The card expiration year (4-digit, e.g. 2015).
1154
- # Corresponds to the JSON property `expirationYear`
1155
- # @return [Fixnum]
1156
- attr_accessor :expiration_year
1157
-
1158
- # The last four digits of the card number.
1159
- # Corresponds to the JSON property `lastFourDigits`
1160
- # @return [String]
1161
- attr_accessor :last_four_digits
1162
-
1163
- # The billing phone number.
1164
- # Corresponds to the JSON property `phoneNumber`
1165
- # @return [String]
1166
- attr_accessor :phone_number
1167
-
1168
- # The type of instrument.
1169
- # Acceptable values are:
1170
- # - "AMEX"
1171
- # - "DISCOVER"
1172
- # - "JCB"
1173
- # - "MASTERCARD"
1174
- # - "UNIONPAY"
1175
- # - "VISA"
1176
- # - ""
1177
- # Corresponds to the JSON property `type`
1178
- # @return [String]
1179
- attr_accessor :type
1180
-
1181
- def initialize(**args)
1182
- update!(**args)
1183
- end
1184
-
1185
- # Update properties of this object
1186
- def update!(**args)
1187
- @billing_address = args[:billing_address] if args.key?(:billing_address)
1188
- @expiration_month = args[:expiration_month] if args.key?(:expiration_month)
1189
- @expiration_year = args[:expiration_year] if args.key?(:expiration_year)
1190
- @last_four_digits = args[:last_four_digits] if args.key?(:last_four_digits)
1191
- @phone_number = args[:phone_number] if args.key?(:phone_number)
1192
- @type = args[:type] if args.key?(:type)
1193
- end
1194
- end
1195
-
1196
- #
1197
- class OrderRefund
1198
- include Google::Apis::Core::Hashable
1199
-
1200
- # The actor that created the refund.
1201
- # Corresponds to the JSON property `actor`
1202
- # @return [String]
1203
- attr_accessor :actor
1204
-
1205
- # The amount that is refunded.
1206
- # Corresponds to the JSON property `amount`
1207
- # @return [Google::Apis::ContentV2sandbox::Price]
1208
- attr_accessor :amount
1209
-
1210
- # Date on which the item has been created, in ISO 8601 format.
1211
- # Corresponds to the JSON property `creationDate`
1212
- # @return [String]
1213
- attr_accessor :creation_date
1214
-
1215
- # The reason for the refund.
1216
- # Corresponds to the JSON property `reason`
1217
- # @return [String]
1218
- attr_accessor :reason
1219
-
1220
- # The explanation of the reason.
1221
- # Corresponds to the JSON property `reasonText`
1222
- # @return [String]
1223
- attr_accessor :reason_text
1224
-
1225
- def initialize(**args)
1226
- update!(**args)
1227
- end
1228
-
1229
- # Update properties of this object
1230
- def update!(**args)
1231
- @actor = args[:actor] if args.key?(:actor)
1232
- @amount = args[:amount] if args.key?(:amount)
1233
- @creation_date = args[:creation_date] if args.key?(:creation_date)
1234
- @reason = args[:reason] if args.key?(:reason)
1235
- @reason_text = args[:reason_text] if args.key?(:reason_text)
1236
- end
1237
- end
1238
-
1239
- #
1240
- class OrderReturn
1241
- include Google::Apis::Core::Hashable
1242
-
1243
- # The actor that created the refund.
1244
- # Corresponds to the JSON property `actor`
1245
- # @return [String]
1246
- attr_accessor :actor
1247
-
1248
- # Date on which the item has been created, in ISO 8601 format.
1249
- # Corresponds to the JSON property `creationDate`
1250
- # @return [String]
1251
- attr_accessor :creation_date
1252
-
1253
- # Quantity that is returned.
1254
- # Corresponds to the JSON property `quantity`
1255
- # @return [Fixnum]
1256
- attr_accessor :quantity
1257
-
1258
- # The reason for the return.
1259
- # Corresponds to the JSON property `reason`
1260
- # @return [String]
1261
- attr_accessor :reason
1262
-
1263
- # The explanation of the reason.
1264
- # Corresponds to the JSON property `reasonText`
1265
- # @return [String]
1266
- attr_accessor :reason_text
1267
-
1268
- def initialize(**args)
1269
- update!(**args)
1270
- end
1271
-
1272
- # Update properties of this object
1273
- def update!(**args)
1274
- @actor = args[:actor] if args.key?(:actor)
1275
- @creation_date = args[:creation_date] if args.key?(:creation_date)
1276
- @quantity = args[:quantity] if args.key?(:quantity)
1277
- @reason = args[:reason] if args.key?(:reason)
1278
- @reason_text = args[:reason_text] if args.key?(:reason_text)
1279
- end
1280
- end
1281
-
1282
- #
1283
- class OrderShipment
1284
- include Google::Apis::Core::Hashable
1285
-
1286
- # The carrier handling the shipment.
1287
- # Acceptable values are:
1288
- # - "gsx"
1289
- # - "ups"
1290
- # - "usps"
1291
- # - "fedex"
1292
- # - "dhl"
1293
- # - "ecourier"
1294
- # - "cxt"
1295
- # - "google"
1296
- # - "ontrac"
1297
- # - "emsy"
1298
- # - "ont"
1299
- # - "deliv"
1300
- # - "dynamex"
1301
- # - "lasership"
1302
- # - "mpx"
1303
- # - "uds"
1304
- # Corresponds to the JSON property `carrier`
1305
- # @return [String]
1306
- attr_accessor :carrier
1307
-
1308
- # Date on which the shipment has been created, in ISO 8601 format.
1309
- # Corresponds to the JSON property `creationDate`
1310
- # @return [String]
1311
- attr_accessor :creation_date
1312
-
1313
- # Date on which the shipment has been delivered, in ISO 8601 format. Present
1314
- # only if status is delivered
1315
- # Corresponds to the JSON property `deliveryDate`
1316
- # @return [String]
1317
- attr_accessor :delivery_date
1318
-
1319
- # The id of the shipment.
1320
- # Corresponds to the JSON property `id`
1321
- # @return [String]
1322
- attr_accessor :id
1323
-
1324
- # The line items that are shipped.
1325
- # Corresponds to the JSON property `lineItems`
1326
- # @return [Array<Google::Apis::ContentV2sandbox::OrderShipmentLineItemShipment>]
1327
- attr_accessor :line_items
1328
-
1329
- # The status of the shipment.
1330
- # Corresponds to the JSON property `status`
1331
- # @return [String]
1332
- attr_accessor :status
1333
-
1334
- # The tracking id for the shipment.
1335
- # Corresponds to the JSON property `trackingId`
1336
- # @return [String]
1337
- attr_accessor :tracking_id
1338
-
1339
- def initialize(**args)
1340
- update!(**args)
1341
- end
1342
-
1343
- # Update properties of this object
1344
- def update!(**args)
1345
- @carrier = args[:carrier] if args.key?(:carrier)
1346
- @creation_date = args[:creation_date] if args.key?(:creation_date)
1347
- @delivery_date = args[:delivery_date] if args.key?(:delivery_date)
1348
- @id = args[:id] if args.key?(:id)
1349
- @line_items = args[:line_items] if args.key?(:line_items)
1350
- @status = args[:status] if args.key?(:status)
1351
- @tracking_id = args[:tracking_id] if args.key?(:tracking_id)
1352
- end
1353
- end
1354
-
1355
- #
1356
- class OrderShipmentLineItemShipment
1357
- include Google::Apis::Core::Hashable
1358
-
1359
- # The id of the line item that is shipped. Either lineItemId or productId is
1360
- # required.
1361
- # Corresponds to the JSON property `lineItemId`
1362
- # @return [String]
1363
- attr_accessor :line_item_id
1364
-
1365
- # The ID of the product to ship. This is the REST ID used in the products
1366
- # service. Either lineItemId or productId is required.
1367
- # Corresponds to the JSON property `productId`
1368
- # @return [String]
1369
- attr_accessor :product_id
1370
-
1371
- # The quantity that is shipped.
1372
- # Corresponds to the JSON property `quantity`
1373
- # @return [Fixnum]
1374
- attr_accessor :quantity
1375
-
1376
- def initialize(**args)
1377
- update!(**args)
1378
- end
1379
-
1380
- # Update properties of this object
1381
- def update!(**args)
1382
- @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
1383
- @product_id = args[:product_id] if args.key?(:product_id)
1384
- @quantity = args[:quantity] if args.key?(:quantity)
1385
- end
1386
- end
1387
-
1388
- #
1389
- class OrderinvoicesCreateChargeInvoiceRequest
1390
- include Google::Apis::Core::Hashable
1391
-
1392
- # [required] The ID of the invoice.
1393
- # Corresponds to the JSON property `invoiceId`
1394
- # @return [String]
1395
- attr_accessor :invoice_id
1396
-
1397
- # [required] Invoice summary.
1398
- # Corresponds to the JSON property `invoiceSummary`
1399
- # @return [Google::Apis::ContentV2sandbox::InvoiceSummary]
1400
- attr_accessor :invoice_summary
1401
-
1402
- # [required] Invoice details per line item.
1403
- # Corresponds to the JSON property `lineItemInvoices`
1404
- # @return [Array<Google::Apis::ContentV2sandbox::ShipmentInvoiceLineItemInvoice>]
1405
- attr_accessor :line_item_invoices
1406
-
1407
- # [required] The ID of the operation, unique across all operations for a given
1408
- # order.
1409
- # Corresponds to the JSON property `operationId`
1410
- # @return [String]
1411
- attr_accessor :operation_id
1412
-
1413
- # [required] ID of the shipment group.
1414
- # Corresponds to the JSON property `shipmentGroupId`
1415
- # @return [String]
1416
- attr_accessor :shipment_group_id
1417
-
1418
- def initialize(**args)
1419
- update!(**args)
1420
- end
1421
-
1422
- # Update properties of this object
1423
- def update!(**args)
1424
- @invoice_id = args[:invoice_id] if args.key?(:invoice_id)
1425
- @invoice_summary = args[:invoice_summary] if args.key?(:invoice_summary)
1426
- @line_item_invoices = args[:line_item_invoices] if args.key?(:line_item_invoices)
1427
- @operation_id = args[:operation_id] if args.key?(:operation_id)
1428
- @shipment_group_id = args[:shipment_group_id] if args.key?(:shipment_group_id)
1429
- end
1430
- end
1431
-
1432
- #
1433
- class OrderinvoicesCreateChargeInvoiceResponse
1434
- include Google::Apis::Core::Hashable
1435
-
1436
- # The status of the execution.
1437
- # Corresponds to the JSON property `executionStatus`
1438
- # @return [String]
1439
- attr_accessor :execution_status
1440
-
1441
- # Identifies what kind of resource this is. Value: the fixed string "content#
1442
- # orderinvoicesCreateChargeInvoiceResponse".
1443
- # Corresponds to the JSON property `kind`
1444
- # @return [String]
1445
- attr_accessor :kind
1446
-
1447
- def initialize(**args)
1448
- update!(**args)
1449
- end
1450
-
1451
- # Update properties of this object
1452
- def update!(**args)
1453
- @execution_status = args[:execution_status] if args.key?(:execution_status)
1454
- @kind = args[:kind] if args.key?(:kind)
1455
- end
1456
- end
1457
-
1458
- #
1459
- class OrderinvoicesCreateRefundInvoiceRequest
1460
- include Google::Apis::Core::Hashable
1461
-
1462
- # [required] The ID of the invoice.
1463
- # Corresponds to the JSON property `invoiceId`
1464
- # @return [String]
1465
- attr_accessor :invoice_id
1466
-
1467
- # [required] The ID of the operation, unique across all operations for a given
1468
- # order.
1469
- # Corresponds to the JSON property `operationId`
1470
- # @return [String]
1471
- attr_accessor :operation_id
1472
-
1473
- # Option to create a refund-only invoice. Exactly one of refundOnlyOption or
1474
- # returnOption must be provided.
1475
- # Corresponds to the JSON property `refundOnlyOption`
1476
- # @return [Google::Apis::ContentV2sandbox::OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption]
1477
- attr_accessor :refund_only_option
1478
-
1479
- # Option to create an invoice for a refund and mark all items within the invoice
1480
- # as returned. Exactly one of refundOnlyOption or returnOption must be provided.
1481
- # Corresponds to the JSON property `returnOption`
1482
- # @return [Google::Apis::ContentV2sandbox::OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption]
1483
- attr_accessor :return_option
1484
-
1485
- # Invoice details for different shipment groups.
1486
- # Corresponds to the JSON property `shipmentInvoices`
1487
- # @return [Array<Google::Apis::ContentV2sandbox::ShipmentInvoice>]
1488
- attr_accessor :shipment_invoices
1489
-
1490
- def initialize(**args)
1491
- update!(**args)
1492
- end
1493
-
1494
- # Update properties of this object
1495
- def update!(**args)
1496
- @invoice_id = args[:invoice_id] if args.key?(:invoice_id)
1497
- @operation_id = args[:operation_id] if args.key?(:operation_id)
1498
- @refund_only_option = args[:refund_only_option] if args.key?(:refund_only_option)
1499
- @return_option = args[:return_option] if args.key?(:return_option)
1500
- @shipment_invoices = args[:shipment_invoices] if args.key?(:shipment_invoices)
1501
- end
1502
- end
1503
-
1504
- #
1505
- class OrderinvoicesCreateRefundInvoiceResponse
1506
- include Google::Apis::Core::Hashable
1507
-
1508
- # The status of the execution.
1509
- # Corresponds to the JSON property `executionStatus`
1510
- # @return [String]
1511
- attr_accessor :execution_status
1512
-
1513
- # Identifies what kind of resource this is. Value: the fixed string "content#
1514
- # orderinvoicesCreateRefundInvoiceResponse".
1515
- # Corresponds to the JSON property `kind`
1516
- # @return [String]
1517
- attr_accessor :kind
1518
-
1519
- def initialize(**args)
1520
- update!(**args)
1521
- end
1522
-
1523
- # Update properties of this object
1524
- def update!(**args)
1525
- @execution_status = args[:execution_status] if args.key?(:execution_status)
1526
- @kind = args[:kind] if args.key?(:kind)
1527
- end
1528
- end
1529
-
1530
- #
1531
- class OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption
1532
- include Google::Apis::Core::Hashable
1533
-
1534
- # Optional description of the refund reason.
1535
- # Corresponds to the JSON property `description`
1536
- # @return [String]
1537
- attr_accessor :description
1538
-
1539
- # [required] Reason for the refund.
1540
- # Corresponds to the JSON property `reason`
1541
- # @return [String]
1542
- attr_accessor :reason
1543
-
1544
- def initialize(**args)
1545
- update!(**args)
1546
- end
1547
-
1548
- # Update properties of this object
1549
- def update!(**args)
1550
- @description = args[:description] if args.key?(:description)
1551
- @reason = args[:reason] if args.key?(:reason)
1552
- end
1553
- end
1554
-
1555
- #
1556
- class OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption
1557
- include Google::Apis::Core::Hashable
1558
-
1559
- # Optional description of the return reason.
1560
- # Corresponds to the JSON property `description`
1561
- # @return [String]
1562
- attr_accessor :description
1563
-
1564
- # [required] Reason for the return.
1565
- # Corresponds to the JSON property `reason`
1566
- # @return [String]
1567
- attr_accessor :reason
1568
-
1569
- def initialize(**args)
1570
- update!(**args)
1571
- end
1572
-
1573
- # Update properties of this object
1574
- def update!(**args)
1575
- @description = args[:description] if args.key?(:description)
1576
- @reason = args[:reason] if args.key?(:reason)
1577
- end
1578
- end
1579
-
1580
- #
1581
- class OrderpaymentsNotifyAuthApprovedRequest
1582
- include Google::Apis::Core::Hashable
1583
-
1584
- #
1585
- # Corresponds to the JSON property `authAmountPretax`
1586
- # @return [Google::Apis::ContentV2sandbox::Price]
1587
- attr_accessor :auth_amount_pretax
1588
-
1589
- #
1590
- # Corresponds to the JSON property `authAmountTax`
1591
- # @return [Google::Apis::ContentV2sandbox::Price]
1592
- attr_accessor :auth_amount_tax
1593
-
1594
- def initialize(**args)
1595
- update!(**args)
1596
- end
1597
-
1598
- # Update properties of this object
1599
- def update!(**args)
1600
- @auth_amount_pretax = args[:auth_amount_pretax] if args.key?(:auth_amount_pretax)
1601
- @auth_amount_tax = args[:auth_amount_tax] if args.key?(:auth_amount_tax)
1602
- end
1603
- end
1604
-
1605
- #
1606
- class OrderpaymentsNotifyAuthApprovedResponse
1607
- include Google::Apis::Core::Hashable
1608
-
1609
- # The status of the execution.
1610
- # Corresponds to the JSON property `executionStatus`
1611
- # @return [String]
1612
- attr_accessor :execution_status
1613
-
1614
- # Identifies what kind of resource this is. Value: the fixed string "content#
1615
- # orderpaymentsNotifyAuthApprovedResponse".
1616
- # Corresponds to the JSON property `kind`
1617
- # @return [String]
1618
- attr_accessor :kind
1619
-
1620
- def initialize(**args)
1621
- update!(**args)
1622
- end
1623
-
1624
- # Update properties of this object
1625
- def update!(**args)
1626
- @execution_status = args[:execution_status] if args.key?(:execution_status)
1627
- @kind = args[:kind] if args.key?(:kind)
1628
- end
1629
- end
1630
-
1631
- #
1632
- class OrderpaymentsNotifyAuthDeclinedRequest
1633
- include Google::Apis::Core::Hashable
1634
-
1635
- # Reason why payment authorization was declined.
1636
- # Corresponds to the JSON property `declineReason`
1637
- # @return [String]
1638
- attr_accessor :decline_reason
1639
-
1640
- def initialize(**args)
1641
- update!(**args)
1642
- end
1643
-
1644
- # Update properties of this object
1645
- def update!(**args)
1646
- @decline_reason = args[:decline_reason] if args.key?(:decline_reason)
1647
- end
1648
- end
1649
-
1650
- #
1651
- class OrderpaymentsNotifyAuthDeclinedResponse
1652
- include Google::Apis::Core::Hashable
1653
-
1654
- # The status of the execution.
1655
- # Corresponds to the JSON property `executionStatus`
1656
- # @return [String]
1657
- attr_accessor :execution_status
1658
-
1659
- # Identifies what kind of resource this is. Value: the fixed string "content#
1660
- # orderpaymentsNotifyAuthDeclinedResponse".
1661
- # Corresponds to the JSON property `kind`
1662
- # @return [String]
1663
- attr_accessor :kind
1664
-
1665
- def initialize(**args)
1666
- update!(**args)
1667
- end
1668
-
1669
- # Update properties of this object
1670
- def update!(**args)
1671
- @execution_status = args[:execution_status] if args.key?(:execution_status)
1672
- @kind = args[:kind] if args.key?(:kind)
1673
- end
1674
- end
1675
-
1676
- #
1677
- class OrderpaymentsNotifyChargeRequest
1678
- include Google::Apis::Core::Hashable
1679
-
1680
- # Whether charge was successful.
1681
- # Corresponds to the JSON property `chargeState`
1682
- # @return [String]
1683
- attr_accessor :charge_state
1684
-
1685
- # Deprecated. Please use invoiceIds instead.
1686
- # Corresponds to the JSON property `invoiceId`
1687
- # @return [String]
1688
- attr_accessor :invoice_id
1689
-
1690
- # Invoice IDs from the orderinvoices service that correspond to the charge.
1691
- # Corresponds to the JSON property `invoiceIds`
1692
- # @return [Array<String>]
1693
- attr_accessor :invoice_ids
1694
-
1695
- def initialize(**args)
1696
- update!(**args)
1697
- end
1698
-
1699
- # Update properties of this object
1700
- def update!(**args)
1701
- @charge_state = args[:charge_state] if args.key?(:charge_state)
1702
- @invoice_id = args[:invoice_id] if args.key?(:invoice_id)
1703
- @invoice_ids = args[:invoice_ids] if args.key?(:invoice_ids)
1704
- end
1705
- end
1706
-
1707
- #
1708
- class OrderpaymentsNotifyChargeResponse
1709
- include Google::Apis::Core::Hashable
1710
-
1711
- # The status of the execution.
1712
- # Corresponds to the JSON property `executionStatus`
1713
- # @return [String]
1714
- attr_accessor :execution_status
1715
-
1716
- # Identifies what kind of resource this is. Value: the fixed string "content#
1717
- # orderpaymentsNotifyChargeResponse".
1718
- # Corresponds to the JSON property `kind`
1719
- # @return [String]
1720
- attr_accessor :kind
1721
-
1722
- def initialize(**args)
1723
- update!(**args)
1724
- end
1725
-
1726
- # Update properties of this object
1727
- def update!(**args)
1728
- @execution_status = args[:execution_status] if args.key?(:execution_status)
1729
- @kind = args[:kind] if args.key?(:kind)
1730
- end
1731
- end
1732
-
1733
- #
1734
- class OrderpaymentsNotifyRefundRequest
1735
- include Google::Apis::Core::Hashable
1736
-
1737
- # Deprecated. Please use invoiceIds instead.
1738
- # Corresponds to the JSON property `invoiceId`
1739
- # @return [String]
1740
- attr_accessor :invoice_id
1741
-
1742
- # Invoice IDs from the orderinvoices service that correspond to the refund.
1743
- # Corresponds to the JSON property `invoiceIds`
1744
- # @return [Array<String>]
1745
- attr_accessor :invoice_ids
1746
-
1747
- # Whether refund was successful.
1748
- # Corresponds to the JSON property `refundState`
1749
- # @return [String]
1750
- attr_accessor :refund_state
1751
-
1752
- def initialize(**args)
1753
- update!(**args)
1754
- end
1755
-
1756
- # Update properties of this object
1757
- def update!(**args)
1758
- @invoice_id = args[:invoice_id] if args.key?(:invoice_id)
1759
- @invoice_ids = args[:invoice_ids] if args.key?(:invoice_ids)
1760
- @refund_state = args[:refund_state] if args.key?(:refund_state)
1761
- end
1762
- end
1763
-
1764
- #
1765
- class OrderpaymentsNotifyRefundResponse
1766
- include Google::Apis::Core::Hashable
1767
-
1768
- # The status of the execution.
1769
- # Corresponds to the JSON property `executionStatus`
1770
- # @return [String]
1771
- attr_accessor :execution_status
1772
-
1773
- # Identifies what kind of resource this is. Value: the fixed string "content#
1774
- # orderpaymentsNotifyRefundResponse".
1775
- # Corresponds to the JSON property `kind`
1776
- # @return [String]
1777
- attr_accessor :kind
1778
-
1779
- def initialize(**args)
1780
- update!(**args)
1781
- end
1782
-
1783
- # Update properties of this object
1784
- def update!(**args)
1785
- @execution_status = args[:execution_status] if args.key?(:execution_status)
1786
- @kind = args[:kind] if args.key?(:kind)
1787
- end
1788
- end
1789
-
1790
- #
1791
- class OrderreturnsListResponse
1792
- include Google::Apis::Core::Hashable
1793
-
1794
- # Identifies what kind of resource this is. Value: the fixed string "content#
1795
- # orderreturnsListResponse".
1796
- # Corresponds to the JSON property `kind`
1797
- # @return [String]
1798
- attr_accessor :kind
1799
-
1800
- # The token for the retrieval of the next page of returns.
1801
- # Corresponds to the JSON property `nextPageToken`
1802
- # @return [String]
1803
- attr_accessor :next_page_token
1804
-
1805
- #
1806
- # Corresponds to the JSON property `resources`
1807
- # @return [Array<Google::Apis::ContentV2sandbox::MerchantOrderReturn>]
1808
- attr_accessor :resources
1809
-
1810
- def initialize(**args)
1811
- update!(**args)
1812
- end
1813
-
1814
- # Update properties of this object
1815
- def update!(**args)
1816
- @kind = args[:kind] if args.key?(:kind)
1817
- @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1818
- @resources = args[:resources] if args.key?(:resources)
1819
- end
1820
- end
1821
-
1822
- #
1823
- class OrdersAcknowledgeRequest
1824
- include Google::Apis::Core::Hashable
1825
-
1826
- # The ID of the operation. Unique across all operations for a given order.
1827
- # Corresponds to the JSON property `operationId`
1828
- # @return [String]
1829
- attr_accessor :operation_id
1830
-
1831
- def initialize(**args)
1832
- update!(**args)
1833
- end
1834
-
1835
- # Update properties of this object
1836
- def update!(**args)
1837
- @operation_id = args[:operation_id] if args.key?(:operation_id)
1838
- end
1839
- end
1840
-
1841
- #
1842
- class OrdersAcknowledgeResponse
1843
- include Google::Apis::Core::Hashable
1844
-
1845
- # The status of the execution.
1846
- # Corresponds to the JSON property `executionStatus`
1847
- # @return [String]
1848
- attr_accessor :execution_status
1849
-
1850
- # Identifies what kind of resource this is. Value: the fixed string "content#
1851
- # ordersAcknowledgeResponse".
1852
- # Corresponds to the JSON property `kind`
1853
- # @return [String]
1854
- attr_accessor :kind
1855
-
1856
- def initialize(**args)
1857
- update!(**args)
1858
- end
1859
-
1860
- # Update properties of this object
1861
- def update!(**args)
1862
- @execution_status = args[:execution_status] if args.key?(:execution_status)
1863
- @kind = args[:kind] if args.key?(:kind)
1864
- end
1865
- end
1866
-
1867
- #
1868
- class OrdersAdvanceTestOrderResponse
1869
- include Google::Apis::Core::Hashable
1870
-
1871
- # Identifies what kind of resource this is. Value: the fixed string "content#
1872
- # ordersAdvanceTestOrderResponse".
1873
- # Corresponds to the JSON property `kind`
1874
- # @return [String]
1875
- attr_accessor :kind
1876
-
1877
- def initialize(**args)
1878
- update!(**args)
1879
- end
1880
-
1881
- # Update properties of this object
1882
- def update!(**args)
1883
- @kind = args[:kind] if args.key?(:kind)
1884
- end
1885
- end
1886
-
1887
- #
1888
- class OrdersCancelLineItemRequest
1889
- include Google::Apis::Core::Hashable
1890
-
1891
- # Deprecated. Please use amountPretax and amountTax instead.
1892
- # Corresponds to the JSON property `amount`
1893
- # @return [Google::Apis::ContentV2sandbox::Price]
1894
- attr_accessor :amount
1895
-
1896
- # Amount to refund for the cancelation. Optional. If not set, Google will
1897
- # calculate the default based on the price and tax of the items involved. The
1898
- # amount must not be larger than the net amount left on the order.
1899
- # Corresponds to the JSON property `amountPretax`
1900
- # @return [Google::Apis::ContentV2sandbox::Price]
1901
- attr_accessor :amount_pretax
1902
-
1903
- # Tax amount that correspond to cancellation amount in amountPretax.
1904
- # Corresponds to the JSON property `amountTax`
1905
- # @return [Google::Apis::ContentV2sandbox::Price]
1906
- attr_accessor :amount_tax
1907
-
1908
- # The ID of the line item to cancel. Either lineItemId or productId is required.
1909
- # Corresponds to the JSON property `lineItemId`
1910
- # @return [String]
1911
- attr_accessor :line_item_id
1912
-
1913
- # The ID of the operation. Unique across all operations for a given order.
1914
- # Corresponds to the JSON property `operationId`
1915
- # @return [String]
1916
- attr_accessor :operation_id
1917
-
1918
- # The ID of the product to cancel. This is the REST ID used in the products
1919
- # service. Either lineItemId or productId is required.
1920
- # Corresponds to the JSON property `productId`
1921
- # @return [String]
1922
- attr_accessor :product_id
1923
-
1924
- # The quantity to cancel.
1925
- # Corresponds to the JSON property `quantity`
1926
- # @return [Fixnum]
1927
- attr_accessor :quantity
1928
-
1929
- # The reason for the cancellation.
1930
- # Corresponds to the JSON property `reason`
1931
- # @return [String]
1932
- attr_accessor :reason
1933
-
1934
- # The explanation of the reason.
1935
- # Corresponds to the JSON property `reasonText`
1936
- # @return [String]
1937
- attr_accessor :reason_text
1938
-
1939
- def initialize(**args)
1940
- update!(**args)
1941
- end
1942
-
1943
- # Update properties of this object
1944
- def update!(**args)
1945
- @amount = args[:amount] if args.key?(:amount)
1946
- @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax)
1947
- @amount_tax = args[:amount_tax] if args.key?(:amount_tax)
1948
- @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
1949
- @operation_id = args[:operation_id] if args.key?(:operation_id)
1950
- @product_id = args[:product_id] if args.key?(:product_id)
1951
- @quantity = args[:quantity] if args.key?(:quantity)
1952
- @reason = args[:reason] if args.key?(:reason)
1953
- @reason_text = args[:reason_text] if args.key?(:reason_text)
1954
- end
1955
- end
1956
-
1957
- #
1958
- class OrdersCancelLineItemResponse
1959
- include Google::Apis::Core::Hashable
1960
-
1961
- # The status of the execution.
1962
- # Corresponds to the JSON property `executionStatus`
1963
- # @return [String]
1964
- attr_accessor :execution_status
1965
-
1966
- # Identifies what kind of resource this is. Value: the fixed string "content#
1967
- # ordersCancelLineItemResponse".
1968
- # Corresponds to the JSON property `kind`
1969
- # @return [String]
1970
- attr_accessor :kind
1971
-
1972
- def initialize(**args)
1973
- update!(**args)
1974
- end
1975
-
1976
- # Update properties of this object
1977
- def update!(**args)
1978
- @execution_status = args[:execution_status] if args.key?(:execution_status)
1979
- @kind = args[:kind] if args.key?(:kind)
1980
- end
1981
- end
1982
-
1983
- #
1984
- class OrdersCancelRequest
1985
- include Google::Apis::Core::Hashable
1986
-
1987
- # The ID of the operation. Unique across all operations for a given order.
1988
- # Corresponds to the JSON property `operationId`
1989
- # @return [String]
1990
- attr_accessor :operation_id
1991
-
1992
- # The reason for the cancellation.
1993
- # Corresponds to the JSON property `reason`
1994
- # @return [String]
1995
- attr_accessor :reason
1996
-
1997
- # The explanation of the reason.
1998
- # Corresponds to the JSON property `reasonText`
1999
- # @return [String]
2000
- attr_accessor :reason_text
2001
-
2002
- def initialize(**args)
2003
- update!(**args)
2004
- end
2005
-
2006
- # Update properties of this object
2007
- def update!(**args)
2008
- @operation_id = args[:operation_id] if args.key?(:operation_id)
2009
- @reason = args[:reason] if args.key?(:reason)
2010
- @reason_text = args[:reason_text] if args.key?(:reason_text)
2011
- end
2012
- end
2013
-
2014
- #
2015
- class OrdersCancelResponse
2016
- include Google::Apis::Core::Hashable
2017
-
2018
- # The status of the execution.
2019
- # Corresponds to the JSON property `executionStatus`
2020
- # @return [String]
2021
- attr_accessor :execution_status
2022
-
2023
- # Identifies what kind of resource this is. Value: the fixed string "content#
2024
- # ordersCancelResponse".
2025
- # Corresponds to the JSON property `kind`
2026
- # @return [String]
2027
- attr_accessor :kind
2028
-
2029
- def initialize(**args)
2030
- update!(**args)
2031
- end
2032
-
2033
- # Update properties of this object
2034
- def update!(**args)
2035
- @execution_status = args[:execution_status] if args.key?(:execution_status)
2036
- @kind = args[:kind] if args.key?(:kind)
2037
- end
2038
- end
2039
-
2040
- #
2041
- class OrdersCancelTestOrderByCustomerRequest
2042
- include Google::Apis::Core::Hashable
2043
-
2044
- # The reason for the cancellation.
2045
- # Corresponds to the JSON property `reason`
2046
- # @return [String]
2047
- attr_accessor :reason
2048
-
2049
- def initialize(**args)
2050
- update!(**args)
2051
- end
2052
-
2053
- # Update properties of this object
2054
- def update!(**args)
2055
- @reason = args[:reason] if args.key?(:reason)
2056
- end
2057
- end
2058
-
2059
- #
2060
- class OrdersCancelTestOrderByCustomerResponse
2061
- include Google::Apis::Core::Hashable
2062
-
2063
- # Identifies what kind of resource this is. Value: the fixed string "content#
2064
- # ordersCancelTestOrderByCustomerResponse".
2065
- # Corresponds to the JSON property `kind`
2066
- # @return [String]
2067
- attr_accessor :kind
2068
-
2069
- def initialize(**args)
2070
- update!(**args)
2071
- end
2072
-
2073
- # Update properties of this object
2074
- def update!(**args)
2075
- @kind = args[:kind] if args.key?(:kind)
2076
- end
2077
- end
2078
-
2079
- #
2080
- class OrdersCreateTestOrderRequest
2081
- include Google::Apis::Core::Hashable
2082
-
2083
- # The CLDR territory code of the country of the test order to create. Affects
2084
- # the currency and addresses of orders created via template_name, or the
2085
- # addresses of orders created via test_order.
2086
- # Acceptable values are:
2087
- # - "US"
2088
- # - "FR" Defaults to US.
2089
- # Corresponds to the JSON property `country`
2090
- # @return [String]
2091
- attr_accessor :country
2092
-
2093
- # The test order template to use. Specify as an alternative to testOrder as a
2094
- # shortcut for retrieving a template and then creating an order using that
2095
- # template.
2096
- # Corresponds to the JSON property `templateName`
2097
- # @return [String]
2098
- attr_accessor :template_name
2099
-
2100
- # The test order to create.
2101
- # Corresponds to the JSON property `testOrder`
2102
- # @return [Google::Apis::ContentV2sandbox::TestOrder]
2103
- attr_accessor :test_order
2104
-
2105
- def initialize(**args)
2106
- update!(**args)
2107
- end
2108
-
2109
- # Update properties of this object
2110
- def update!(**args)
2111
- @country = args[:country] if args.key?(:country)
2112
- @template_name = args[:template_name] if args.key?(:template_name)
2113
- @test_order = args[:test_order] if args.key?(:test_order)
2114
- end
2115
- end
2116
-
2117
- #
2118
- class OrdersCreateTestOrderResponse
2119
- include Google::Apis::Core::Hashable
2120
-
2121
- # Identifies what kind of resource this is. Value: the fixed string "content#
2122
- # ordersCreateTestOrderResponse".
2123
- # Corresponds to the JSON property `kind`
2124
- # @return [String]
2125
- attr_accessor :kind
2126
-
2127
- # The ID of the newly created test order.
2128
- # Corresponds to the JSON property `orderId`
2129
- # @return [String]
2130
- attr_accessor :order_id
2131
-
2132
- def initialize(**args)
2133
- update!(**args)
2134
- end
2135
-
2136
- # Update properties of this object
2137
- def update!(**args)
2138
- @kind = args[:kind] if args.key?(:kind)
2139
- @order_id = args[:order_id] if args.key?(:order_id)
2140
- end
2141
- end
2142
-
2143
- #
2144
- class OrdersCreateTestReturnRequest
2145
- include Google::Apis::Core::Hashable
2146
-
2147
- # Returned items.
2148
- # Corresponds to the JSON property `items`
2149
- # @return [Array<Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryCreateTestReturnReturnItem>]
2150
- attr_accessor :items
2151
-
2152
- def initialize(**args)
2153
- update!(**args)
2154
- end
2155
-
2156
- # Update properties of this object
2157
- def update!(**args)
2158
- @items = args[:items] if args.key?(:items)
2159
- end
2160
- end
2161
-
2162
- #
2163
- class OrdersCreateTestReturnResponse
2164
- include Google::Apis::Core::Hashable
2165
-
2166
- # Identifies what kind of resource this is. Value: the fixed string "content#
2167
- # ordersCreateTestReturnResponse".
2168
- # Corresponds to the JSON property `kind`
2169
- # @return [String]
2170
- attr_accessor :kind
2171
-
2172
- # The ID of the newly created test order return.
2173
- # Corresponds to the JSON property `returnId`
2174
- # @return [String]
2175
- attr_accessor :return_id
2176
-
2177
- def initialize(**args)
2178
- update!(**args)
2179
- end
2180
-
2181
- # Update properties of this object
2182
- def update!(**args)
2183
- @kind = args[:kind] if args.key?(:kind)
2184
- @return_id = args[:return_id] if args.key?(:return_id)
2185
- end
2186
- end
2187
-
2188
- #
2189
- class OrdersCustomBatchRequest
2190
- include Google::Apis::Core::Hashable
2191
-
2192
- # The request entries to be processed in the batch.
2193
- # Corresponds to the JSON property `entries`
2194
- # @return [Array<Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntry>]
2195
- attr_accessor :entries
2196
-
2197
- def initialize(**args)
2198
- update!(**args)
2199
- end
2200
-
2201
- # Update properties of this object
2202
- def update!(**args)
2203
- @entries = args[:entries] if args.key?(:entries)
2204
- end
2205
- end
2206
-
2207
- #
2208
- class OrdersCustomBatchRequestEntry
2209
- include Google::Apis::Core::Hashable
2210
-
2211
- # An entry ID, unique within the batch request.
2212
- # Corresponds to the JSON property `batchId`
2213
- # @return [Fixnum]
2214
- attr_accessor :batch_id
2215
-
2216
- # Required for cancel method.
2217
- # Corresponds to the JSON property `cancel`
2218
- # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryCancel]
2219
- attr_accessor :cancel
2220
-
2221
- # Required for cancelLineItem method.
2222
- # Corresponds to the JSON property `cancelLineItem`
2223
- # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryCancelLineItem]
2224
- attr_accessor :cancel_line_item
2225
-
2226
- # Required for inStoreReturnLineItem method.
2227
- # Corresponds to the JSON property `inStoreRefundLineItem`
2228
- # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryInStoreRefundLineItem]
2229
- attr_accessor :in_store_refund_line_item
2230
-
2231
- # The ID of the managing account.
2232
- # Corresponds to the JSON property `merchantId`
2233
- # @return [Fixnum]
2234
- attr_accessor :merchant_id
2235
-
2236
- # The merchant order id. Required for updateMerchantOrderId and
2237
- # getByMerchantOrderId methods.
2238
- # Corresponds to the JSON property `merchantOrderId`
2239
- # @return [String]
2240
- attr_accessor :merchant_order_id
2241
-
2242
- # The method to apply.
2243
- # Corresponds to the JSON property `method`
2244
- # @return [String]
2245
- attr_accessor :method_prop
2246
-
2247
- # The ID of the operation. Unique across all operations for a given order.
2248
- # Required for all methods beside get and getByMerchantOrderId.
2249
- # Corresponds to the JSON property `operationId`
2250
- # @return [String]
2251
- attr_accessor :operation_id
2252
-
2253
- # The ID of the order. Required for all methods beside getByMerchantOrderId.
2254
- # Corresponds to the JSON property `orderId`
2255
- # @return [String]
2256
- attr_accessor :order_id
2257
-
2258
- # Required for refund method.
2259
- # Corresponds to the JSON property `refund`
2260
- # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryRefund]
2261
- attr_accessor :refund
2262
-
2263
- # Required for rejectReturnLineItem method.
2264
- # Corresponds to the JSON property `rejectReturnLineItem`
2265
- # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryRejectReturnLineItem]
2266
- attr_accessor :reject_return_line_item
2267
-
2268
- # Required for returnLineItem method.
2269
- # Corresponds to the JSON property `returnLineItem`
2270
- # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryReturnLineItem]
2271
- attr_accessor :return_line_item
2272
-
2273
- # Required for returnRefundLineItem method.
2274
- # Corresponds to the JSON property `returnRefundLineItem`
2275
- # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryReturnRefundLineItem]
2276
- attr_accessor :return_refund_line_item
2277
-
2278
- # Required for setLineItemMetadata method.
2279
- # Corresponds to the JSON property `setLineItemMetadata`
2280
- # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntrySetLineItemMetadata]
2281
- attr_accessor :set_line_item_metadata
2282
-
2283
- # Required for shipLineItems method.
2284
- # Corresponds to the JSON property `shipLineItems`
2285
- # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryShipLineItems]
2286
- attr_accessor :ship_line_items
2287
-
2288
- # Required for updateLineItemShippingDate method.
2289
- # Corresponds to the JSON property `updateLineItemShippingDetails`
2290
- # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails]
2291
- attr_accessor :update_line_item_shipping_details
2292
-
2293
- # Required for updateShipment method.
2294
- # Corresponds to the JSON property `updateShipment`
2295
- # @return [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryUpdateShipment]
2296
- attr_accessor :update_shipment
2297
-
2298
- def initialize(**args)
2299
- update!(**args)
2300
- end
2301
-
2302
- # Update properties of this object
2303
- def update!(**args)
2304
- @batch_id = args[:batch_id] if args.key?(:batch_id)
2305
- @cancel = args[:cancel] if args.key?(:cancel)
2306
- @cancel_line_item = args[:cancel_line_item] if args.key?(:cancel_line_item)
2307
- @in_store_refund_line_item = args[:in_store_refund_line_item] if args.key?(:in_store_refund_line_item)
2308
- @merchant_id = args[:merchant_id] if args.key?(:merchant_id)
2309
- @merchant_order_id = args[:merchant_order_id] if args.key?(:merchant_order_id)
2310
- @method_prop = args[:method_prop] if args.key?(:method_prop)
2311
- @operation_id = args[:operation_id] if args.key?(:operation_id)
2312
- @order_id = args[:order_id] if args.key?(:order_id)
2313
- @refund = args[:refund] if args.key?(:refund)
2314
- @reject_return_line_item = args[:reject_return_line_item] if args.key?(:reject_return_line_item)
2315
- @return_line_item = args[:return_line_item] if args.key?(:return_line_item)
2316
- @return_refund_line_item = args[:return_refund_line_item] if args.key?(:return_refund_line_item)
2317
- @set_line_item_metadata = args[:set_line_item_metadata] if args.key?(:set_line_item_metadata)
2318
- @ship_line_items = args[:ship_line_items] if args.key?(:ship_line_items)
2319
- @update_line_item_shipping_details = args[:update_line_item_shipping_details] if args.key?(:update_line_item_shipping_details)
2320
- @update_shipment = args[:update_shipment] if args.key?(:update_shipment)
2321
- end
2322
- end
2323
-
2324
- #
2325
- class OrdersCustomBatchRequestEntryCancel
2326
- include Google::Apis::Core::Hashable
2327
-
2328
- # The reason for the cancellation.
2329
- # Corresponds to the JSON property `reason`
2330
- # @return [String]
2331
- attr_accessor :reason
2332
-
2333
- # The explanation of the reason.
2334
- # Corresponds to the JSON property `reasonText`
2335
- # @return [String]
2336
- attr_accessor :reason_text
2337
-
2338
- def initialize(**args)
2339
- update!(**args)
2340
- end
2341
-
2342
- # Update properties of this object
2343
- def update!(**args)
2344
- @reason = args[:reason] if args.key?(:reason)
2345
- @reason_text = args[:reason_text] if args.key?(:reason_text)
2346
- end
2347
- end
2348
-
2349
- #
2350
- class OrdersCustomBatchRequestEntryCancelLineItem
2351
- include Google::Apis::Core::Hashable
2352
-
2353
- # Deprecated. Please use amountPretax and amountTax instead.
2354
- # Corresponds to the JSON property `amount`
2355
- # @return [Google::Apis::ContentV2sandbox::Price]
2356
- attr_accessor :amount
2357
-
2358
- # Amount to refund for the cancelation. Optional. If not set, Google will
2359
- # calculate the default based on the price and tax of the items involved. The
2360
- # amount must not be larger than the net amount left on the order.
2361
- # Corresponds to the JSON property `amountPretax`
2362
- # @return [Google::Apis::ContentV2sandbox::Price]
2363
- attr_accessor :amount_pretax
2364
-
2365
- # Tax amount that correspond to cancellation amount in amountPretax.
2366
- # Corresponds to the JSON property `amountTax`
2367
- # @return [Google::Apis::ContentV2sandbox::Price]
2368
- attr_accessor :amount_tax
2369
-
2370
- # The ID of the line item to cancel. Either lineItemId or productId is required.
2371
- # Corresponds to the JSON property `lineItemId`
2372
- # @return [String]
2373
- attr_accessor :line_item_id
2374
-
2375
- # The ID of the product to cancel. This is the REST ID used in the products
2376
- # service. Either lineItemId or productId is required.
2377
- # Corresponds to the JSON property `productId`
2378
- # @return [String]
2379
- attr_accessor :product_id
2380
-
2381
- # The quantity to cancel.
2382
- # Corresponds to the JSON property `quantity`
2383
- # @return [Fixnum]
2384
- attr_accessor :quantity
2385
-
2386
- # The reason for the cancellation.
2387
- # Corresponds to the JSON property `reason`
2388
- # @return [String]
2389
- attr_accessor :reason
2390
-
2391
- # The explanation of the reason.
2392
- # Corresponds to the JSON property `reasonText`
2393
- # @return [String]
2394
- attr_accessor :reason_text
2395
-
2396
- def initialize(**args)
2397
- update!(**args)
2398
- end
2399
-
2400
- # Update properties of this object
2401
- def update!(**args)
2402
- @amount = args[:amount] if args.key?(:amount)
2403
- @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax)
2404
- @amount_tax = args[:amount_tax] if args.key?(:amount_tax)
2405
- @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
2406
- @product_id = args[:product_id] if args.key?(:product_id)
2407
- @quantity = args[:quantity] if args.key?(:quantity)
2408
- @reason = args[:reason] if args.key?(:reason)
2409
- @reason_text = args[:reason_text] if args.key?(:reason_text)
2410
- end
2411
- end
2412
-
2413
- #
2414
- class OrdersCustomBatchRequestEntryCreateTestReturnReturnItem
2415
- include Google::Apis::Core::Hashable
2416
-
2417
- # The ID of the line item to return.
2418
- # Corresponds to the JSON property `lineItemId`
2419
- # @return [String]
2420
- attr_accessor :line_item_id
2421
-
2422
- # Quantity that is returned.
2423
- # Corresponds to the JSON property `quantity`
2424
- # @return [Fixnum]
2425
- attr_accessor :quantity
2426
-
2427
- def initialize(**args)
2428
- update!(**args)
2429
- end
2430
-
2431
- # Update properties of this object
2432
- def update!(**args)
2433
- @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
2434
- @quantity = args[:quantity] if args.key?(:quantity)
2435
- end
2436
- end
2437
-
2438
- #
2439
- class OrdersCustomBatchRequestEntryInStoreRefundLineItem
2440
- include Google::Apis::Core::Hashable
2441
-
2442
- # The amount that is refunded. Required.
2443
- # Corresponds to the JSON property `amountPretax`
2444
- # @return [Google::Apis::ContentV2sandbox::Price]
2445
- attr_accessor :amount_pretax
2446
-
2447
- # Tax amount that correspond to refund amount in amountPretax. Required.
2448
- # Corresponds to the JSON property `amountTax`
2449
- # @return [Google::Apis::ContentV2sandbox::Price]
2450
- attr_accessor :amount_tax
2451
-
2452
- # The ID of the line item to return. Either lineItemId or productId is required.
2453
- # Corresponds to the JSON property `lineItemId`
2454
- # @return [String]
2455
- attr_accessor :line_item_id
2456
-
2457
- # The ID of the product to return. This is the REST ID used in the products
2458
- # service. Either lineItemId or productId is required.
2459
- # Corresponds to the JSON property `productId`
2460
- # @return [String]
2461
- attr_accessor :product_id
2462
-
2463
- # The quantity to return and refund.
2464
- # Corresponds to the JSON property `quantity`
2465
- # @return [Fixnum]
2466
- attr_accessor :quantity
2467
-
2468
- # The reason for the return.
2469
- # Corresponds to the JSON property `reason`
2470
- # @return [String]
2471
- attr_accessor :reason
2472
-
2473
- # The explanation of the reason.
2474
- # Corresponds to the JSON property `reasonText`
2475
- # @return [String]
2476
- attr_accessor :reason_text
2477
-
2478
- def initialize(**args)
2479
- update!(**args)
2480
- end
2481
-
2482
- # Update properties of this object
2483
- def update!(**args)
2484
- @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax)
2485
- @amount_tax = args[:amount_tax] if args.key?(:amount_tax)
2486
- @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
2487
- @product_id = args[:product_id] if args.key?(:product_id)
2488
- @quantity = args[:quantity] if args.key?(:quantity)
2489
- @reason = args[:reason] if args.key?(:reason)
2490
- @reason_text = args[:reason_text] if args.key?(:reason_text)
2491
- end
2492
- end
2493
-
2494
- #
2495
- class OrdersCustomBatchRequestEntryRefund
2496
- include Google::Apis::Core::Hashable
2497
-
2498
- # Deprecated. Please use amountPretax and amountTax instead.
2499
- # Corresponds to the JSON property `amount`
2500
- # @return [Google::Apis::ContentV2sandbox::Price]
2501
- attr_accessor :amount
2502
-
2503
- # The amount that is refunded. Either amount or amountPretax and amountTax
2504
- # should be filled.
2505
- # Corresponds to the JSON property `amountPretax`
2506
- # @return [Google::Apis::ContentV2sandbox::Price]
2507
- attr_accessor :amount_pretax
2508
-
2509
- # Tax amount that correspond to refund amount in amountPretax.
2510
- # Corresponds to the JSON property `amountTax`
2511
- # @return [Google::Apis::ContentV2sandbox::Price]
2512
- attr_accessor :amount_tax
2513
-
2514
- # The reason for the refund.
2515
- # Corresponds to the JSON property `reason`
2516
- # @return [String]
2517
- attr_accessor :reason
2518
-
2519
- # The explanation of the reason.
2520
- # Corresponds to the JSON property `reasonText`
2521
- # @return [String]
2522
- attr_accessor :reason_text
2523
-
2524
- def initialize(**args)
2525
- update!(**args)
2526
- end
2527
-
2528
- # Update properties of this object
2529
- def update!(**args)
2530
- @amount = args[:amount] if args.key?(:amount)
2531
- @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax)
2532
- @amount_tax = args[:amount_tax] if args.key?(:amount_tax)
2533
- @reason = args[:reason] if args.key?(:reason)
2534
- @reason_text = args[:reason_text] if args.key?(:reason_text)
2535
- end
2536
- end
2537
-
2538
- #
2539
- class OrdersCustomBatchRequestEntryRejectReturnLineItem
2540
- include Google::Apis::Core::Hashable
2541
-
2542
- # The ID of the line item to return. Either lineItemId or productId is required.
2543
- # Corresponds to the JSON property `lineItemId`
2544
- # @return [String]
2545
- attr_accessor :line_item_id
2546
-
2547
- # The ID of the product to return. This is the REST ID used in the products
2548
- # service. Either lineItemId or productId is required.
2549
- # Corresponds to the JSON property `productId`
2550
- # @return [String]
2551
- attr_accessor :product_id
2552
-
2553
- # The quantity to return and refund.
2554
- # Corresponds to the JSON property `quantity`
2555
- # @return [Fixnum]
2556
- attr_accessor :quantity
2557
-
2558
- # The reason for the return.
2559
- # Corresponds to the JSON property `reason`
2560
- # @return [String]
2561
- attr_accessor :reason
2562
-
2563
- # The explanation of the reason.
2564
- # Corresponds to the JSON property `reasonText`
2565
- # @return [String]
2566
- attr_accessor :reason_text
2567
-
2568
- def initialize(**args)
2569
- update!(**args)
2570
- end
2571
-
2572
- # Update properties of this object
2573
- def update!(**args)
2574
- @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
2575
- @product_id = args[:product_id] if args.key?(:product_id)
2576
- @quantity = args[:quantity] if args.key?(:quantity)
2577
- @reason = args[:reason] if args.key?(:reason)
2578
- @reason_text = args[:reason_text] if args.key?(:reason_text)
2579
- end
2580
- end
2581
-
2582
- #
2583
- class OrdersCustomBatchRequestEntryReturnLineItem
2584
- include Google::Apis::Core::Hashable
2585
-
2586
- # The ID of the line item to return. Either lineItemId or productId is required.
2587
- # Corresponds to the JSON property `lineItemId`
2588
- # @return [String]
2589
- attr_accessor :line_item_id
2590
-
2591
- # The ID of the product to return. This is the REST ID used in the products
2592
- # service. Either lineItemId or productId is required.
2593
- # Corresponds to the JSON property `productId`
2594
- # @return [String]
2595
- attr_accessor :product_id
2596
-
2597
- # The quantity to return.
2598
- # Corresponds to the JSON property `quantity`
2599
- # @return [Fixnum]
2600
- attr_accessor :quantity
2601
-
2602
- # The reason for the return.
2603
- # Corresponds to the JSON property `reason`
2604
- # @return [String]
2605
- attr_accessor :reason
2606
-
2607
- # The explanation of the reason.
2608
- # Corresponds to the JSON property `reasonText`
2609
- # @return [String]
2610
- attr_accessor :reason_text
2611
-
2612
- def initialize(**args)
2613
- update!(**args)
2614
- end
2615
-
2616
- # Update properties of this object
2617
- def update!(**args)
2618
- @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
2619
- @product_id = args[:product_id] if args.key?(:product_id)
2620
- @quantity = args[:quantity] if args.key?(:quantity)
2621
- @reason = args[:reason] if args.key?(:reason)
2622
- @reason_text = args[:reason_text] if args.key?(:reason_text)
2623
- end
2624
- end
2625
-
2626
- #
2627
- class OrdersCustomBatchRequestEntryReturnRefundLineItem
2628
- include Google::Apis::Core::Hashable
2629
-
2630
- # The amount that is refunded. If omitted, refundless return is assumed (same as
2631
- # calling returnLineItem method). Optional, but if filled then both amountPretax
2632
- # and amountTax must be set.
2633
- # Corresponds to the JSON property `amountPretax`
2634
- # @return [Google::Apis::ContentV2sandbox::Price]
2635
- attr_accessor :amount_pretax
2636
-
2637
- # Tax amount that correspond to refund amount in amountPretax.
2638
- # Corresponds to the JSON property `amountTax`
2639
- # @return [Google::Apis::ContentV2sandbox::Price]
2640
- attr_accessor :amount_tax
2641
-
2642
- # The ID of the line item to return. Either lineItemId or productId is required.
2643
- # Corresponds to the JSON property `lineItemId`
2644
- # @return [String]
2645
- attr_accessor :line_item_id
2646
-
2647
- # The ID of the product to return. This is the REST ID used in the products
2648
- # service. Either lineItemId or productId is required.
2649
- # Corresponds to the JSON property `productId`
2650
- # @return [String]
2651
- attr_accessor :product_id
2652
-
2653
- # The quantity to return and refund.
2654
- # Corresponds to the JSON property `quantity`
2655
- # @return [Fixnum]
2656
- attr_accessor :quantity
2657
-
2658
- # The reason for the return.
2659
- # Corresponds to the JSON property `reason`
2660
- # @return [String]
2661
- attr_accessor :reason
2662
-
2663
- # The explanation of the reason.
2664
- # Corresponds to the JSON property `reasonText`
2665
- # @return [String]
2666
- attr_accessor :reason_text
2667
-
2668
- def initialize(**args)
2669
- update!(**args)
2670
- end
2671
-
2672
- # Update properties of this object
2673
- def update!(**args)
2674
- @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax)
2675
- @amount_tax = args[:amount_tax] if args.key?(:amount_tax)
2676
- @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
2677
- @product_id = args[:product_id] if args.key?(:product_id)
2678
- @quantity = args[:quantity] if args.key?(:quantity)
2679
- @reason = args[:reason] if args.key?(:reason)
2680
- @reason_text = args[:reason_text] if args.key?(:reason_text)
2681
- end
2682
- end
2683
-
2684
- #
2685
- class OrdersCustomBatchRequestEntrySetLineItemMetadata
2686
- include Google::Apis::Core::Hashable
2687
-
2688
- #
2689
- # Corresponds to the JSON property `annotations`
2690
- # @return [Array<Google::Apis::ContentV2sandbox::OrderMerchantProvidedAnnotation>]
2691
- attr_accessor :annotations
2692
-
2693
- # The ID of the line item to set metadata. Either lineItemId or productId is
2694
- # required.
2695
- # Corresponds to the JSON property `lineItemId`
2696
- # @return [String]
2697
- attr_accessor :line_item_id
2698
-
2699
- # The ID of the product to set metadata. This is the REST ID used in the
2700
- # products service. Either lineItemId or productId is required.
2701
- # Corresponds to the JSON property `productId`
2702
- # @return [String]
2703
- attr_accessor :product_id
2704
-
2705
- def initialize(**args)
2706
- update!(**args)
2707
- end
2708
-
2709
- # Update properties of this object
2710
- def update!(**args)
2711
- @annotations = args[:annotations] if args.key?(:annotations)
2712
- @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
2713
- @product_id = args[:product_id] if args.key?(:product_id)
2714
- end
2715
- end
2716
-
2717
- #
2718
- class OrdersCustomBatchRequestEntryShipLineItems
2719
- include Google::Apis::Core::Hashable
2720
-
2721
- # Deprecated. Please use shipmentInfo instead. The carrier handling the shipment.
2722
- # See shipments[].carrier in the Orders resource representation for a list of
2723
- # acceptable values.
2724
- # Corresponds to the JSON property `carrier`
2725
- # @return [String]
2726
- attr_accessor :carrier
2727
-
2728
- # Line items to ship.
2729
- # Corresponds to the JSON property `lineItems`
2730
- # @return [Array<Google::Apis::ContentV2sandbox::OrderShipmentLineItemShipment>]
2731
- attr_accessor :line_items
2732
-
2733
- # ID of the shipment group. Required for orders that use the orderinvoices
2734
- # service.
2735
- # Corresponds to the JSON property `shipmentGroupId`
2736
- # @return [String]
2737
- attr_accessor :shipment_group_id
2738
-
2739
- # Deprecated. Please use shipmentInfo instead. The ID of the shipment.
2740
- # Corresponds to the JSON property `shipmentId`
2741
- # @return [String]
2742
- attr_accessor :shipment_id
2743
-
2744
- # Shipment information. This field is repeated because a single line item can be
2745
- # shipped in several packages (and have several tracking IDs).
2746
- # Corresponds to the JSON property `shipmentInfos`
2747
- # @return [Array<Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo>]
2748
- attr_accessor :shipment_infos
2749
-
2750
- # Deprecated. Please use shipmentInfo instead. The tracking id for the shipment.
2751
- # Corresponds to the JSON property `trackingId`
2752
- # @return [String]
2753
- attr_accessor :tracking_id
2754
-
2755
- def initialize(**args)
2756
- update!(**args)
2757
- end
2758
-
2759
- # Update properties of this object
2760
- def update!(**args)
2761
- @carrier = args[:carrier] if args.key?(:carrier)
2762
- @line_items = args[:line_items] if args.key?(:line_items)
2763
- @shipment_group_id = args[:shipment_group_id] if args.key?(:shipment_group_id)
2764
- @shipment_id = args[:shipment_id] if args.key?(:shipment_id)
2765
- @shipment_infos = args[:shipment_infos] if args.key?(:shipment_infos)
2766
- @tracking_id = args[:tracking_id] if args.key?(:tracking_id)
2767
- end
2768
- end
2769
-
2770
- #
2771
- class OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo
2772
- include Google::Apis::Core::Hashable
2773
-
2774
- # The carrier handling the shipment. See shipments[].carrier in the Orders
2775
- # resource representation for a list of acceptable values.
2776
- # Corresponds to the JSON property `carrier`
2777
- # @return [String]
2778
- attr_accessor :carrier
2779
-
2780
- # The ID of the shipment.
2781
- # Corresponds to the JSON property `shipmentId`
2782
- # @return [String]
2783
- attr_accessor :shipment_id
2784
-
2785
- # The tracking id for the shipment.
2786
- # Corresponds to the JSON property `trackingId`
2787
- # @return [String]
2788
- attr_accessor :tracking_id
2789
-
2790
- def initialize(**args)
2791
- update!(**args)
2792
- end
2793
-
2794
- # Update properties of this object
2795
- def update!(**args)
2796
- @carrier = args[:carrier] if args.key?(:carrier)
2797
- @shipment_id = args[:shipment_id] if args.key?(:shipment_id)
2798
- @tracking_id = args[:tracking_id] if args.key?(:tracking_id)
2799
- end
2800
- end
2801
-
2802
- #
2803
- class OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails
2804
- include Google::Apis::Core::Hashable
2805
-
2806
- # Updated delivery by date, in ISO 8601 format. If not specified only ship by
2807
- # date is updated.
2808
- # Corresponds to the JSON property `deliverByDate`
2809
- # @return [String]
2810
- attr_accessor :deliver_by_date
2811
-
2812
- # The ID of the line item to set metadata. Either lineItemId or productId is
2813
- # required.
2814
- # Corresponds to the JSON property `lineItemId`
2815
- # @return [String]
2816
- attr_accessor :line_item_id
2817
-
2818
- # The ID of the product to set metadata. This is the REST ID used in the
2819
- # products service. Either lineItemId or productId is required.
2820
- # Corresponds to the JSON property `productId`
2821
- # @return [String]
2822
- attr_accessor :product_id
2823
-
2824
- # Updated ship by date, in ISO 8601 format. If not specified only deliver by
2825
- # date is updated.
2826
- # Corresponds to the JSON property `shipByDate`
2827
- # @return [String]
2828
- attr_accessor :ship_by_date
2829
-
2830
- def initialize(**args)
2831
- update!(**args)
2832
- end
2833
-
2834
- # Update properties of this object
2835
- def update!(**args)
2836
- @deliver_by_date = args[:deliver_by_date] if args.key?(:deliver_by_date)
2837
- @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
2838
- @product_id = args[:product_id] if args.key?(:product_id)
2839
- @ship_by_date = args[:ship_by_date] if args.key?(:ship_by_date)
2840
- end
2841
- end
2842
-
2843
- #
2844
- class OrdersCustomBatchRequestEntryUpdateShipment
2845
- include Google::Apis::Core::Hashable
2846
-
2847
- # The carrier handling the shipment. Not updated if missing. See shipments[].
2848
- # carrier in the Orders resource representation for a list of acceptable values.
2849
- # Corresponds to the JSON property `carrier`
2850
- # @return [String]
2851
- attr_accessor :carrier
2852
-
2853
- # Date on which the shipment has been delivered, in ISO 8601 format. Optional
2854
- # and can be provided only if status is delivered.
2855
- # Corresponds to the JSON property `deliveryDate`
2856
- # @return [String]
2857
- attr_accessor :delivery_date
2858
-
2859
- # The ID of the shipment.
2860
- # Corresponds to the JSON property `shipmentId`
2861
- # @return [String]
2862
- attr_accessor :shipment_id
2863
-
2864
- # New status for the shipment. Not updated if missing.
2865
- # Corresponds to the JSON property `status`
2866
- # @return [String]
2867
- attr_accessor :status
2868
-
2869
- # The tracking id for the shipment. Not updated if missing.
2870
- # Corresponds to the JSON property `trackingId`
2871
- # @return [String]
2872
- attr_accessor :tracking_id
2873
-
2874
- def initialize(**args)
2875
- update!(**args)
2876
- end
2877
-
2878
- # Update properties of this object
2879
- def update!(**args)
2880
- @carrier = args[:carrier] if args.key?(:carrier)
2881
- @delivery_date = args[:delivery_date] if args.key?(:delivery_date)
2882
- @shipment_id = args[:shipment_id] if args.key?(:shipment_id)
2883
- @status = args[:status] if args.key?(:status)
2884
- @tracking_id = args[:tracking_id] if args.key?(:tracking_id)
2885
- end
2886
- end
2887
-
2888
- #
2889
- class OrdersCustomBatchResponse
2890
- include Google::Apis::Core::Hashable
2891
-
2892
- # The result of the execution of the batch requests.
2893
- # Corresponds to the JSON property `entries`
2894
- # @return [Array<Google::Apis::ContentV2sandbox::OrdersCustomBatchResponseEntry>]
2895
- attr_accessor :entries
2896
-
2897
- # Identifies what kind of resource this is. Value: the fixed string "content#
2898
- # ordersCustomBatchResponse".
2899
- # Corresponds to the JSON property `kind`
2900
- # @return [String]
2901
- attr_accessor :kind
2902
-
2903
- def initialize(**args)
2904
- update!(**args)
2905
- end
2906
-
2907
- # Update properties of this object
2908
- def update!(**args)
2909
- @entries = args[:entries] if args.key?(:entries)
2910
- @kind = args[:kind] if args.key?(:kind)
2911
- end
2912
- end
2913
-
2914
- #
2915
- class OrdersCustomBatchResponseEntry
2916
- include Google::Apis::Core::Hashable
2917
-
2918
- # The ID of the request entry this entry responds to.
2919
- # Corresponds to the JSON property `batchId`
2920
- # @return [Fixnum]
2921
- attr_accessor :batch_id
2922
-
2923
- # A list of errors returned by a failed batch entry.
2924
- # Corresponds to the JSON property `errors`
2925
- # @return [Google::Apis::ContentV2sandbox::Errors]
2926
- attr_accessor :errors
2927
-
2928
- # The status of the execution. Only defined if
2929
- # - the request was successful; and
2930
- # - the method is not get, getByMerchantOrderId, or one of the test methods.
2931
- # Corresponds to the JSON property `executionStatus`
2932
- # @return [String]
2933
- attr_accessor :execution_status
2934
-
2935
- # Identifies what kind of resource this is. Value: the fixed string "content#
2936
- # ordersCustomBatchResponseEntry".
2937
- # Corresponds to the JSON property `kind`
2938
- # @return [String]
2939
- attr_accessor :kind
2940
-
2941
- # The retrieved order. Only defined if the method is get and if the request was
2942
- # successful.
2943
- # Corresponds to the JSON property `order`
2944
- # @return [Google::Apis::ContentV2sandbox::Order]
2945
- attr_accessor :order
2946
-
2947
- def initialize(**args)
2948
- update!(**args)
2949
- end
2950
-
2951
- # Update properties of this object
2952
- def update!(**args)
2953
- @batch_id = args[:batch_id] if args.key?(:batch_id)
2954
- @errors = args[:errors] if args.key?(:errors)
2955
- @execution_status = args[:execution_status] if args.key?(:execution_status)
2956
- @kind = args[:kind] if args.key?(:kind)
2957
- @order = args[:order] if args.key?(:order)
2958
- end
2959
- end
2960
-
2961
- #
2962
- class OrdersGetByMerchantOrderIdResponse
2963
- include Google::Apis::Core::Hashable
2964
-
2965
- # Identifies what kind of resource this is. Value: the fixed string "content#
2966
- # ordersGetByMerchantOrderIdResponse".
2967
- # Corresponds to the JSON property `kind`
2968
- # @return [String]
2969
- attr_accessor :kind
2970
-
2971
- # The requested order.
2972
- # Corresponds to the JSON property `order`
2973
- # @return [Google::Apis::ContentV2sandbox::Order]
2974
- attr_accessor :order
2975
-
2976
- def initialize(**args)
2977
- update!(**args)
2978
- end
2979
-
2980
- # Update properties of this object
2981
- def update!(**args)
2982
- @kind = args[:kind] if args.key?(:kind)
2983
- @order = args[:order] if args.key?(:order)
2984
- end
2985
- end
2986
-
2987
- #
2988
- class OrdersGetTestOrderTemplateResponse
2989
- include Google::Apis::Core::Hashable
2990
-
2991
- # Identifies what kind of resource this is. Value: the fixed string "content#
2992
- # ordersGetTestOrderTemplateResponse".
2993
- # Corresponds to the JSON property `kind`
2994
- # @return [String]
2995
- attr_accessor :kind
2996
-
2997
- # The requested test order template.
2998
- # Corresponds to the JSON property `template`
2999
- # @return [Google::Apis::ContentV2sandbox::TestOrder]
3000
- attr_accessor :template
3001
-
3002
- def initialize(**args)
3003
- update!(**args)
3004
- end
3005
-
3006
- # Update properties of this object
3007
- def update!(**args)
3008
- @kind = args[:kind] if args.key?(:kind)
3009
- @template = args[:template] if args.key?(:template)
3010
- end
3011
- end
3012
-
3013
- #
3014
- class OrdersInStoreRefundLineItemRequest
3015
- include Google::Apis::Core::Hashable
3016
-
3017
- # The amount that is refunded. Required.
3018
- # Corresponds to the JSON property `amountPretax`
3019
- # @return [Google::Apis::ContentV2sandbox::Price]
3020
- attr_accessor :amount_pretax
3021
-
3022
- # Tax amount that correspond to refund amount in amountPretax. Required.
3023
- # Corresponds to the JSON property `amountTax`
3024
- # @return [Google::Apis::ContentV2sandbox::Price]
3025
- attr_accessor :amount_tax
3026
-
3027
- # The ID of the line item to return. Either lineItemId or productId is required.
3028
- # Corresponds to the JSON property `lineItemId`
3029
- # @return [String]
3030
- attr_accessor :line_item_id
3031
-
3032
- # The ID of the operation. Unique across all operations for a given order.
3033
- # Corresponds to the JSON property `operationId`
3034
- # @return [String]
3035
- attr_accessor :operation_id
3036
-
3037
- # The ID of the product to return. This is the REST ID used in the products
3038
- # service. Either lineItemId or productId is required.
3039
- # Corresponds to the JSON property `productId`
3040
- # @return [String]
3041
- attr_accessor :product_id
3042
-
3043
- # The quantity to return and refund.
3044
- # Corresponds to the JSON property `quantity`
3045
- # @return [Fixnum]
3046
- attr_accessor :quantity
3047
-
3048
- # The reason for the return.
3049
- # Corresponds to the JSON property `reason`
3050
- # @return [String]
3051
- attr_accessor :reason
3052
-
3053
- # The explanation of the reason.
3054
- # Corresponds to the JSON property `reasonText`
3055
- # @return [String]
3056
- attr_accessor :reason_text
3057
-
3058
- def initialize(**args)
3059
- update!(**args)
3060
- end
3061
-
3062
- # Update properties of this object
3063
- def update!(**args)
3064
- @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax)
3065
- @amount_tax = args[:amount_tax] if args.key?(:amount_tax)
3066
- @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
3067
- @operation_id = args[:operation_id] if args.key?(:operation_id)
3068
- @product_id = args[:product_id] if args.key?(:product_id)
3069
- @quantity = args[:quantity] if args.key?(:quantity)
3070
- @reason = args[:reason] if args.key?(:reason)
3071
- @reason_text = args[:reason_text] if args.key?(:reason_text)
3072
- end
3073
- end
3074
-
3075
- #
3076
- class OrdersInStoreRefundLineItemResponse
3077
- include Google::Apis::Core::Hashable
3078
-
3079
- # The status of the execution.
3080
- # Corresponds to the JSON property `executionStatus`
3081
- # @return [String]
3082
- attr_accessor :execution_status
3083
-
3084
- # Identifies what kind of resource this is. Value: the fixed string "content#
3085
- # ordersInStoreRefundLineItemResponse".
3086
- # Corresponds to the JSON property `kind`
3087
- # @return [String]
3088
- attr_accessor :kind
3089
-
3090
- def initialize(**args)
3091
- update!(**args)
3092
- end
3093
-
3094
- # Update properties of this object
3095
- def update!(**args)
3096
- @execution_status = args[:execution_status] if args.key?(:execution_status)
3097
- @kind = args[:kind] if args.key?(:kind)
3098
- end
3099
- end
3100
-
3101
- #
3102
- class OrdersListResponse
3103
- include Google::Apis::Core::Hashable
3104
-
3105
- # Identifies what kind of resource this is. Value: the fixed string "content#
3106
- # ordersListResponse".
3107
- # Corresponds to the JSON property `kind`
3108
- # @return [String]
3109
- attr_accessor :kind
3110
-
3111
- # The token for the retrieval of the next page of orders.
3112
- # Corresponds to the JSON property `nextPageToken`
3113
- # @return [String]
3114
- attr_accessor :next_page_token
3115
-
3116
- #
3117
- # Corresponds to the JSON property `resources`
3118
- # @return [Array<Google::Apis::ContentV2sandbox::Order>]
3119
- attr_accessor :resources
3120
-
3121
- def initialize(**args)
3122
- update!(**args)
3123
- end
3124
-
3125
- # Update properties of this object
3126
- def update!(**args)
3127
- @kind = args[:kind] if args.key?(:kind)
3128
- @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
3129
- @resources = args[:resources] if args.key?(:resources)
3130
- end
3131
- end
3132
-
3133
- #
3134
- class OrdersRefundRequest
3135
- include Google::Apis::Core::Hashable
3136
-
3137
- # Deprecated. Please use amountPretax and amountTax instead.
3138
- # Corresponds to the JSON property `amount`
3139
- # @return [Google::Apis::ContentV2sandbox::Price]
3140
- attr_accessor :amount
3141
-
3142
- # The amount that is refunded. Either amount or amountPretax and amountTax
3143
- # should be filled.
3144
- # Corresponds to the JSON property `amountPretax`
3145
- # @return [Google::Apis::ContentV2sandbox::Price]
3146
- attr_accessor :amount_pretax
3147
-
3148
- # Tax amount that correspond to refund amount in amountPretax.
3149
- # Corresponds to the JSON property `amountTax`
3150
- # @return [Google::Apis::ContentV2sandbox::Price]
3151
- attr_accessor :amount_tax
3152
-
3153
- # The ID of the operation. Unique across all operations for a given order.
3154
- # Corresponds to the JSON property `operationId`
3155
- # @return [String]
3156
- attr_accessor :operation_id
3157
-
3158
- # The reason for the refund.
3159
- # Corresponds to the JSON property `reason`
3160
- # @return [String]
3161
- attr_accessor :reason
3162
-
3163
- # The explanation of the reason.
3164
- # Corresponds to the JSON property `reasonText`
3165
- # @return [String]
3166
- attr_accessor :reason_text
3167
-
3168
- def initialize(**args)
3169
- update!(**args)
3170
- end
3171
-
3172
- # Update properties of this object
3173
- def update!(**args)
3174
- @amount = args[:amount] if args.key?(:amount)
3175
- @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax)
3176
- @amount_tax = args[:amount_tax] if args.key?(:amount_tax)
3177
- @operation_id = args[:operation_id] if args.key?(:operation_id)
3178
- @reason = args[:reason] if args.key?(:reason)
3179
- @reason_text = args[:reason_text] if args.key?(:reason_text)
3180
- end
3181
- end
3182
-
3183
- #
3184
- class OrdersRefundResponse
3185
- include Google::Apis::Core::Hashable
3186
-
3187
- # The status of the execution.
3188
- # Corresponds to the JSON property `executionStatus`
3189
- # @return [String]
3190
- attr_accessor :execution_status
3191
-
3192
- # Identifies what kind of resource this is. Value: the fixed string "content#
3193
- # ordersRefundResponse".
3194
- # Corresponds to the JSON property `kind`
3195
- # @return [String]
3196
- attr_accessor :kind
3197
-
3198
- def initialize(**args)
3199
- update!(**args)
3200
- end
3201
-
3202
- # Update properties of this object
3203
- def update!(**args)
3204
- @execution_status = args[:execution_status] if args.key?(:execution_status)
3205
- @kind = args[:kind] if args.key?(:kind)
3206
- end
3207
- end
3208
-
3209
- #
3210
- class OrdersRejectReturnLineItemRequest
3211
- include Google::Apis::Core::Hashable
3212
-
3213
- # The ID of the line item to return. Either lineItemId or productId is required.
3214
- # Corresponds to the JSON property `lineItemId`
3215
- # @return [String]
3216
- attr_accessor :line_item_id
3217
-
3218
- # The ID of the operation. Unique across all operations for a given order.
3219
- # Corresponds to the JSON property `operationId`
3220
- # @return [String]
3221
- attr_accessor :operation_id
3222
-
3223
- # The ID of the product to return. This is the REST ID used in the products
3224
- # service. Either lineItemId or productId is required.
3225
- # Corresponds to the JSON property `productId`
3226
- # @return [String]
3227
- attr_accessor :product_id
3228
-
3229
- # The quantity to return and refund.
3230
- # Corresponds to the JSON property `quantity`
3231
- # @return [Fixnum]
3232
- attr_accessor :quantity
3233
-
3234
- # The reason for the return.
3235
- # Corresponds to the JSON property `reason`
3236
- # @return [String]
3237
- attr_accessor :reason
3238
-
3239
- # The explanation of the reason.
3240
- # Corresponds to the JSON property `reasonText`
3241
- # @return [String]
3242
- attr_accessor :reason_text
3243
-
3244
- def initialize(**args)
3245
- update!(**args)
3246
- end
3247
-
3248
- # Update properties of this object
3249
- def update!(**args)
3250
- @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
3251
- @operation_id = args[:operation_id] if args.key?(:operation_id)
3252
- @product_id = args[:product_id] if args.key?(:product_id)
3253
- @quantity = args[:quantity] if args.key?(:quantity)
3254
- @reason = args[:reason] if args.key?(:reason)
3255
- @reason_text = args[:reason_text] if args.key?(:reason_text)
3256
- end
3257
- end
3258
-
3259
- #
3260
- class OrdersRejectReturnLineItemResponse
3261
- include Google::Apis::Core::Hashable
3262
-
3263
- # The status of the execution.
3264
- # Corresponds to the JSON property `executionStatus`
3265
- # @return [String]
3266
- attr_accessor :execution_status
3267
-
3268
- # Identifies what kind of resource this is. Value: the fixed string "content#
3269
- # ordersRejectReturnLineItemResponse".
3270
- # Corresponds to the JSON property `kind`
3271
- # @return [String]
3272
- attr_accessor :kind
3273
-
3274
- def initialize(**args)
3275
- update!(**args)
3276
- end
3277
-
3278
- # Update properties of this object
3279
- def update!(**args)
3280
- @execution_status = args[:execution_status] if args.key?(:execution_status)
3281
- @kind = args[:kind] if args.key?(:kind)
3282
- end
3283
- end
3284
-
3285
- #
3286
- class OrdersReturnLineItemRequest
3287
- include Google::Apis::Core::Hashable
3288
-
3289
- # The ID of the line item to return. Either lineItemId or productId is required.
3290
- # Corresponds to the JSON property `lineItemId`
3291
- # @return [String]
3292
- attr_accessor :line_item_id
3293
-
3294
- # The ID of the operation. Unique across all operations for a given order.
3295
- # Corresponds to the JSON property `operationId`
3296
- # @return [String]
3297
- attr_accessor :operation_id
3298
-
3299
- # The ID of the product to return. This is the REST ID used in the products
3300
- # service. Either lineItemId or productId is required.
3301
- # Corresponds to the JSON property `productId`
3302
- # @return [String]
3303
- attr_accessor :product_id
3304
-
3305
- # The quantity to return.
3306
- # Corresponds to the JSON property `quantity`
3307
- # @return [Fixnum]
3308
- attr_accessor :quantity
3309
-
3310
- # The reason for the return.
3311
- # Corresponds to the JSON property `reason`
3312
- # @return [String]
3313
- attr_accessor :reason
3314
-
3315
- # The explanation of the reason.
3316
- # Corresponds to the JSON property `reasonText`
3317
- # @return [String]
3318
- attr_accessor :reason_text
3319
-
3320
- def initialize(**args)
3321
- update!(**args)
3322
- end
3323
-
3324
- # Update properties of this object
3325
- def update!(**args)
3326
- @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
3327
- @operation_id = args[:operation_id] if args.key?(:operation_id)
3328
- @product_id = args[:product_id] if args.key?(:product_id)
3329
- @quantity = args[:quantity] if args.key?(:quantity)
3330
- @reason = args[:reason] if args.key?(:reason)
3331
- @reason_text = args[:reason_text] if args.key?(:reason_text)
3332
- end
3333
- end
3334
-
3335
- #
3336
- class OrdersReturnLineItemResponse
3337
- include Google::Apis::Core::Hashable
3338
-
3339
- # The status of the execution.
3340
- # Corresponds to the JSON property `executionStatus`
3341
- # @return [String]
3342
- attr_accessor :execution_status
3343
-
3344
- # Identifies what kind of resource this is. Value: the fixed string "content#
3345
- # ordersReturnLineItemResponse".
3346
- # Corresponds to the JSON property `kind`
3347
- # @return [String]
3348
- attr_accessor :kind
3349
-
3350
- def initialize(**args)
3351
- update!(**args)
3352
- end
3353
-
3354
- # Update properties of this object
3355
- def update!(**args)
3356
- @execution_status = args[:execution_status] if args.key?(:execution_status)
3357
- @kind = args[:kind] if args.key?(:kind)
3358
- end
3359
- end
3360
-
3361
- #
3362
- class OrdersReturnRefundLineItemRequest
3363
- include Google::Apis::Core::Hashable
3364
-
3365
- # The amount that is refunded. If omitted, refundless return is assumed (same as
3366
- # calling returnLineItem method). Optional, but if filled then both amountPretax
3367
- # and amountTax must be set.
3368
- # Corresponds to the JSON property `amountPretax`
3369
- # @return [Google::Apis::ContentV2sandbox::Price]
3370
- attr_accessor :amount_pretax
3371
-
3372
- # Tax amount that correspond to refund amount in amountPretax.
3373
- # Corresponds to the JSON property `amountTax`
3374
- # @return [Google::Apis::ContentV2sandbox::Price]
3375
- attr_accessor :amount_tax
3376
-
3377
- # The ID of the line item to return. Either lineItemId or productId is required.
3378
- # Corresponds to the JSON property `lineItemId`
3379
- # @return [String]
3380
- attr_accessor :line_item_id
3381
-
3382
- # The ID of the operation. Unique across all operations for a given order.
3383
- # Corresponds to the JSON property `operationId`
3384
- # @return [String]
3385
- attr_accessor :operation_id
3386
-
3387
- # The ID of the product to return. This is the REST ID used in the products
3388
- # service. Either lineItemId or productId is required.
3389
- # Corresponds to the JSON property `productId`
3390
- # @return [String]
3391
- attr_accessor :product_id
3392
-
3393
- # The quantity to return and refund.
3394
- # Corresponds to the JSON property `quantity`
3395
- # @return [Fixnum]
3396
- attr_accessor :quantity
3397
-
3398
- # The reason for the return.
3399
- # Corresponds to the JSON property `reason`
3400
- # @return [String]
3401
- attr_accessor :reason
3402
-
3403
- # The explanation of the reason.
3404
- # Corresponds to the JSON property `reasonText`
3405
- # @return [String]
3406
- attr_accessor :reason_text
3407
-
3408
- def initialize(**args)
3409
- update!(**args)
3410
- end
3411
-
3412
- # Update properties of this object
3413
- def update!(**args)
3414
- @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax)
3415
- @amount_tax = args[:amount_tax] if args.key?(:amount_tax)
3416
- @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
3417
- @operation_id = args[:operation_id] if args.key?(:operation_id)
3418
- @product_id = args[:product_id] if args.key?(:product_id)
3419
- @quantity = args[:quantity] if args.key?(:quantity)
3420
- @reason = args[:reason] if args.key?(:reason)
3421
- @reason_text = args[:reason_text] if args.key?(:reason_text)
3422
- end
3423
- end
3424
-
3425
- #
3426
- class OrdersReturnRefundLineItemResponse
3427
- include Google::Apis::Core::Hashable
3428
-
3429
- # The status of the execution.
3430
- # Corresponds to the JSON property `executionStatus`
3431
- # @return [String]
3432
- attr_accessor :execution_status
3433
-
3434
- # Identifies what kind of resource this is. Value: the fixed string "content#
3435
- # ordersReturnRefundLineItemResponse".
3436
- # Corresponds to the JSON property `kind`
3437
- # @return [String]
3438
- attr_accessor :kind
3439
-
3440
- def initialize(**args)
3441
- update!(**args)
3442
- end
3443
-
3444
- # Update properties of this object
3445
- def update!(**args)
3446
- @execution_status = args[:execution_status] if args.key?(:execution_status)
3447
- @kind = args[:kind] if args.key?(:kind)
3448
- end
3449
- end
3450
-
3451
- #
3452
- class OrdersSetLineItemMetadataRequest
3453
- include Google::Apis::Core::Hashable
3454
-
3455
- #
3456
- # Corresponds to the JSON property `annotations`
3457
- # @return [Array<Google::Apis::ContentV2sandbox::OrderMerchantProvidedAnnotation>]
3458
- attr_accessor :annotations
3459
-
3460
- # The ID of the line item to set metadata. Either lineItemId or productId is
3461
- # required.
3462
- # Corresponds to the JSON property `lineItemId`
3463
- # @return [String]
3464
- attr_accessor :line_item_id
3465
-
3466
- # The ID of the operation. Unique across all operations for a given order.
3467
- # Corresponds to the JSON property `operationId`
3468
- # @return [String]
3469
- attr_accessor :operation_id
3470
-
3471
- # The ID of the product to set metadata. This is the REST ID used in the
3472
- # products service. Either lineItemId or productId is required.
3473
- # Corresponds to the JSON property `productId`
3474
- # @return [String]
3475
- attr_accessor :product_id
3476
-
3477
- def initialize(**args)
3478
- update!(**args)
3479
- end
3480
-
3481
- # Update properties of this object
3482
- def update!(**args)
3483
- @annotations = args[:annotations] if args.key?(:annotations)
3484
- @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
3485
- @operation_id = args[:operation_id] if args.key?(:operation_id)
3486
- @product_id = args[:product_id] if args.key?(:product_id)
3487
- end
3488
- end
3489
-
3490
- #
3491
- class OrdersSetLineItemMetadataResponse
3492
- include Google::Apis::Core::Hashable
3493
-
3494
- # The status of the execution.
3495
- # Corresponds to the JSON property `executionStatus`
3496
- # @return [String]
3497
- attr_accessor :execution_status
3498
-
3499
- # Identifies what kind of resource this is. Value: the fixed string "content#
3500
- # ordersSetLineItemMetadataResponse".
3501
- # Corresponds to the JSON property `kind`
3502
- # @return [String]
3503
- attr_accessor :kind
3504
-
3505
- def initialize(**args)
3506
- update!(**args)
3507
- end
3508
-
3509
- # Update properties of this object
3510
- def update!(**args)
3511
- @execution_status = args[:execution_status] if args.key?(:execution_status)
3512
- @kind = args[:kind] if args.key?(:kind)
3513
- end
3514
- end
3515
-
3516
- #
3517
- class OrdersShipLineItemsRequest
3518
- include Google::Apis::Core::Hashable
3519
-
3520
- # Deprecated. Please use shipmentInfo instead. The carrier handling the shipment.
3521
- # See shipments[].carrier in the Orders resource representation for a list of
3522
- # acceptable values.
3523
- # Corresponds to the JSON property `carrier`
3524
- # @return [String]
3525
- attr_accessor :carrier
3526
-
3527
- # Line items to ship.
3528
- # Corresponds to the JSON property `lineItems`
3529
- # @return [Array<Google::Apis::ContentV2sandbox::OrderShipmentLineItemShipment>]
3530
- attr_accessor :line_items
3531
-
3532
- # The ID of the operation. Unique across all operations for a given order.
3533
- # Corresponds to the JSON property `operationId`
3534
- # @return [String]
3535
- attr_accessor :operation_id
3536
-
3537
- # ID of the shipment group. Required for orders that use the orderinvoices
3538
- # service.
3539
- # Corresponds to the JSON property `shipmentGroupId`
3540
- # @return [String]
3541
- attr_accessor :shipment_group_id
3542
-
3543
- # Deprecated. Please use shipmentInfo instead. The ID of the shipment.
3544
- # Corresponds to the JSON property `shipmentId`
3545
- # @return [String]
3546
- attr_accessor :shipment_id
3547
-
3548
- # Shipment information. This field is repeated because a single line item can be
3549
- # shipped in several packages (and have several tracking IDs).
3550
- # Corresponds to the JSON property `shipmentInfos`
3551
- # @return [Array<Google::Apis::ContentV2sandbox::OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo>]
3552
- attr_accessor :shipment_infos
3553
-
3554
- # Deprecated. Please use shipmentInfo instead. The tracking id for the shipment.
3555
- # Corresponds to the JSON property `trackingId`
3556
- # @return [String]
3557
- attr_accessor :tracking_id
3558
-
3559
- def initialize(**args)
3560
- update!(**args)
3561
- end
3562
-
3563
- # Update properties of this object
3564
- def update!(**args)
3565
- @carrier = args[:carrier] if args.key?(:carrier)
3566
- @line_items = args[:line_items] if args.key?(:line_items)
3567
- @operation_id = args[:operation_id] if args.key?(:operation_id)
3568
- @shipment_group_id = args[:shipment_group_id] if args.key?(:shipment_group_id)
3569
- @shipment_id = args[:shipment_id] if args.key?(:shipment_id)
3570
- @shipment_infos = args[:shipment_infos] if args.key?(:shipment_infos)
3571
- @tracking_id = args[:tracking_id] if args.key?(:tracking_id)
3572
- end
3573
- end
3574
-
3575
- #
3576
- class OrdersShipLineItemsResponse
3577
- include Google::Apis::Core::Hashable
3578
-
3579
- # The status of the execution.
3580
- # Corresponds to the JSON property `executionStatus`
3581
- # @return [String]
3582
- attr_accessor :execution_status
3583
-
3584
- # Identifies what kind of resource this is. Value: the fixed string "content#
3585
- # ordersShipLineItemsResponse".
3586
- # Corresponds to the JSON property `kind`
3587
- # @return [String]
3588
- attr_accessor :kind
3589
-
3590
- def initialize(**args)
3591
- update!(**args)
3592
- end
3593
-
3594
- # Update properties of this object
3595
- def update!(**args)
3596
- @execution_status = args[:execution_status] if args.key?(:execution_status)
3597
- @kind = args[:kind] if args.key?(:kind)
3598
- end
3599
- end
3600
-
3601
- #
3602
- class OrdersUpdateLineItemShippingDetailsRequest
3603
- include Google::Apis::Core::Hashable
3604
-
3605
- # Updated delivery by date, in ISO 8601 format. If not specified only ship by
3606
- # date is updated.
3607
- # Corresponds to the JSON property `deliverByDate`
3608
- # @return [String]
3609
- attr_accessor :deliver_by_date
3610
-
3611
- # The ID of the line item to set metadata. Either lineItemId or productId is
3612
- # required.
3613
- # Corresponds to the JSON property `lineItemId`
3614
- # @return [String]
3615
- attr_accessor :line_item_id
3616
-
3617
- # The ID of the operation. Unique across all operations for a given order.
3618
- # Corresponds to the JSON property `operationId`
3619
- # @return [String]
3620
- attr_accessor :operation_id
3621
-
3622
- # The ID of the product to set metadata. This is the REST ID used in the
3623
- # products service. Either lineItemId or productId is required.
3624
- # Corresponds to the JSON property `productId`
3625
- # @return [String]
3626
- attr_accessor :product_id
3627
-
3628
- # Updated ship by date, in ISO 8601 format. If not specified only deliver by
3629
- # date is updated.
3630
- # Corresponds to the JSON property `shipByDate`
3631
- # @return [String]
3632
- attr_accessor :ship_by_date
3633
-
3634
- def initialize(**args)
3635
- update!(**args)
3636
- end
3637
-
3638
- # Update properties of this object
3639
- def update!(**args)
3640
- @deliver_by_date = args[:deliver_by_date] if args.key?(:deliver_by_date)
3641
- @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
3642
- @operation_id = args[:operation_id] if args.key?(:operation_id)
3643
- @product_id = args[:product_id] if args.key?(:product_id)
3644
- @ship_by_date = args[:ship_by_date] if args.key?(:ship_by_date)
3645
- end
3646
- end
3647
-
3648
- #
3649
- class OrdersUpdateLineItemShippingDetailsResponse
3650
- include Google::Apis::Core::Hashable
3651
-
3652
- # The status of the execution.
3653
- # Corresponds to the JSON property `executionStatus`
3654
- # @return [String]
3655
- attr_accessor :execution_status
3656
-
3657
- # Identifies what kind of resource this is. Value: the fixed string "content#
3658
- # ordersUpdateLineItemShippingDetailsResponse".
3659
- # Corresponds to the JSON property `kind`
3660
- # @return [String]
3661
- attr_accessor :kind
3662
-
3663
- def initialize(**args)
3664
- update!(**args)
3665
- end
3666
-
3667
- # Update properties of this object
3668
- def update!(**args)
3669
- @execution_status = args[:execution_status] if args.key?(:execution_status)
3670
- @kind = args[:kind] if args.key?(:kind)
3671
- end
3672
- end
3673
-
3674
- #
3675
- class OrdersUpdateMerchantOrderIdRequest
3676
- include Google::Apis::Core::Hashable
3677
-
3678
- # The merchant order id to be assigned to the order. Must be unique per merchant.
3679
- # Corresponds to the JSON property `merchantOrderId`
3680
- # @return [String]
3681
- attr_accessor :merchant_order_id
3682
-
3683
- # The ID of the operation. Unique across all operations for a given order.
3684
- # Corresponds to the JSON property `operationId`
3685
- # @return [String]
3686
- attr_accessor :operation_id
3687
-
3688
- def initialize(**args)
3689
- update!(**args)
3690
- end
3691
-
3692
- # Update properties of this object
3693
- def update!(**args)
3694
- @merchant_order_id = args[:merchant_order_id] if args.key?(:merchant_order_id)
3695
- @operation_id = args[:operation_id] if args.key?(:operation_id)
3696
- end
3697
- end
3698
-
3699
- #
3700
- class OrdersUpdateMerchantOrderIdResponse
3701
- include Google::Apis::Core::Hashable
3702
-
3703
- # The status of the execution.
3704
- # Corresponds to the JSON property `executionStatus`
3705
- # @return [String]
3706
- attr_accessor :execution_status
3707
-
3708
- # Identifies what kind of resource this is. Value: the fixed string "content#
3709
- # ordersUpdateMerchantOrderIdResponse".
3710
- # Corresponds to the JSON property `kind`
3711
- # @return [String]
3712
- attr_accessor :kind
3713
-
3714
- def initialize(**args)
3715
- update!(**args)
3716
- end
3717
-
3718
- # Update properties of this object
3719
- def update!(**args)
3720
- @execution_status = args[:execution_status] if args.key?(:execution_status)
3721
- @kind = args[:kind] if args.key?(:kind)
3722
- end
3723
- end
3724
-
3725
- #
3726
- class OrdersUpdateShipmentRequest
3727
- include Google::Apis::Core::Hashable
3728
-
3729
- # The carrier handling the shipment. Not updated if missing. See shipments[].
3730
- # carrier in the Orders resource representation for a list of acceptable values.
3731
- # Corresponds to the JSON property `carrier`
3732
- # @return [String]
3733
- attr_accessor :carrier
3734
-
3735
- # Date on which the shipment has been delivered, in ISO 8601 format. Optional
3736
- # and can be provided only if status is delivered.
3737
- # Corresponds to the JSON property `deliveryDate`
3738
- # @return [String]
3739
- attr_accessor :delivery_date
3740
-
3741
- # The ID of the operation. Unique across all operations for a given order.
3742
- # Corresponds to the JSON property `operationId`
3743
- # @return [String]
3744
- attr_accessor :operation_id
3745
-
3746
- # The ID of the shipment.
3747
- # Corresponds to the JSON property `shipmentId`
3748
- # @return [String]
3749
- attr_accessor :shipment_id
3750
-
3751
- # New status for the shipment. Not updated if missing.
3752
- # Corresponds to the JSON property `status`
3753
- # @return [String]
3754
- attr_accessor :status
3755
-
3756
- # The tracking id for the shipment. Not updated if missing.
3757
- # Corresponds to the JSON property `trackingId`
3758
- # @return [String]
3759
- attr_accessor :tracking_id
3760
-
3761
- def initialize(**args)
3762
- update!(**args)
3763
- end
3764
-
3765
- # Update properties of this object
3766
- def update!(**args)
3767
- @carrier = args[:carrier] if args.key?(:carrier)
3768
- @delivery_date = args[:delivery_date] if args.key?(:delivery_date)
3769
- @operation_id = args[:operation_id] if args.key?(:operation_id)
3770
- @shipment_id = args[:shipment_id] if args.key?(:shipment_id)
3771
- @status = args[:status] if args.key?(:status)
3772
- @tracking_id = args[:tracking_id] if args.key?(:tracking_id)
3773
- end
3774
- end
3775
-
3776
- #
3777
- class OrdersUpdateShipmentResponse
3778
- include Google::Apis::Core::Hashable
3779
-
3780
- # The status of the execution.
3781
- # Corresponds to the JSON property `executionStatus`
3782
- # @return [String]
3783
- attr_accessor :execution_status
3784
-
3785
- # Identifies what kind of resource this is. Value: the fixed string "content#
3786
- # ordersUpdateShipmentResponse".
3787
- # Corresponds to the JSON property `kind`
3788
- # @return [String]
3789
- attr_accessor :kind
3790
-
3791
- def initialize(**args)
3792
- update!(**args)
3793
- end
3794
-
3795
- # Update properties of this object
3796
- def update!(**args)
3797
- @execution_status = args[:execution_status] if args.key?(:execution_status)
3798
- @kind = args[:kind] if args.key?(:kind)
3799
- end
3800
- end
3801
-
3802
- #
3803
- class Price
3804
- include Google::Apis::Core::Hashable
3805
-
3806
- # The currency of the price.
3807
- # Corresponds to the JSON property `currency`
3808
- # @return [String]
3809
- attr_accessor :currency
3810
-
3811
- # The price represented as a number.
3812
- # Corresponds to the JSON property `value`
3813
- # @return [String]
3814
- attr_accessor :value
3815
-
3816
- def initialize(**args)
3817
- update!(**args)
3818
- end
3819
-
3820
- # Update properties of this object
3821
- def update!(**args)
3822
- @currency = args[:currency] if args.key?(:currency)
3823
- @value = args[:value] if args.key?(:value)
3824
- end
3825
- end
3826
-
3827
- #
3828
- class Promotion
3829
- include Google::Apis::Core::Hashable
3830
-
3831
- # [required] Amount of the promotion. The values here are the promotion applied
3832
- # to the unit price pretax and to the total of the tax amounts.
3833
- # Corresponds to the JSON property `promotionAmount`
3834
- # @return [Google::Apis::ContentV2sandbox::Amount]
3835
- attr_accessor :promotion_amount
3836
-
3837
- # [required] ID of the promotion.
3838
- # Corresponds to the JSON property `promotionId`
3839
- # @return [String]
3840
- attr_accessor :promotion_id
3841
-
3842
- def initialize(**args)
3843
- update!(**args)
3844
- end
3845
-
3846
- # Update properties of this object
3847
- def update!(**args)
3848
- @promotion_amount = args[:promotion_amount] if args.key?(:promotion_amount)
3849
- @promotion_id = args[:promotion_id] if args.key?(:promotion_id)
3850
- end
3851
- end
3852
-
3853
- #
3854
- class RefundReason
3855
- include Google::Apis::Core::Hashable
3856
-
3857
- #
3858
- # Corresponds to the JSON property `description`
3859
- # @return [String]
3860
- attr_accessor :description
3861
-
3862
- #
3863
- # Corresponds to the JSON property `reasonCode`
3864
- # @return [String]
3865
- attr_accessor :reason_code
3866
-
3867
- def initialize(**args)
3868
- update!(**args)
3869
- end
3870
-
3871
- # Update properties of this object
3872
- def update!(**args)
3873
- @description = args[:description] if args.key?(:description)
3874
- @reason_code = args[:reason_code] if args.key?(:reason_code)
3875
- end
3876
- end
3877
-
3878
- #
3879
- class ReturnShipment
3880
- include Google::Apis::Core::Hashable
3881
-
3882
- #
3883
- # Corresponds to the JSON property `creationDate`
3884
- # @return [String]
3885
- attr_accessor :creation_date
3886
-
3887
- #
3888
- # Corresponds to the JSON property `returnMethodType`
3889
- # @return [String]
3890
- attr_accessor :return_method_type
3891
-
3892
- #
3893
- # Corresponds to the JSON property `shipmentId`
3894
- # @return [String]
3895
- attr_accessor :shipment_id
3896
-
3897
- #
3898
- # Corresponds to the JSON property `shipmentTrackingInfos`
3899
- # @return [Array<Google::Apis::ContentV2sandbox::ShipmentTrackingInfo>]
3900
- attr_accessor :shipment_tracking_infos
3901
-
3902
- def initialize(**args)
3903
- update!(**args)
3904
- end
3905
-
3906
- # Update properties of this object
3907
- def update!(**args)
3908
- @creation_date = args[:creation_date] if args.key?(:creation_date)
3909
- @return_method_type = args[:return_method_type] if args.key?(:return_method_type)
3910
- @shipment_id = args[:shipment_id] if args.key?(:shipment_id)
3911
- @shipment_tracking_infos = args[:shipment_tracking_infos] if args.key?(:shipment_tracking_infos)
3912
- end
3913
- end
3914
-
3915
- #
3916
- class ShipmentInvoice
3917
- include Google::Apis::Core::Hashable
3918
-
3919
- # [required] Invoice summary.
3920
- # Corresponds to the JSON property `invoiceSummary`
3921
- # @return [Google::Apis::ContentV2sandbox::InvoiceSummary]
3922
- attr_accessor :invoice_summary
3923
-
3924
- # [required] Invoice details per line item.
3925
- # Corresponds to the JSON property `lineItemInvoices`
3926
- # @return [Array<Google::Apis::ContentV2sandbox::ShipmentInvoiceLineItemInvoice>]
3927
- attr_accessor :line_item_invoices
3928
-
3929
- # [required] ID of the shipment group.
3930
- # Corresponds to the JSON property `shipmentGroupId`
3931
- # @return [String]
3932
- attr_accessor :shipment_group_id
3933
-
3934
- def initialize(**args)
3935
- update!(**args)
3936
- end
3937
-
3938
- # Update properties of this object
3939
- def update!(**args)
3940
- @invoice_summary = args[:invoice_summary] if args.key?(:invoice_summary)
3941
- @line_item_invoices = args[:line_item_invoices] if args.key?(:line_item_invoices)
3942
- @shipment_group_id = args[:shipment_group_id] if args.key?(:shipment_group_id)
3943
- end
3944
- end
3945
-
3946
- #
3947
- class ShipmentInvoiceLineItemInvoice
3948
- include Google::Apis::Core::Hashable
3949
-
3950
- # ID of the line item. Either lineItemId or productId must be set.
3951
- # Corresponds to the JSON property `lineItemId`
3952
- # @return [String]
3953
- attr_accessor :line_item_id
3954
-
3955
- # ID of the product. This is the REST ID used in the products service. Either
3956
- # lineItemId or productId must be set.
3957
- # Corresponds to the JSON property `productId`
3958
- # @return [String]
3959
- attr_accessor :product_id
3960
-
3961
- # [required] Unit IDs to define specific units within the line item.
3962
- # Corresponds to the JSON property `shipmentUnitIds`
3963
- # @return [Array<String>]
3964
- attr_accessor :shipment_unit_ids
3965
-
3966
- # [required] Invoice details for a single unit.
3967
- # Corresponds to the JSON property `unitInvoice`
3968
- # @return [Google::Apis::ContentV2sandbox::UnitInvoice]
3969
- attr_accessor :unit_invoice
3970
-
3971
- def initialize(**args)
3972
- update!(**args)
3973
- end
3974
-
3975
- # Update properties of this object
3976
- def update!(**args)
3977
- @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
3978
- @product_id = args[:product_id] if args.key?(:product_id)
3979
- @shipment_unit_ids = args[:shipment_unit_ids] if args.key?(:shipment_unit_ids)
3980
- @unit_invoice = args[:unit_invoice] if args.key?(:unit_invoice)
3981
- end
3982
- end
3983
-
3984
- #
3985
- class ShipmentTrackingInfo
3986
- include Google::Apis::Core::Hashable
3987
-
3988
- #
3989
- # Corresponds to the JSON property `carrier`
3990
- # @return [String]
3991
- attr_accessor :carrier
3992
-
3993
- #
3994
- # Corresponds to the JSON property `trackingNumber`
3995
- # @return [String]
3996
- attr_accessor :tracking_number
3997
-
3998
- def initialize(**args)
3999
- update!(**args)
4000
- end
4001
-
4002
- # Update properties of this object
4003
- def update!(**args)
4004
- @carrier = args[:carrier] if args.key?(:carrier)
4005
- @tracking_number = args[:tracking_number] if args.key?(:tracking_number)
4006
- end
4007
- end
4008
-
4009
- #
4010
- class TestOrder
4011
- include Google::Apis::Core::Hashable
4012
-
4013
- # The details of the customer who placed the order.
4014
- # Corresponds to the JSON property `customer`
4015
- # @return [Google::Apis::ContentV2sandbox::TestOrderCustomer]
4016
- attr_accessor :customer
4017
-
4018
- # Whether the orderinvoices service should support this order.
4019
- # Corresponds to the JSON property `enableOrderinvoices`
4020
- # @return [Boolean]
4021
- attr_accessor :enable_orderinvoices
4022
- alias_method :enable_orderinvoices?, :enable_orderinvoices
4023
-
4024
- # Identifies what kind of resource this is. Value: the fixed string "content#
4025
- # testOrder".
4026
- # Corresponds to the JSON property `kind`
4027
- # @return [String]
4028
- attr_accessor :kind
4029
-
4030
- # Line items that are ordered. At least one line item must be provided.
4031
- # Corresponds to the JSON property `lineItems`
4032
- # @return [Array<Google::Apis::ContentV2sandbox::TestOrderLineItem>]
4033
- attr_accessor :line_items
4034
-
4035
- # Determines if test order must be pulled by merchant or pushed to merchant via
4036
- # push integration.
4037
- # Corresponds to the JSON property `notificationMode`
4038
- # @return [String]
4039
- attr_accessor :notification_mode
4040
-
4041
- # The details of the payment method.
4042
- # Corresponds to the JSON property `paymentMethod`
4043
- # @return [Google::Apis::ContentV2sandbox::TestOrderPaymentMethod]
4044
- attr_accessor :payment_method
4045
-
4046
- # Identifier of one of the predefined delivery addresses for the delivery.
4047
- # Corresponds to the JSON property `predefinedDeliveryAddress`
4048
- # @return [String]
4049
- attr_accessor :predefined_delivery_address
4050
-
4051
- # Deprecated. The details of the merchant provided promotions applied to the
4052
- # order. More details about the program are here.
4053
- # Corresponds to the JSON property `promotions`
4054
- # @return [Array<Google::Apis::ContentV2sandbox::OrderLegacyPromotion>]
4055
- attr_accessor :promotions
4056
-
4057
- # The total cost of shipping for all items.
4058
- # Corresponds to the JSON property `shippingCost`
4059
- # @return [Google::Apis::ContentV2sandbox::Price]
4060
- attr_accessor :shipping_cost
4061
-
4062
- # The tax for the total shipping cost.
4063
- # Corresponds to the JSON property `shippingCostTax`
4064
- # @return [Google::Apis::ContentV2sandbox::Price]
4065
- attr_accessor :shipping_cost_tax
4066
-
4067
- # The requested shipping option.
4068
- # Corresponds to the JSON property `shippingOption`
4069
- # @return [String]
4070
- attr_accessor :shipping_option
4071
-
4072
- def initialize(**args)
4073
- update!(**args)
4074
- end
4075
-
4076
- # Update properties of this object
4077
- def update!(**args)
4078
- @customer = args[:customer] if args.key?(:customer)
4079
- @enable_orderinvoices = args[:enable_orderinvoices] if args.key?(:enable_orderinvoices)
4080
- @kind = args[:kind] if args.key?(:kind)
4081
- @line_items = args[:line_items] if args.key?(:line_items)
4082
- @notification_mode = args[:notification_mode] if args.key?(:notification_mode)
4083
- @payment_method = args[:payment_method] if args.key?(:payment_method)
4084
- @predefined_delivery_address = args[:predefined_delivery_address] if args.key?(:predefined_delivery_address)
4085
- @promotions = args[:promotions] if args.key?(:promotions)
4086
- @shipping_cost = args[:shipping_cost] if args.key?(:shipping_cost)
4087
- @shipping_cost_tax = args[:shipping_cost_tax] if args.key?(:shipping_cost_tax)
4088
- @shipping_option = args[:shipping_option] if args.key?(:shipping_option)
4089
- end
4090
- end
4091
-
4092
- #
4093
- class TestOrderCustomer
4094
- include Google::Apis::Core::Hashable
4095
-
4096
- # Deprecated.
4097
- # Corresponds to the JSON property `email`
4098
- # @return [String]
4099
- attr_accessor :email
4100
-
4101
- # Deprecated. Please use marketingRightsInfo instead.
4102
- # Corresponds to the JSON property `explicitMarketingPreference`
4103
- # @return [Boolean]
4104
- attr_accessor :explicit_marketing_preference
4105
- alias_method :explicit_marketing_preference?, :explicit_marketing_preference
4106
-
4107
- # Full name of the customer.
4108
- # Corresponds to the JSON property `fullName`
4109
- # @return [String]
4110
- attr_accessor :full_name
4111
-
4112
- # Customer's marketing preferences.
4113
- # Corresponds to the JSON property `marketingRightsInfo`
4114
- # @return [Google::Apis::ContentV2sandbox::TestOrderCustomerMarketingRightsInfo]
4115
- attr_accessor :marketing_rights_info
4116
-
4117
- def initialize(**args)
4118
- update!(**args)
4119
- end
4120
-
4121
- # Update properties of this object
4122
- def update!(**args)
4123
- @email = args[:email] if args.key?(:email)
4124
- @explicit_marketing_preference = args[:explicit_marketing_preference] if args.key?(:explicit_marketing_preference)
4125
- @full_name = args[:full_name] if args.key?(:full_name)
4126
- @marketing_rights_info = args[:marketing_rights_info] if args.key?(:marketing_rights_info)
4127
- end
4128
- end
4129
-
4130
- #
4131
- class TestOrderCustomerMarketingRightsInfo
4132
- include Google::Apis::Core::Hashable
4133
-
4134
- # Last know user use selection regards marketing preferences. In certain cases
4135
- # selection might not be known, so this field would be empty.
4136
- # Corresponds to the JSON property `explicitMarketingPreference`
4137
- # @return [String]
4138
- attr_accessor :explicit_marketing_preference
4139
-
4140
- # Timestamp when last time marketing preference was updated. Could be empty, if
4141
- # user wasn't offered a selection yet.
4142
- # Corresponds to the JSON property `lastUpdatedTimestamp`
4143
- # @return [String]
4144
- attr_accessor :last_updated_timestamp
4145
-
4146
- def initialize(**args)
4147
- update!(**args)
4148
- end
4149
-
4150
- # Update properties of this object
4151
- def update!(**args)
4152
- @explicit_marketing_preference = args[:explicit_marketing_preference] if args.key?(:explicit_marketing_preference)
4153
- @last_updated_timestamp = args[:last_updated_timestamp] if args.key?(:last_updated_timestamp)
4154
- end
4155
- end
4156
-
4157
- #
4158
- class TestOrderLineItem
4159
- include Google::Apis::Core::Hashable
4160
-
4161
- # Product data from the time of the order placement.
4162
- # Corresponds to the JSON property `product`
4163
- # @return [Google::Apis::ContentV2sandbox::TestOrderLineItemProduct]
4164
- attr_accessor :product
4165
-
4166
- # Number of items ordered.
4167
- # Corresponds to the JSON property `quantityOrdered`
4168
- # @return [Fixnum]
4169
- attr_accessor :quantity_ordered
4170
-
4171
- # Details of the return policy for the line item.
4172
- # Corresponds to the JSON property `returnInfo`
4173
- # @return [Google::Apis::ContentV2sandbox::OrderLineItemReturnInfo]
4174
- attr_accessor :return_info
4175
-
4176
- # Details of the requested shipping for the line item.
4177
- # Corresponds to the JSON property `shippingDetails`
4178
- # @return [Google::Apis::ContentV2sandbox::OrderLineItemShippingDetails]
4179
- attr_accessor :shipping_details
4180
-
4181
- # Unit tax for the line item.
4182
- # Corresponds to the JSON property `unitTax`
4183
- # @return [Google::Apis::ContentV2sandbox::Price]
4184
- attr_accessor :unit_tax
4185
-
4186
- def initialize(**args)
4187
- update!(**args)
4188
- end
4189
-
4190
- # Update properties of this object
4191
- def update!(**args)
4192
- @product = args[:product] if args.key?(:product)
4193
- @quantity_ordered = args[:quantity_ordered] if args.key?(:quantity_ordered)
4194
- @return_info = args[:return_info] if args.key?(:return_info)
4195
- @shipping_details = args[:shipping_details] if args.key?(:shipping_details)
4196
- @unit_tax = args[:unit_tax] if args.key?(:unit_tax)
4197
- end
4198
- end
4199
-
4200
- #
4201
- class TestOrderLineItemProduct
4202
- include Google::Apis::Core::Hashable
4203
-
4204
- # Brand of the item.
4205
- # Corresponds to the JSON property `brand`
4206
- # @return [String]
4207
- attr_accessor :brand
4208
-
4209
- # The item's channel.
4210
- # Corresponds to the JSON property `channel`
4211
- # @return [String]
4212
- attr_accessor :channel
4213
-
4214
- # Condition or state of the item.
4215
- # Corresponds to the JSON property `condition`
4216
- # @return [String]
4217
- attr_accessor :condition
4218
-
4219
- # The two-letter ISO 639-1 language code for the item.
4220
- # Corresponds to the JSON property `contentLanguage`
4221
- # @return [String]
4222
- attr_accessor :content_language
4223
-
4224
- # Global Trade Item Number (GTIN) of the item. Optional.
4225
- # Corresponds to the JSON property `gtin`
4226
- # @return [String]
4227
- attr_accessor :gtin
4228
-
4229
- # URL of an image of the item.
4230
- # Corresponds to the JSON property `imageLink`
4231
- # @return [String]
4232
- attr_accessor :image_link
4233
-
4234
- # Shared identifier for all variants of the same product. Optional.
4235
- # Corresponds to the JSON property `itemGroupId`
4236
- # @return [String]
4237
- attr_accessor :item_group_id
4238
-
4239
- # Manufacturer Part Number (MPN) of the item. Optional.
4240
- # Corresponds to the JSON property `mpn`
4241
- # @return [String]
4242
- attr_accessor :mpn
4243
-
4244
- # An identifier of the item.
4245
- # Corresponds to the JSON property `offerId`
4246
- # @return [String]
4247
- attr_accessor :offer_id
4248
-
4249
- # The price for the product.
4250
- # Corresponds to the JSON property `price`
4251
- # @return [Google::Apis::ContentV2sandbox::Price]
4252
- attr_accessor :price
4253
-
4254
- # The CLDR territory code of the target country of the product.
4255
- # Corresponds to the JSON property `targetCountry`
4256
- # @return [String]
4257
- attr_accessor :target_country
4258
-
4259
- # The title of the product.
4260
- # Corresponds to the JSON property `title`
4261
- # @return [String]
4262
- attr_accessor :title
4263
-
4264
- # Variant attributes for the item. Optional.
4265
- # Corresponds to the JSON property `variantAttributes`
4266
- # @return [Array<Google::Apis::ContentV2sandbox::OrderLineItemProductVariantAttribute>]
4267
- attr_accessor :variant_attributes
4268
-
4269
- def initialize(**args)
4270
- update!(**args)
4271
- end
4272
-
4273
- # Update properties of this object
4274
- def update!(**args)
4275
- @brand = args[:brand] if args.key?(:brand)
4276
- @channel = args[:channel] if args.key?(:channel)
4277
- @condition = args[:condition] if args.key?(:condition)
4278
- @content_language = args[:content_language] if args.key?(:content_language)
4279
- @gtin = args[:gtin] if args.key?(:gtin)
4280
- @image_link = args[:image_link] if args.key?(:image_link)
4281
- @item_group_id = args[:item_group_id] if args.key?(:item_group_id)
4282
- @mpn = args[:mpn] if args.key?(:mpn)
4283
- @offer_id = args[:offer_id] if args.key?(:offer_id)
4284
- @price = args[:price] if args.key?(:price)
4285
- @target_country = args[:target_country] if args.key?(:target_country)
4286
- @title = args[:title] if args.key?(:title)
4287
- @variant_attributes = args[:variant_attributes] if args.key?(:variant_attributes)
4288
- end
4289
- end
4290
-
4291
- #
4292
- class TestOrderPaymentMethod
4293
- include Google::Apis::Core::Hashable
4294
-
4295
- # The card expiration month (January = 1, February = 2 etc.).
4296
- # Corresponds to the JSON property `expirationMonth`
4297
- # @return [Fixnum]
4298
- attr_accessor :expiration_month
4299
-
4300
- # The card expiration year (4-digit, e.g. 2015).
4301
- # Corresponds to the JSON property `expirationYear`
4302
- # @return [Fixnum]
4303
- attr_accessor :expiration_year
4304
-
4305
- # The last four digits of the card number.
4306
- # Corresponds to the JSON property `lastFourDigits`
4307
- # @return [String]
4308
- attr_accessor :last_four_digits
4309
-
4310
- # The billing address.
4311
- # Corresponds to the JSON property `predefinedBillingAddress`
4312
- # @return [String]
4313
- attr_accessor :predefined_billing_address
4314
-
4315
- # The type of instrument. Note that real orders might have different values than
4316
- # the four values accepted by createTestOrder.
4317
- # Corresponds to the JSON property `type`
4318
- # @return [String]
4319
- attr_accessor :type
4320
-
4321
- def initialize(**args)
4322
- update!(**args)
4323
- end
4324
-
4325
- # Update properties of this object
4326
- def update!(**args)
4327
- @expiration_month = args[:expiration_month] if args.key?(:expiration_month)
4328
- @expiration_year = args[:expiration_year] if args.key?(:expiration_year)
4329
- @last_four_digits = args[:last_four_digits] if args.key?(:last_four_digits)
4330
- @predefined_billing_address = args[:predefined_billing_address] if args.key?(:predefined_billing_address)
4331
- @type = args[:type] if args.key?(:type)
4332
- end
4333
- end
4334
-
4335
- #
4336
- class UnitInvoice
4337
- include Google::Apis::Core::Hashable
4338
-
4339
- # Additional charges for a unit, e.g. shipping costs.
4340
- # Corresponds to the JSON property `additionalCharges`
4341
- # @return [Array<Google::Apis::ContentV2sandbox::UnitInvoiceAdditionalCharge>]
4342
- attr_accessor :additional_charges
4343
-
4344
- # Promotions applied to a unit.
4345
- # Corresponds to the JSON property `promotions`
4346
- # @return [Array<Google::Apis::ContentV2sandbox::Promotion>]
4347
- attr_accessor :promotions
4348
-
4349
- # [required] Price of the unit, before applying taxes.
4350
- # Corresponds to the JSON property `unitPricePretax`
4351
- # @return [Google::Apis::ContentV2sandbox::Price]
4352
- attr_accessor :unit_price_pretax
4353
-
4354
- # Tax amounts to apply to the unit price.
4355
- # Corresponds to the JSON property `unitPriceTaxes`
4356
- # @return [Array<Google::Apis::ContentV2sandbox::UnitInvoiceTaxLine>]
4357
- attr_accessor :unit_price_taxes
4358
-
4359
- def initialize(**args)
4360
- update!(**args)
4361
- end
4362
-
4363
- # Update properties of this object
4364
- def update!(**args)
4365
- @additional_charges = args[:additional_charges] if args.key?(:additional_charges)
4366
- @promotions = args[:promotions] if args.key?(:promotions)
4367
- @unit_price_pretax = args[:unit_price_pretax] if args.key?(:unit_price_pretax)
4368
- @unit_price_taxes = args[:unit_price_taxes] if args.key?(:unit_price_taxes)
4369
- end
4370
- end
4371
-
4372
- #
4373
- class UnitInvoiceAdditionalCharge
4374
- include Google::Apis::Core::Hashable
4375
-
4376
- # [required] Amount of the additional charge.
4377
- # Corresponds to the JSON property `additionalChargeAmount`
4378
- # @return [Google::Apis::ContentV2sandbox::Amount]
4379
- attr_accessor :additional_charge_amount
4380
-
4381
- # Promotions applied to the additional charge.
4382
- # Corresponds to the JSON property `additionalChargePromotions`
4383
- # @return [Array<Google::Apis::ContentV2sandbox::Promotion>]
4384
- attr_accessor :additional_charge_promotions
4385
-
4386
- # [required] Type of the additional charge.
4387
- # Corresponds to the JSON property `type`
4388
- # @return [String]
4389
- attr_accessor :type
4390
-
4391
- def initialize(**args)
4392
- update!(**args)
4393
- end
4394
-
4395
- # Update properties of this object
4396
- def update!(**args)
4397
- @additional_charge_amount = args[:additional_charge_amount] if args.key?(:additional_charge_amount)
4398
- @additional_charge_promotions = args[:additional_charge_promotions] if args.key?(:additional_charge_promotions)
4399
- @type = args[:type] if args.key?(:type)
4400
- end
4401
- end
4402
-
4403
- #
4404
- class UnitInvoiceTaxLine
4405
- include Google::Apis::Core::Hashable
4406
-
4407
- # [required] Tax amount for the tax type.
4408
- # Corresponds to the JSON property `taxAmount`
4409
- # @return [Google::Apis::ContentV2sandbox::Price]
4410
- attr_accessor :tax_amount
4411
-
4412
- # Optional name of the tax type. This should only be provided if taxType is
4413
- # otherFeeTax.
4414
- # Corresponds to the JSON property `taxName`
4415
- # @return [String]
4416
- attr_accessor :tax_name
4417
-
4418
- # [required] Type of the tax.
4419
- # Corresponds to the JSON property `taxType`
4420
- # @return [String]
4421
- attr_accessor :tax_type
4422
-
4423
- def initialize(**args)
4424
- update!(**args)
4425
- end
4426
-
4427
- # Update properties of this object
4428
- def update!(**args)
4429
- @tax_amount = args[:tax_amount] if args.key?(:tax_amount)
4430
- @tax_name = args[:tax_name] if args.key?(:tax_name)
4431
- @tax_type = args[:tax_type] if args.key?(:tax_type)
4432
- end
4433
- end
4434
- end
4435
- end
4436
- end