@wix/app-management 1.0.35 → 1.0.36

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/app-management",
3
- "version": "1.0.35",
3
+ "version": "1.0.36",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -23,7 +23,7 @@
23
23
  "@wix/app-management_app-plans": "1.0.19",
24
24
  "@wix/app-management_bi-events": "1.0.18",
25
25
  "@wix/app-management_billing": "1.0.19",
26
- "@wix/app-management_custom-charges": "1.0.15",
26
+ "@wix/app-management_custom-charges": "1.0.16",
27
27
  "@wix/app-management_embedded-scripts": "1.0.15"
28
28
  },
29
29
  "devDependencies": {
@@ -49,5 +49,5 @@
49
49
  "fqdn": ""
50
50
  }
51
51
  },
52
- "falconPackageHash": "9904f6c73ad75d44c4d2763f0c9cc0c4b0ef4aabddeddd97f9a0c89a"
52
+ "falconPackageHash": "4f49ab71a49994f41062887b3c4025e3cbd51a8551b4608ef9d21890"
53
53
  }
@@ -202,15 +202,26 @@ interface CustomChargesConfig {
202
202
  baseUri?: SpiBaseUri;
203
203
  }
204
204
  interface SpiBaseUri {
205
- /** URI that will be used by the host to call the implementer. The path-suffix defined on the method will be appended to it */
205
+ /**
206
+ * Base URI where the methods are called. Wix appends the path to the `baseUri`.
207
+ * For example, to call the Get Shipping Rates method at `https://my-shipping-provider.com/v1/getRates`, the base URI you provide here is `https://my-shipping-provider.com/`.
208
+ */
206
209
  baseUri?: string;
207
- /** override method mappings per method */
210
+ /** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */
208
211
  alternativeUris?: AlternativeUri[];
209
212
  }
210
213
  interface AlternativeUri {
211
- /** name of the method as it appears in the proto */
214
+ /**
215
+ * Name of the method to create a custom URI for.
216
+ *
217
+ * For `methodName`, use the name of the method in PascalCase.
218
+ * For example, for Get Shipping Rates use `GetShippingRates`.
219
+ */
212
220
  methodName?: string;
213
- /** absolute uri that will be used by the host to call that method. The path-suffix mapped from the method http option will NOT be appended to this URI. For TPAs. it must be https */
221
+ /**
222
+ * Custom URI that Wix uses to call your server for this method. The path-suffix documented in the method will not be appended to this URI.
223
+ * Must be a secured endpoint beginning with `https://`. For example, `https://www.my-shipping-provider.com/my-shipping-rates`.
224
+ */
214
225
  absoluteUri?: string;
215
226
  }
216
227
  /**
@@ -202,15 +202,26 @@ interface CustomChargesConfig {
202
202
  baseUri?: SpiBaseUri;
203
203
  }
204
204
  interface SpiBaseUri {
205
- /** URI that will be used by the host to call the implementer. The path-suffix defined on the method will be appended to it */
205
+ /**
206
+ * Base URI where the methods are called. Wix appends the path to the `baseUri`.
207
+ * For example, to call the Get Shipping Rates method at `https://my-shipping-provider.com/v1/getRates`, the base URI you provide here is `https://my-shipping-provider.com/`.
208
+ */
206
209
  baseUri?: string;
207
- /** override method mappings per method */
210
+ /** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */
208
211
  alternativeUris?: AlternativeUri[];
209
212
  }
210
213
  interface AlternativeUri {
211
- /** name of the method as it appears in the proto */
214
+ /**
215
+ * Name of the method to create a custom URI for.
216
+ *
217
+ * For `methodName`, use the name of the method in PascalCase.
218
+ * For example, for Get Shipping Rates use `GetShippingRates`.
219
+ */
212
220
  methodName?: string;
213
- /** absolute uri that will be used by the host to call that method. The path-suffix mapped from the method http option will NOT be appended to this URI. For TPAs. it must be https */
221
+ /**
222
+ * Custom URI that Wix uses to call your server for this method. The path-suffix documented in the method will not be appended to this URI.
223
+ * Must be a secured endpoint beginning with `https://`. For example, `https://www.my-shipping-provider.com/my-shipping-rates`.
224
+ */
214
225
  absoluteUri?: string;
215
226
  }
216
227
  /**