gws-reseller

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

reseller (v1)

reseller (v1)

PREREQUISITE: Read
../gws-shared/SKILL.md
for auth, global flags, and security rules. If missing, run
gws generate-skills
to create it.
bash
gws reseller <resource> <method> [flags]
前提条件: 请阅读
../gws-shared/SKILL.md
了解认证、全局标志和安全规则。如果该文件缺失,请运行
gws generate-skills
命令创建。
bash
gws reseller <resource> <method> [flags]

API Resources

API资源

customers

customers

  • get
    — Gets a customer account. Use this operation to see a customer account already in your reseller management, or to see the minimal account information for an existing customer that you do not manage. For more information about the API response for existing customers, see retrieving a customer account.
    • insert
      — Orders a new customer's account.
    • patch
      — Updates a customer account's settings. This method supports patch semantics. You cannot update
      customerType
      via the Reseller API, but a
      "team"
      customer can verify their domain and become
      customerType = "domain"
      . For more information, see Verify your domain to unlock Essentials features.
    • update
      — Updates a customer account's settings. You cannot update
      customerType
      via the Reseller API, but a
      "team"
      customer can verify their domain and become
      customerType = "domain"
      . For more information, see update a customer's settings.
  • get
    — 获取客户账户。使用此操作查看已在您的经销商管理中的客户账户,或查看您未管理的现有客户的基本账户信息。有关现有客户的API响应详情,请参阅检索客户账户
    • insert
      — 订购新客户的账户。
    • patch
      — 更新客户账户的设置。此方法支持补丁语义。您无法通过经销商API更新
      customerType
      ,但
      "team"
      类型的客户可以验证其域名并转为
      customerType = "domain"
      。更多信息,请参阅验证域名以解锁Essentials功能
    • update
      — 更新客户账户的设置。您无法通过经销商API更新
      customerType
      ,但
      "team"
      类型的客户可以验证其域名并转为
      customerType = "domain"
      。更多信息,请参阅更新客户设置

resellernotify

resellernotify

  • getwatchdetails
    — Returns all the details of the watch corresponding to the reseller.
    • register
      — Registers a Reseller for receiving notifications.
    • unregister
      — Unregisters a Reseller for receiving notifications.
  • getwatchdetails
    — 返回与经销商对应的所有监听详情。
    • register
      — 注册经销商以接收通知。
    • unregister
      — 取消经销商的通知注册。

subscriptions

subscriptions

  • activate
    — Activates a subscription previously suspended by the reseller. If you did not suspend the customer subscription and it is suspended for any other reason, such as for abuse or a pending ToS acceptance, this call will not reactivate the customer subscription.
    • changePlan
      — Updates a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments. How a plan is updated differs depending on the plan and the products. For more information, see the description in manage subscriptions.
    • changeRenewalSettings
      — Updates a user license's renewal settings. This is applicable for accounts with annual commitment plans only. For more information, see the description in manage subscriptions.
    • changeSeats
      — Updates a subscription's user license settings. For more information about updating an annual commitment plan or a flexible plan subscription’s licenses, see Manage Subscriptions.
    • delete
      — Cancels, suspends, or transfers a subscription to direct.
    • get
      — Gets a specific subscription. The
      subscriptionId
      can be found using the Retrieve all reseller subscriptions method. For more information about retrieving a specific subscription, see the information descrived in manage subscriptions.
    • insert
      — Creates or transfer a subscription. Create a subscription for a customer's account that you ordered using the Order a new customer account method.
    • list
      — Lists of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions. Optionally, this method can filter the response by a
      customerNamePrefix
      . For more information, see manage subscriptions.
    • startPaidService
      — Immediately move a 30-day free trial subscription to a paid service subscription. This method is only applicable if a payment plan has already been set up for the 30-day trial subscription. For more information, see manage subscriptions.
    • suspend
      — Suspends an active subscription. You can use this method to suspend a paid subscription that is currently in the
      ACTIVE
      state. * For
      FLEXIBLE
      subscriptions, billing is paused. * For
      ANNUAL_MONTHLY_PAY
      or
      ANNUAL_YEARLY_PAY
      subscriptions: * Suspending the subscription does not change the renewal date that was originally committed to. * A suspended subscription does not renew.
  • activate
    — 激活之前由经销商暂停的订阅。如果客户订阅并非由您暂停,而是因其他原因(如滥用或待接受服务条款)被暂停,此调用将无法重新激活客户订阅。
    • changePlan
      — 更新订阅方案。使用此方法将30天试用或灵活方案的订阅更新为按月度或年度付款的年度承诺方案。方案更新方式因方案和产品而异。更多信息,请参阅管理订阅中的说明。
    • changeRenewalSettings
      — 更新用户许可证的续订设置。此操作仅适用于拥有年度承诺方案的账户。更多信息,请参阅管理订阅中的说明。
    • changeSeats
      — 更新订阅的用户许可证设置。有关更新年度承诺方案或灵活方案订阅许可证的更多信息,请参阅管理订阅
    • delete
      — 取消、暂停或转移订阅至直接管理。
    • get
      — 获取特定订阅。
      subscriptionId
      可通过检索所有经销商订阅方法获取。有关检索特定订阅的更多信息,请参阅管理订阅中的说明。
    • insert
      — 创建或转移订阅。为您通过订购新客户账户方法订购的客户账户创建订阅。
    • list
      — 列出经销商管理的所有订阅。列表可包含所有订阅、某客户的所有订阅或某客户的所有可转移订阅。此方法可选择通过
      customerNamePrefix
      过滤响应。更多信息,请参阅管理订阅
    • startPaidService
      — 立即将30天免费试用订阅转为付费服务订阅。此方法仅适用于已为30天试用订阅设置付款方案的情况。更多信息,请参阅管理订阅
    • suspend
      — 暂停活跃订阅。您可以使用此方法暂停当前处于
      ACTIVE
      状态的付费订阅。* 对于
      FLEXIBLE
      订阅,计费将暂停。* 对于
      ANNUAL_MONTHLY_PAY
      ANNUAL_YEARLY_PAY
      订阅:* 暂停订阅不会改变最初承诺的续订日期。* 已暂停的订阅不会续订。

Discovering Commands

探索命令

Before calling any API method, inspect it:
bash
undefined
调用任何API方法之前,请先查看其详情:
bash
undefined

Browse resources and methods

浏览资源和方法

gws reseller --help
gws reseller --help

Inspect a method's required params, types, and defaults

查看方法的必填参数、类型和默认值

gws schema reseller.<resource>.<method>

Use `gws schema` output to build your `--params` and `--json` flags.
gws schema reseller.<resource>.<method>

使用`gws schema`的输出来构建您的`--params`和`--json`标志。