← Back to branch summary

~juju-qa/ubuntu/trusty/juju/juju-1.25.8

« back to all changes in this revision

Viewing changes to src/google.golang.org/api/reseller/v1sandbox/reseller-api.json

  • Committer: Nicholas Skaggs
  • Date: 2016-12-02 18:01:10 UTC
  • Revision ID: nicholas.skaggs@canonical.com-20161202180110-dl1helep8qfebmhx
Import upstream 1.25.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/google.golang.org/api/reseller/v1sandbox/reseller-api.json
 
1
{
 
2
 "kind": "discovery#restDescription",
 
3
 "etag": "\"l66ggWbucbkBw9Lpos72oziyefE/YC4k2HSQWcnQUrh-4yOyG5WxRbQ\"",
 
4
 "discoveryVersion": "v1",
 
5
 "id": "reseller:v1sandbox",
 
6
 "name": "reseller",
 
7
 "version": "v1sandbox",
 
8
 "revision": "20140821",
 
9
 "title": "Enterprise Apps Reseller API",
 
10
 "description": "Lets you create and manage your customers and their subscriptions.",
 
11
 "ownerDomain": "google.com",
 
12
 "ownerName": "Google",
 
13
 "icons": {
 
14
  "x16": "http://www.google.com/images/icons/product/search-16.gif",
 
15
  "x32": "http://www.google.com/images/icons/product/search-32.gif"
 
16
 },
 
17
 "documentationLink": "https://developers.google.com/google-apps/reseller/",
 
18
 "labels": [
 
19
  "limited_availability"
 
20
 ],
 
21
 "protocol": "rest",
 
22
 "baseUrl": "https://www.googleapis.com/apps/reseller/v1sandbox/",
 
23
 "basePath": "/apps/reseller/v1sandbox/",
 
24
 "rootUrl": "https://www.googleapis.com/",
 
25
 "servicePath": "apps/reseller/v1sandbox/",
 
26
 "batchPath": "batch",
 
27
 "parameters": {
 
28
  "alt": {
 
29
   "type": "string",
 
30
   "description": "Data format for the response.",
 
31
   "default": "json",
 
32
   "enum": [
 
33
    "json"
 
34
   ],
 
35
   "enumDescriptions": [
 
36
    "Responses with Content-Type of application/json"
 
37
   ],
 
38
   "location": "query"
 
39
  },
 
40
  "fields": {
 
41
   "type": "string",
 
42
   "description": "Selector specifying which fields to include in a partial response.",
 
43
   "location": "query"
 
44
  },
 
45
  "key": {
 
46
   "type": "string",
 
47
   "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
 
48
   "location": "query"
 
49
  },
 
50
  "oauth_token": {
 
51
   "type": "string",
 
52
   "description": "OAuth 2.0 token for the current user.",
 
53
   "location": "query"
 
54
  },
 
55
  "prettyPrint": {
 
56
   "type": "boolean",
 
57
   "description": "Returns response with indentations and line breaks.",
 
58
   "default": "true",
 
59
   "location": "query"
 
60
  },
 
61
  "quotaUser": {
 
62
   "type": "string",
 
63
   "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
 
64
   "location": "query"
 
65
  },
 
66
  "userIp": {
 
67
   "type": "string",
 
68
   "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
 
69
   "location": "query"
 
70
  }
 
71
 },
 
72
 "auth": {
 
73
  "oauth2": {
 
74
   "scopes": {
 
75
    "https://www.googleapis.com/auth/apps.order": {
 
76
     "description": "Manage users on your domain"
 
77
    },
 
78
    "https://www.googleapis.com/auth/apps.order.readonly": {
 
79
     "description": "Manage users on your domain"
 
80
    }
 
81
   }
 
82
  }
 
83
 },
 
84
 "schemas": {
 
85
  "Address": {
 
86
   "id": "Address",
 
87
   "type": "object",
 
88
   "description": "JSON template for address of a customer.",
 
89
   "properties": {
 
90
    "addressLine1": {
 
91
     "type": "string",
 
92
     "description": "Address line 1 of the address."
 
93
    },
 
94
    "addressLine2": {
 
95
     "type": "string",
 
96
     "description": "Address line 2 of the address."
 
97
    },
 
98
    "addressLine3": {
 
99
     "type": "string",
 
100
     "description": "Address line 3 of the address."
 
101
    },
 
102
    "contactName": {
 
103
     "type": "string",
 
104
     "description": "Name of the contact person."
 
105
    },
 
106
    "countryCode": {
 
107
     "type": "string",
 
108
     "description": "ISO 3166 country code."
 
109
    },
 
110
    "kind": {
 
111
     "type": "string",
 
112
     "description": "Identifies the resource as a customer address.",
 
113
     "default": "customers#address"
 
114
    },
 
115
    "locality": {
 
116
     "type": "string",
 
117
     "description": "Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element."
 
118
    },
 
119
    "organizationName": {
 
120
     "type": "string",
 
121
     "description": "Name of the organization."
 
122
    },
 
123
    "postalCode": {
 
124
     "type": "string",
 
125
     "description": "The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element."
 
126
    },
 
127
    "region": {
 
128
     "type": "string",
 
129
     "description": "Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element."
 
130
    }
 
131
   }
 
132
  },
 
133
  "ChangePlanRequest": {
 
134
   "id": "ChangePlanRequest",
 
135
   "type": "object",
 
136
   "description": "JSON template for the ChangePlan rpc request.",
 
137
   "properties": {
 
138
    "kind": {
 
139
     "type": "string",
 
140
     "description": "Identifies the resource as a subscription change plan request.",
 
141
     "default": "subscriptions#changePlanRequest"
 
142
    },
 
143
    "planName": {
 
144
     "type": "string",
 
145
     "description": "Name of the plan to change to."
 
146
    },
 
147
    "purchaseOrderId": {
 
148
     "type": "string",
 
149
     "description": "Purchase order id for your order tracking purposes."
 
150
    },
 
151
    "seats": {
 
152
     "$ref": "Seats",
 
153
     "description": "Number/Limit of seats in the new plan."
 
154
    }
 
155
   }
 
156
  },
 
157
  "Customer": {
 
158
   "id": "Customer",
 
159
   "type": "object",
 
160
   "description": "JSON template for a customer.",
 
161
   "properties": {
 
162
    "alternateEmail": {
 
163
     "type": "string",
 
164
     "description": "The alternate email of the customer."
 
165
    },
 
166
    "customerDomain": {
 
167
     "type": "string",
 
168
     "description": "The domain name of the customer."
 
169
    },
 
170
    "customerId": {
 
171
     "type": "string",
 
172
     "description": "The id of the customer."
 
173
    },
 
174
    "kind": {
 
175
     "type": "string",
 
176
     "description": "Identifies the resource as a customer.",
 
177
     "default": "reseller#customer"
 
178
    },
 
179
    "phoneNumber": {
 
180
     "type": "string",
 
181
     "description": "The phone number of the customer."
 
182
    },
 
183
    "postalAddress": {
 
184
     "$ref": "Address",
 
185
     "description": "The postal address of the customer."
 
186
    },
 
187
    "resourceUiUrl": {
 
188
     "type": "string",
 
189
     "description": "Ui url for customer resource."
 
190
    }
 
191
   }
 
192
  },
 
193
  "RenewalSettings": {
 
194
   "id": "RenewalSettings",
 
195
   "type": "object",
 
196
   "description": "JSON template for a subscription renewal settings.",
 
197
   "properties": {
 
198
    "kind": {
 
199
     "type": "string",
 
200
     "description": "Identifies the resource as a subscription renewal setting.",
 
201
     "default": "subscriptions#renewalSettings"
 
202
    },
 
203
    "renewalType": {
 
204
     "type": "string",
 
205
     "description": "Subscription renewal type."
 
206
    }
 
207
   }
 
208
  },
 
209
  "Seats": {
 
210
   "id": "Seats",
 
211
   "type": "object",
 
212
   "description": "JSON template for subscription seats.",
 
213
   "properties": {
 
214
    "kind": {
 
215
     "type": "string",
 
216
     "description": "Identifies the resource as a subscription change plan request.",
 
217
     "default": "subscriptions#seats"
 
218
    },
 
219
    "licensedNumberOfSeats": {
 
220
     "type": "integer",
 
221
     "description": "Read only field containing the current number of licensed seats. Resellers can utilize this field to gather insights into usage for FLEXIBLE Google-Apps subscriptions and other secondary subscriptions (e.g. Google-Vault, Drive-storage).",
 
222
     "format": "int32"
 
223
    },
 
224
    "maximumNumberOfSeats": {
 
225
     "type": "integer",
 
226
     "description": "Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.",
 
227
     "format": "int32"
 
228
    },
 
229
    "numberOfSeats": {
 
230
     "type": "integer",
 
231
     "description": "Number of seats to purchase. This is applicable only for a commitment plan.",
 
232
     "format": "int32"
 
233
    }
 
234
   }
 
235
  },
 
236
  "Subscription": {
 
237
   "id": "Subscription",
 
238
   "type": "object",
 
239
   "description": "JSON template for a subscription.",
 
240
   "properties": {
 
241
    "creationTime": {
 
242
     "type": "string",
 
243
     "description": "Creation time of this subscription in milliseconds since Unix epoch.",
 
244
     "format": "int64"
 
245
    },
 
246
    "customerId": {
 
247
     "type": "string",
 
248
     "description": "The id of the customer to whom the subscription belongs."
 
249
    },
 
250
    "kind": {
 
251
     "type": "string",
 
252
     "description": "Identifies the resource as a Subscription.",
 
253
     "default": "reseller#subscription"
 
254
    },
 
255
    "plan": {
 
256
     "type": "object",
 
257
     "description": "Plan details of the subscription",
 
258
     "properties": {
 
259
      "commitmentInterval": {
 
260
       "type": "object",
 
261
       "description": "Interval of the commitment if it is a commitment plan.",
 
262
       "properties": {
 
263
        "endTime": {
 
264
         "type": "string",
 
265
         "description": "End time of the commitment interval in milliseconds since Unix epoch.",
 
266
         "format": "int64"
 
267
        },
 
268
        "startTime": {
 
269
         "type": "string",
 
270
         "description": "Start time of the commitment interval in milliseconds since Unix epoch.",
 
271
         "format": "int64"
 
272
        }
 
273
       }
 
274
      },
 
275
      "isCommitmentPlan": {
 
276
       "type": "boolean",
 
277
       "description": "Whether the plan is a commitment plan or not."
 
278
      },
 
279
      "planName": {
 
280
       "type": "string",
 
281
       "description": "The plan name of this subscription's plan."
 
282
      }
 
283
     }
 
284
    },
 
285
    "purchaseOrderId": {
 
286
     "type": "string",
 
287
     "description": "Purchase order id for your order tracking purposes."
 
288
    },
 
289
    "renewalSettings": {
 
290
     "$ref": "RenewalSettings",
 
291
     "description": "Renewal settings of the subscription."
 
292
    },
 
293
    "resourceUiUrl": {
 
294
     "type": "string",
 
295
     "description": "Ui url for subscription resource."
 
296
    },
 
297
    "seats": {
 
298
     "$ref": "Seats",
 
299
     "description": "Number/Limit of seats in the new plan."
 
300
    },
 
301
    "skuId": {
 
302
     "type": "string",
 
303
     "description": "Name of the sku for which this subscription is purchased."
 
304
    },
 
305
    "status": {
 
306
     "type": "string",
 
307
     "description": "Status of the subscription."
 
308
    },
 
309
    "subscriptionId": {
 
310
     "type": "string",
 
311
     "description": "The id of the subscription."
 
312
    },
 
313
    "transferInfo": {
 
314
     "type": "object",
 
315
     "description": "Transfer related information for the subscription.",
 
316
     "properties": {
 
317
      "minimumTransferableSeats": {
 
318
       "type": "integer",
 
319
       "format": "int32"
 
320
      },
 
321
      "transferabilityExpirationTime": {
 
322
       "type": "string",
 
323
       "description": "Time when transfer token or intent to transfer will expire.",
 
324
       "format": "int64"
 
325
      }
 
326
     }
 
327
    },
 
328
    "trialSettings": {
 
329
     "type": "object",
 
330
     "description": "Trial Settings of the subscription.",
 
331
     "properties": {
 
332
      "isInTrial": {
 
333
       "type": "boolean",
 
334
       "description": "Whether the subscription is in trial."
 
335
      },
 
336
      "trialEndTime": {
 
337
       "type": "string",
 
338
       "description": "End time of the trial in milliseconds since Unix epoch.",
 
339
       "format": "int64"
 
340
      }
 
341
     }
 
342
    }
 
343
   }
 
344
  },
 
345
  "Subscriptions": {
 
346
   "id": "Subscriptions",
 
347
   "type": "object",
 
348
   "description": "JSON template for a subscription list.",
 
349
   "properties": {
 
350
    "kind": {
 
351
     "type": "string",
 
352
     "description": "Identifies the resource as a collection of subscriptions.",
 
353
     "default": "reseller#subscriptions"
 
354
    },
 
355
    "nextPageToken": {
 
356
     "type": "string",
 
357
     "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results."
 
358
    },
 
359
    "subscriptions": {
 
360
     "type": "array",
 
361
     "description": "The subscriptions in this page of results.",
 
362
     "items": {
 
363
      "$ref": "Subscription"
 
364
     }
 
365
    }
 
366
   }
 
367
  }
 
368
 },
 
369
 "resources": {
 
370
  "customers": {
 
371
   "methods": {
 
372
    "get": {
 
373
     "id": "reseller.customers.get",
 
374
     "path": "customers/{customerId}",
 
375
     "httpMethod": "GET",
 
376
     "description": "Gets a customer resource if one exists and is owned by the reseller.",
 
377
     "parameters": {
 
378
      "customerId": {
 
379
       "type": "string",
 
380
       "description": "Id of the Customer",
 
381
       "required": true,
 
382
       "location": "path"
 
383
      }
 
384
     },
 
385
     "parameterOrder": [
 
386
      "customerId"
 
387
     ],
 
388
     "response": {
 
389
      "$ref": "Customer"
 
390
     },
 
391
     "scopes": [
 
392
      "https://www.googleapis.com/auth/apps.order",
 
393
      "https://www.googleapis.com/auth/apps.order.readonly"
 
394
     ]
 
395
    },
 
396
    "insert": {
 
397
     "id": "reseller.customers.insert",
 
398
     "path": "customers",
 
399
     "httpMethod": "POST",
 
400
     "description": "Creates a customer resource if one does not already exist.",
 
401
     "parameters": {
 
402
      "customerAuthToken": {
 
403
       "type": "string",
 
404
       "description": "An auth token needed for inserting a customer for which domain already exists. Can be generated at https://www.google.com/a/cpanel//TransferToken. Optional.",
 
405
       "location": "query"
 
406
      }
 
407
     },
 
408
     "request": {
 
409
      "$ref": "Customer"
 
410
     },
 
411
     "response": {
 
412
      "$ref": "Customer"
 
413
     },
 
414
     "scopes": [
 
415
      "https://www.googleapis.com/auth/apps.order"
 
416
     ]
 
417
    },
 
418
    "patch": {
 
419
     "id": "reseller.customers.patch",
 
420
     "path": "customers/{customerId}",
 
421
     "httpMethod": "PATCH",
 
422
     "description": "Update a customer resource if one it exists and is owned by the reseller. This method supports patch semantics.",
 
423
     "parameters": {
 
424
      "customerId": {
 
425
       "type": "string",
 
426
       "description": "Id of the Customer",
 
427
       "required": true,
 
428
       "location": "path"
 
429
      }
 
430
     },
 
431
     "parameterOrder": [
 
432
      "customerId"
 
433
     ],
 
434
     "request": {
 
435
      "$ref": "Customer"
 
436
     },
 
437
     "response": {
 
438
      "$ref": "Customer"
 
439
     },
 
440
     "scopes": [
 
441
      "https://www.googleapis.com/auth/apps.order"
 
442
     ]
 
443
    },
 
444
    "update": {
 
445
     "id": "reseller.customers.update",
 
446
     "path": "customers/{customerId}",
 
447
     "httpMethod": "PUT",
 
448
     "description": "Update a customer resource if one it exists and is owned by the reseller.",
 
449
     "parameters": {
 
450
      "customerId": {
 
451
       "type": "string",
 
452
       "description": "Id of the Customer",
 
453
       "required": true,
 
454
       "location": "path"
 
455
      }
 
456
     },
 
457
     "parameterOrder": [
 
458
      "customerId"
 
459
     ],
 
460
     "request": {
 
461
      "$ref": "Customer"
 
462
     },
 
463
     "response": {
 
464
      "$ref": "Customer"
 
465
     },
 
466
     "scopes": [
 
467
      "https://www.googleapis.com/auth/apps.order"
 
468
     ]
 
469
    }
 
470
   }
 
471
  },
 
472
  "subscriptions": {
 
473
   "methods": {
 
474
    "activate": {
 
475
     "id": "reseller.subscriptions.activate",
 
476
     "path": "customers/{customerId}/subscriptions/{subscriptionId}/activate",
 
477
     "httpMethod": "POST",
 
478
     "description": "Activates a subscription previously suspended by the reseller",
 
479
     "parameters": {
 
480
      "customerId": {
 
481
       "type": "string",
 
482
       "description": "Id of the Customer",
 
483
       "required": true,
 
484
       "location": "path"
 
485
      },
 
486
      "subscriptionId": {
 
487
       "type": "string",
 
488
       "description": "Id of the subscription, which is unique for a customer",
 
489
       "required": true,
 
490
       "location": "path"
 
491
      }
 
492
     },
 
493
     "parameterOrder": [
 
494
      "customerId",
 
495
      "subscriptionId"
 
496
     ],
 
497
     "response": {
 
498
      "$ref": "Subscription"
 
499
     },
 
500
     "scopes": [
 
501
      "https://www.googleapis.com/auth/apps.order"
 
502
     ]
 
503
    },
 
504
    "changePlan": {
 
505
     "id": "reseller.subscriptions.changePlan",
 
506
     "path": "customers/{customerId}/subscriptions/{subscriptionId}/changePlan",
 
507
     "httpMethod": "POST",
 
508
     "description": "Changes the plan of a subscription",
 
509
     "parameters": {
 
510
      "customerId": {
 
511
       "type": "string",
 
512
       "description": "Id of the Customer",
 
513
       "required": true,
 
514
       "location": "path"
 
515
      },
 
516
      "subscriptionId": {
 
517
       "type": "string",
 
518
       "description": "Id of the subscription, which is unique for a customer",
 
519
       "required": true,
 
520
       "location": "path"
 
521
      }
 
522
     },
 
523
     "parameterOrder": [
 
524
      "customerId",
 
525
      "subscriptionId"
 
526
     ],
 
527
     "request": {
 
528
      "$ref": "ChangePlanRequest"
 
529
     },
 
530
     "response": {
 
531
      "$ref": "Subscription"
 
532
     },
 
533
     "scopes": [
 
534
      "https://www.googleapis.com/auth/apps.order"
 
535
     ]
 
536
    },
 
537
    "changeRenewalSettings": {
 
538
     "id": "reseller.subscriptions.changeRenewalSettings",
 
539
     "path": "customers/{customerId}/subscriptions/{subscriptionId}/changeRenewalSettings",
 
540
     "httpMethod": "POST",
 
541
     "description": "Changes the renewal settings of a subscription",
 
542
     "parameters": {
 
543
      "customerId": {
 
544
       "type": "string",
 
545
       "description": "Id of the Customer",
 
546
       "required": true,
 
547
       "location": "path"
 
548
      },
 
549
      "subscriptionId": {
 
550
       "type": "string",
 
551
       "description": "Id of the subscription, which is unique for a customer",
 
552
       "required": true,
 
553
       "location": "path"
 
554
      }
 
555
     },
 
556
     "parameterOrder": [
 
557
      "customerId",
 
558
      "subscriptionId"
 
559
     ],
 
560
     "request": {
 
561
      "$ref": "RenewalSettings"
 
562
     },
 
563
     "response": {
 
564
      "$ref": "Subscription"
 
565
     },
 
566
     "scopes": [
 
567
      "https://www.googleapis.com/auth/apps.order"
 
568
     ]
 
569
    },
 
570
    "changeSeats": {
 
571
     "id": "reseller.subscriptions.changeSeats",
 
572
     "path": "customers/{customerId}/subscriptions/{subscriptionId}/changeSeats",
 
573
     "httpMethod": "POST",
 
574
     "description": "Changes the seats configuration of a subscription",
 
575
     "parameters": {
 
576
      "customerId": {
 
577
       "type": "string",
 
578
       "description": "Id of the Customer",
 
579
       "required": true,
 
580
       "location": "path"
 
581
      },
 
582
      "subscriptionId": {
 
583
       "type": "string",
 
584
       "description": "Id of the subscription, which is unique for a customer",
 
585
       "required": true,
 
586
       "location": "path"
 
587
      }
 
588
     },
 
589
     "parameterOrder": [
 
590
      "customerId",
 
591
      "subscriptionId"
 
592
     ],
 
593
     "request": {
 
594
      "$ref": "Seats"
 
595
     },
 
596
     "response": {
 
597
      "$ref": "Subscription"
 
598
     },
 
599
     "scopes": [
 
600
      "https://www.googleapis.com/auth/apps.order"
 
601
     ]
 
602
    },
 
603
    "delete": {
 
604
     "id": "reseller.subscriptions.delete",
 
605
     "path": "customers/{customerId}/subscriptions/{subscriptionId}",
 
606
     "httpMethod": "DELETE",
 
607
     "description": "Cancels/Downgrades a subscription.",
 
608
     "parameters": {
 
609
      "customerId": {
 
610
       "type": "string",
 
611
       "description": "Id of the Customer",
 
612
       "required": true,
 
613
       "location": "path"
 
614
      },
 
615
      "deletionType": {
 
616
       "type": "string",
 
617
       "description": "Whether the subscription is to be fully cancelled or downgraded",
 
618
       "required": true,
 
619
       "enum": [
 
620
        "cancel",
 
621
        "downgrade",
 
622
        "suspend"
 
623
       ],
 
624
       "enumDescriptions": [
 
625
        "Cancels the subscription immediately",
 
626
        "Downgrades a Google Apps for Business subscription to Google Apps",
 
627
        "Suspends the subscriptions for 4 days before cancelling it"
 
628
       ],
 
629
       "location": "query"
 
630
      },
 
631
      "subscriptionId": {
 
632
       "type": "string",
 
633
       "description": "Id of the subscription, which is unique for a customer",
 
634
       "required": true,
 
635
       "location": "path"
 
636
      }
 
637
     },
 
638
     "parameterOrder": [
 
639
      "customerId",
 
640
      "subscriptionId",
 
641
      "deletionType"
 
642
     ],
 
643
     "scopes": [
 
644
      "https://www.googleapis.com/auth/apps.order"
 
645
     ]
 
646
    },
 
647
    "get": {
 
648
     "id": "reseller.subscriptions.get",
 
649
     "path": "customers/{customerId}/subscriptions/{subscriptionId}",
 
650
     "httpMethod": "GET",
 
651
     "description": "Gets a subscription of the customer.",
 
652
     "parameters": {
 
653
      "customerId": {
 
654
       "type": "string",
 
655
       "description": "Id of the Customer",
 
656
       "required": true,
 
657
       "location": "path"
 
658
      },
 
659
      "subscriptionId": {
 
660
       "type": "string",
 
661
       "description": "Id of the subscription, which is unique for a customer",
 
662
       "required": true,
 
663
       "location": "path"
 
664
      }
 
665
     },
 
666
     "parameterOrder": [
 
667
      "customerId",
 
668
      "subscriptionId"
 
669
     ],
 
670
     "response": {
 
671
      "$ref": "Subscription"
 
672
     },
 
673
     "scopes": [
 
674
      "https://www.googleapis.com/auth/apps.order",
 
675
      "https://www.googleapis.com/auth/apps.order.readonly"
 
676
     ]
 
677
    },
 
678
    "insert": {
 
679
     "id": "reseller.subscriptions.insert",
 
680
     "path": "customers/{customerId}/subscriptions",
 
681
     "httpMethod": "POST",
 
682
     "description": "Creates/Transfers a subscription for the customer.",
 
683
     "parameters": {
 
684
      "customerAuthToken": {
 
685
       "type": "string",
 
686
       "description": "An auth token needed for transferring a subscription. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken. Optional.",
 
687
       "location": "query"
 
688
      },
 
689
      "customerId": {
 
690
       "type": "string",
 
691
       "description": "Id of the Customer",
 
692
       "required": true,
 
693
       "location": "path"
 
694
      }
 
695
     },
 
696
     "parameterOrder": [
 
697
      "customerId"
 
698
     ],
 
699
     "request": {
 
700
      "$ref": "Subscription"
 
701
     },
 
702
     "response": {
 
703
      "$ref": "Subscription"
 
704
     },
 
705
     "scopes": [
 
706
      "https://www.googleapis.com/auth/apps.order"
 
707
     ]
 
708
    },
 
709
    "list": {
 
710
     "id": "reseller.subscriptions.list",
 
711
     "path": "subscriptions",
 
712
     "httpMethod": "GET",
 
713
     "description": "Lists subscriptions of a reseller, optionally filtered by a customer name prefix.",
 
714
     "parameters": {
 
715
      "customerAuthToken": {
 
716
       "type": "string",
 
717
       "description": "An auth token needed if the customer is not a resold customer of this reseller. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken.Optional.",
 
718
       "location": "query"
 
719
      },
 
720
      "customerId": {
 
721
       "type": "string",
 
722
       "description": "Id of the Customer",
 
723
       "location": "query"
 
724
      },
 
725
      "customerNamePrefix": {
 
726
       "type": "string",
 
727
       "description": "Prefix of the customer's domain name by which the subscriptions should be filtered. Optional",
 
728
       "location": "query"
 
729
      },
 
730
      "maxResults": {
 
731
       "type": "integer",
 
732
       "description": "Maximum number of results to return",
 
733
       "format": "uint32",
 
734
       "minimum": "1",
 
735
       "maximum": "100",
 
736
       "location": "query"
 
737
      },
 
738
      "pageToken": {
 
739
       "type": "string",
 
740
       "description": "Token to specify next page in the list",
 
741
       "location": "query"
 
742
      }
 
743
     },
 
744
     "response": {
 
745
      "$ref": "Subscriptions"
 
746
     },
 
747
     "scopes": [
 
748
      "https://www.googleapis.com/auth/apps.order",
 
749
      "https://www.googleapis.com/auth/apps.order.readonly"
 
750
     ]
 
751
    },
 
752
    "startPaidService": {
 
753
     "id": "reseller.subscriptions.startPaidService",
 
754
     "path": "customers/{customerId}/subscriptions/{subscriptionId}/startPaidService",
 
755
     "httpMethod": "POST",
 
756
     "description": "Starts paid service of a trial subscription",
 
757
     "parameters": {
 
758
      "customerId": {
 
759
       "type": "string",
 
760
       "description": "Id of the Customer",
 
761
       "required": true,
 
762
       "location": "path"
 
763
      },
 
764
      "subscriptionId": {
 
765
       "type": "string",
 
766
       "description": "Id of the subscription, which is unique for a customer",
 
767
       "required": true,
 
768
       "location": "path"
 
769
      }
 
770
     },
 
771
     "parameterOrder": [
 
772
      "customerId",
 
773
      "subscriptionId"
 
774
     ],
 
775
     "response": {
 
776
      "$ref": "Subscription"
 
777
     },
 
778
     "scopes": [
 
779
      "https://www.googleapis.com/auth/apps.order"
 
780
     ]
 
781
    },
 
782
    "suspend": {
 
783
     "id": "reseller.subscriptions.suspend",
 
784
     "path": "customers/{customerId}/subscriptions/{subscriptionId}/suspend",
 
785
     "httpMethod": "POST",
 
786
     "description": "Suspends an active subscription",
 
787
     "parameters": {
 
788
      "customerId": {
 
789
       "type": "string",
 
790
       "description": "Id of the Customer",
 
791
       "required": true,
 
792
       "location": "path"
 
793
      },
 
794
      "subscriptionId": {
 
795
       "type": "string",
 
796
       "description": "Id of the subscription, which is unique for a customer",
 
797
       "required": true,
 
798
       "location": "path"
 
799
      }
 
800
     },
 
801
     "parameterOrder": [
 
802
      "customerId",
 
803
      "subscriptionId"
 
804
     ],
 
805
     "response": {
 
806
      "$ref": "Subscription"
 
807
     },
 
808
     "scopes": [
 
809
      "https://www.googleapis.com/auth/apps.order"
 
810
     ]
 
811
    }
 
812
   }
 
813
  }
 
814
 }
 
815
}