ultracart_rest_api_v2_typescript 4.1.144 → 4.1.145
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/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# UltraCart Typescript SDK
|
|
2
|
-
## ultracart_rest_api_v2_typescript@4.1.
|
|
2
|
+
## ultracart_rest_api_v2_typescript@4.1.145
|
|
3
3
|
|
|
4
4
|
Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
|
|
5
5
|
|
|
6
6
|
Installation
|
|
7
7
|
|
|
8
8
|
```
|
|
9
|
-
npm install ultracart_rest_api_v2_typescript@4.1.
|
|
9
|
+
npm install ultracart_rest_api_v2_typescript@4.1.145 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
|
|
|
85
85
|
|
|
86
86
|
| Version | Date | Comments |
|
|
87
87
|
| --: | :-: | --- |
|
|
88
|
+
| 4.1.145 | 09/02/2026 | sfvb - internal testing |
|
|
88
89
|
| 4.1.144 | 09/02/2026 | sfvb - internal testing |
|
|
89
90
|
| 4.1.143 | 09/02/2026 | sfvb - internal development |
|
|
90
91
|
| 4.1.142 | 08/26/2026 | sfvb - internal test |
|
package/dist/apis/SfvbApi.d.ts
CHANGED
|
@@ -378,7 +378,7 @@ export interface SfvbApiInterface {
|
|
|
378
378
|
*/
|
|
379
379
|
getSfvbLibraryEntry(requestParameters: GetSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
|
|
380
380
|
/**
|
|
381
|
-
*
|
|
381
|
+
* Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
|
|
382
382
|
* @summary URL that renders a preview session
|
|
383
383
|
* @param {number} storefrontOid
|
|
384
384
|
* @param {string} previewSessionId
|
|
@@ -389,6 +389,7 @@ export interface SfvbApiInterface {
|
|
|
389
389
|
*/
|
|
390
390
|
getSfvbPreviewUrlRaw(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewUrlResponse>>;
|
|
391
391
|
/**
|
|
392
|
+
* Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
|
|
392
393
|
* URL that renders a preview session
|
|
393
394
|
*/
|
|
394
395
|
getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
|
|
@@ -894,10 +895,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
894
895
|
*/
|
|
895
896
|
getSfvbLibraryEntry(requestParameters: GetSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
|
|
896
897
|
/**
|
|
898
|
+
* Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
|
|
897
899
|
* URL that renders a preview session
|
|
898
900
|
*/
|
|
899
901
|
getSfvbPreviewUrlRaw(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewUrlResponse>>;
|
|
900
902
|
/**
|
|
903
|
+
* Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
|
|
901
904
|
* URL that renders a preview session
|
|
902
905
|
*/
|
|
903
906
|
getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
|
package/dist/apis/SfvbApi.js
CHANGED
|
@@ -893,6 +893,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
893
893
|
});
|
|
894
894
|
};
|
|
895
895
|
/**
|
|
896
|
+
* Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
|
|
896
897
|
* URL that renders a preview session
|
|
897
898
|
*/
|
|
898
899
|
SfvbApi.prototype.getSfvbPreviewUrlRaw = function (requestParameters, initOverrides) {
|
|
@@ -939,6 +940,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
939
940
|
});
|
|
940
941
|
};
|
|
941
942
|
/**
|
|
943
|
+
* Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
|
|
942
944
|
* URL that renders a preview session
|
|
943
945
|
*/
|
|
944
946
|
SfvbApi.prototype.getSfvbPreviewUrl = function (requestParameters, initOverrides) {
|
|
@@ -46,7 +46,7 @@ export interface SfvbPreviewUrlResponse {
|
|
|
46
46
|
*/
|
|
47
47
|
requires_browser_session?: boolean;
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
49
|
+
* The session is keyed by individual login, so anyone else opening this URL sees the live page rather than the preview. This is false in every response, which means it is absent from the JSON - false booleans are omitted across this API, so a generated client sees undefined rather than false. Do not test it for equality with false. usage_note carries the same warning as a string and does survive.
|
|
50
50
|
* @type {boolean}
|
|
51
51
|
* @memberof SfvbPreviewUrlResponse
|
|
52
52
|
*/
|
package/package.json
CHANGED
package/src/apis/SfvbApi.ts
CHANGED
|
@@ -561,7 +561,7 @@ export interface SfvbApiInterface {
|
|
|
561
561
|
getSfvbLibraryEntry(requestParameters: GetSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
|
|
562
562
|
|
|
563
563
|
/**
|
|
564
|
-
*
|
|
564
|
+
* Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
|
|
565
565
|
* @summary URL that renders a preview session
|
|
566
566
|
* @param {number} storefrontOid
|
|
567
567
|
* @param {string} previewSessionId
|
|
@@ -573,6 +573,7 @@ export interface SfvbApiInterface {
|
|
|
573
573
|
getSfvbPreviewUrlRaw(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewUrlResponse>>;
|
|
574
574
|
|
|
575
575
|
/**
|
|
576
|
+
* Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
|
|
576
577
|
* URL that renders a preview session
|
|
577
578
|
*/
|
|
578
579
|
getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
|
|
@@ -1610,6 +1611,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
1610
1611
|
}
|
|
1611
1612
|
|
|
1612
1613
|
/**
|
|
1614
|
+
* Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
|
|
1613
1615
|
* URL that renders a preview session
|
|
1614
1616
|
*/
|
|
1615
1617
|
async getSfvbPreviewUrlRaw(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewUrlResponse>> {
|
|
@@ -1649,6 +1651,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
1649
1651
|
}
|
|
1650
1652
|
|
|
1651
1653
|
/**
|
|
1654
|
+
* Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
|
|
1652
1655
|
* URL that renders a preview session
|
|
1653
1656
|
*/
|
|
1654
1657
|
async getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse> {
|
|
@@ -50,7 +50,7 @@ export interface SfvbPreviewUrlResponse {
|
|
|
50
50
|
*/
|
|
51
51
|
requires_browser_session?: boolean;
|
|
52
52
|
/**
|
|
53
|
-
*
|
|
53
|
+
* The session is keyed by individual login, so anyone else opening this URL sees the live page rather than the preview. This is false in every response, which means it is absent from the JSON - false booleans are omitted across this API, so a generated client sees undefined rather than false. Do not test it for equality with false. usage_note carries the same warning as a string and does survive.
|
|
54
54
|
* @type {boolean}
|
|
55
55
|
* @memberof SfvbPreviewUrlResponse
|
|
56
56
|
*/
|