@stigg/node-server-sdk 0.50.0 → 0.51.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/client.d.ts CHANGED
@@ -91,15 +91,15 @@ export declare class Stigg implements StiggEntitlementAPI, StiggManagementAPI {
91
91
  */
92
92
  importCustomer({ billingId, customerId, email, name }: ImportCustomer): Promise<Customer>;
93
93
  /**
94
- * Create a Customer.
95
- * @return {Promise<Customer>} Newly created customer. Throw exception on errors.
94
+ * Create a Customer and its first subscription
95
+ * @return {Promise<Customer>} Newly created customer and subscription. Throw exception on errors.
96
96
  * @param customerId - optional customer id, if not provided a random one will be generated.
97
97
  * @param email - optional customer email
98
98
  * @param name - optional customer name
99
99
  * @param billingInfo - optional billing info
100
100
  * @param couponId - optional coupon
101
101
  * @param metadata - optional metadata
102
- * @param subscriptionParams - first subscription to create for the customer
102
+ * @param subscriptionParams - first subscription to create for the customer (pass null to skip subscription creation)
103
103
  */
104
104
  provisionCustomer({ customerId, email, name, billingInfo, metadata, couponId, subscriptionParams, shouldSyncFree, }: ProvisionCustomer): Promise<ProvisionedCustomer>;
105
105
  /**
package/dist/client.js CHANGED
@@ -229,15 +229,15 @@ class Stigg {
229
229
  });
230
230
  }
231
231
  /**
232
- * Create a Customer.
233
- * @return {Promise<Customer>} Newly created customer. Throw exception on errors.
232
+ * Create a Customer and its first subscription
233
+ * @return {Promise<Customer>} Newly created customer and subscription. Throw exception on errors.
234
234
  * @param customerId - optional customer id, if not provided a random one will be generated.
235
235
  * @param email - optional customer email
236
236
  * @param name - optional customer name
237
237
  * @param billingInfo - optional billing info
238
238
  * @param couponId - optional coupon
239
239
  * @param metadata - optional metadata
240
- * @param subscriptionParams - first subscription to create for the customer
240
+ * @param subscriptionParams - first subscription to create for the customer (pass null to skip subscription creation)
241
241
  */
242
242
  async provisionCustomer({ customerId, email, name, billingInfo, metadata, couponId, subscriptionParams, shouldSyncFree, }) {
243
243
  return (0, apiErrorHandling_1.withErrorHandling)(async () => {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stigg/node-server-sdk",
3
- "version": "0.50.0",
3
+ "version": "0.51.0",
4
4
  "description": "Stigg server-side node SDK",
5
5
  "main": "dist/index.js",
6
6
  "typings": "dist/index.d.ts",