@widgetic/api-sdk 1.0.28 → 1.0.30

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.
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { AddPartnerCreditsRequest, ConfigureAutoReloadRequest, GetPartnerCreditBalance200Response, ListPartnerPresets200Response, PartnerAnalyticsByManagedUser, PartnerAnalyticsSummary, PartnerAnalyticsTimeline, PartnerAnalyticsTopWidgets, PartnerContract, PartnerNotificationDeliveryLog, PartnerNotificationPage, PartnerNotificationSettings, PartnerNotificationSettingsChange, PartnerPreset, PartnerPresetRemoval, PartnerStorageDestination, PartnerStorageRemoval, PartnerStorageUsage, SetPartnerPresetRequest, SetPartnerStorageDestinationRequest, UpdatePartnerNotificationSettingsRequest } from '../models/index';
13
+ import type { AddPartnerCreditsRequest, ConfigureAutoReloadRequest, GetPartnerCreditBalance200Response, ListPartnerPresets200Response, MyPartners, PartnerAnalyticsByManagedUser, PartnerAnalyticsSummary, PartnerAnalyticsTimeline, PartnerAnalyticsTopWidgets, PartnerContract, PartnerNotificationDeliveryLog, PartnerNotificationPage, PartnerNotificationSettings, PartnerNotificationSettingsChange, PartnerPreset, PartnerPresetRemoval, PartnerStorageDestination, PartnerStorageRemoval, PartnerStorageUsage, SetPartnerPresetRequest, SetPartnerStorageDestinationRequest, UpdatePartnerNotificationSettingsRequest } from '../models/index';
14
14
  export interface AddPartnerCreditsOperationRequest {
15
15
  partnerId: string;
16
16
  addPartnerCreditsRequest: AddPartnerCreditsRequest;
@@ -153,6 +153,16 @@ export declare class PartnersApi extends runtime.BaseAPI {
153
153
  * Configure auto-reload settings
154
154
  */
155
155
  configureAutoReload(requestParameters: ConfigureAutoReloadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
156
+ /**
157
+ * Returns the partner (nearly always one) that the signed-in account administers, with the id every other partner route asks for and the standing it is in: `active`, `inactive` (not activated yet) or `suspended` (paused, with the reason Widgetic gave). A partner API key is that account\'s key, so it reads its own partner here. An account that administers no partner is not refused: it gets `standing: not_a_partner` and an empty list, so a dashboard can tell \"this is not a partner account\" from \"something failed\". The call stays open while the partner is paused or not yet active: that is when its dashboard has to say why.
158
+ * Find the partner you administer
159
+ */
160
+ getMyPartnersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MyPartners>>;
161
+ /**
162
+ * Returns the partner (nearly always one) that the signed-in account administers, with the id every other partner route asks for and the standing it is in: `active`, `inactive` (not activated yet) or `suspended` (paused, with the reason Widgetic gave). A partner API key is that account\'s key, so it reads its own partner here. An account that administers no partner is not refused: it gets `standing: not_a_partner` and an empty list, so a dashboard can tell \"this is not a partner account\" from \"something failed\". The call stays open while the partner is paused or not yet active: that is when its dashboard has to say why.
163
+ * Find the partner you administer
164
+ */
165
+ getMyPartners(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MyPartners>;
156
166
  /**
157
167
  * Lists every one of your managed users with what their widgets and compositions did in a period: views, interactions and visitors, and how many widgets and compositions they have made. A managed user whose widgets were not viewed is listed too, with zeros. The most viewed come first, and `page.hasMore` says whether more follow. Only the compositions made for a managed user count for it: file them under the user when you create them (`managedUserId` on `createComposition`), or let the user\'s editor session do it, which files everything under its user. What a visitor did with a composition that is not filed under anyone is in the summary of the whole account (`getPartnerAnalyticsSummary`) and in no managed user\'s row. The period works as it does for `getPartnerAnalyticsSummary`. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
158
168
  * What each managed user\'s widgets did
@@ -153,6 +153,40 @@ class PartnersApi extends runtime.BaseAPI {
153
153
  yield this.configureAutoReloadRaw(requestParameters, initOverrides);
154
154
  });
155
155
  }
156
+ /**
157
+ * Returns the partner (nearly always one) that the signed-in account administers, with the id every other partner route asks for and the standing it is in: `active`, `inactive` (not activated yet) or `suspended` (paused, with the reason Widgetic gave). A partner API key is that account\'s key, so it reads its own partner here. An account that administers no partner is not refused: it gets `standing: not_a_partner` and an empty list, so a dashboard can tell \"this is not a partner account\" from \"something failed\". The call stays open while the partner is paused or not yet active: that is when its dashboard has to say why.
158
+ * Find the partner you administer
159
+ */
160
+ getMyPartnersRaw(initOverrides) {
161
+ return __awaiter(this, void 0, void 0, function* () {
162
+ const queryParameters = {};
163
+ const headerParameters = {};
164
+ if (this.configuration && this.configuration.accessToken) {
165
+ const token = this.configuration.accessToken;
166
+ const tokenString = yield token("apiKeyAuth", []);
167
+ if (tokenString) {
168
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
169
+ }
170
+ }
171
+ const response = yield this.request({
172
+ path: `/partners/mine`,
173
+ method: 'GET',
174
+ headers: headerParameters,
175
+ query: queryParameters,
176
+ }, initOverrides);
177
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.MyPartnersFromJSON)(jsonValue));
178
+ });
179
+ }
180
+ /**
181
+ * Returns the partner (nearly always one) that the signed-in account administers, with the id every other partner route asks for and the standing it is in: `active`, `inactive` (not activated yet) or `suspended` (paused, with the reason Widgetic gave). A partner API key is that account\'s key, so it reads its own partner here. An account that administers no partner is not refused: it gets `standing: not_a_partner` and an empty list, so a dashboard can tell \"this is not a partner account\" from \"something failed\". The call stays open while the partner is paused or not yet active: that is when its dashboard has to say why.
182
+ * Find the partner you administer
183
+ */
184
+ getMyPartners(initOverrides) {
185
+ return __awaiter(this, void 0, void 0, function* () {
186
+ const response = yield this.getMyPartnersRaw(initOverrides);
187
+ return yield response.value();
188
+ });
189
+ }
156
190
  /**
157
191
  * Lists every one of your managed users with what their widgets and compositions did in a period: views, interactions and visitors, and how many widgets and compositions they have made. A managed user whose widgets were not viewed is listed too, with zeros. The most viewed come first, and `page.hasMore` says whether more follow. Only the compositions made for a managed user count for it: file them under the user when you create them (`managedUserId` on `createComposition`), or let the user\'s editor session do it, which files everything under its user. What a visitor did with a composition that is not filed under anyone is in the summary of the whole account (`getPartnerAnalyticsSummary`) and in no managed user\'s row. The period works as it does for `getPartnerAnalyticsSummary`. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
158
192
  * What each managed user\'s widgets did
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { AddPartnerCreditsRequest, ConfigureAutoReloadRequest, GetPartnerCreditBalance200Response, ListPartnerPresets200Response, PartnerAnalyticsByManagedUser, PartnerAnalyticsSummary, PartnerAnalyticsTimeline, PartnerAnalyticsTopWidgets, PartnerContract, PartnerNotificationDeliveryLog, PartnerNotificationPage, PartnerNotificationSettings, PartnerNotificationSettingsChange, PartnerPreset, PartnerPresetRemoval, PartnerStorageDestination, PartnerStorageRemoval, PartnerStorageUsage, SetPartnerPresetRequest, SetPartnerStorageDestinationRequest, UpdatePartnerNotificationSettingsRequest } from '../models/index';
13
+ import type { AddPartnerCreditsRequest, ConfigureAutoReloadRequest, GetPartnerCreditBalance200Response, ListPartnerPresets200Response, MyPartners, PartnerAnalyticsByManagedUser, PartnerAnalyticsSummary, PartnerAnalyticsTimeline, PartnerAnalyticsTopWidgets, PartnerContract, PartnerNotificationDeliveryLog, PartnerNotificationPage, PartnerNotificationSettings, PartnerNotificationSettingsChange, PartnerPreset, PartnerPresetRemoval, PartnerStorageDestination, PartnerStorageRemoval, PartnerStorageUsage, SetPartnerPresetRequest, SetPartnerStorageDestinationRequest, UpdatePartnerNotificationSettingsRequest } from '../models/index';
14
14
  export interface AddPartnerCreditsOperationRequest {
15
15
  partnerId: string;
16
16
  addPartnerCreditsRequest: AddPartnerCreditsRequest;
@@ -153,6 +153,16 @@ export declare class PartnersApi extends runtime.BaseAPI {
153
153
  * Configure auto-reload settings
154
154
  */
155
155
  configureAutoReload(requestParameters: ConfigureAutoReloadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
156
+ /**
157
+ * Returns the partner (nearly always one) that the signed-in account administers, with the id every other partner route asks for and the standing it is in: `active`, `inactive` (not activated yet) or `suspended` (paused, with the reason Widgetic gave). A partner API key is that account\'s key, so it reads its own partner here. An account that administers no partner is not refused: it gets `standing: not_a_partner` and an empty list, so a dashboard can tell \"this is not a partner account\" from \"something failed\". The call stays open while the partner is paused or not yet active: that is when its dashboard has to say why.
158
+ * Find the partner you administer
159
+ */
160
+ getMyPartnersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MyPartners>>;
161
+ /**
162
+ * Returns the partner (nearly always one) that the signed-in account administers, with the id every other partner route asks for and the standing it is in: `active`, `inactive` (not activated yet) or `suspended` (paused, with the reason Widgetic gave). A partner API key is that account\'s key, so it reads its own partner here. An account that administers no partner is not refused: it gets `standing: not_a_partner` and an empty list, so a dashboard can tell \"this is not a partner account\" from \"something failed\". The call stays open while the partner is paused or not yet active: that is when its dashboard has to say why.
163
+ * Find the partner you administer
164
+ */
165
+ getMyPartners(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MyPartners>;
156
166
  /**
157
167
  * Lists every one of your managed users with what their widgets and compositions did in a period: views, interactions and visitors, and how many widgets and compositions they have made. A managed user whose widgets were not viewed is listed too, with zeros. The most viewed come first, and `page.hasMore` says whether more follow. Only the compositions made for a managed user count for it: file them under the user when you create them (`managedUserId` on `createComposition`), or let the user\'s editor session do it, which files everything under its user. What a visitor did with a composition that is not filed under anyone is in the summary of the whole account (`getPartnerAnalyticsSummary`) and in no managed user\'s row. The period works as it does for `getPartnerAnalyticsSummary`. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
158
168
  * What each managed user\'s widgets did
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime.js';
24
- import { AddPartnerCreditsRequestToJSON, ConfigureAutoReloadRequestToJSON, GetPartnerCreditBalance200ResponseFromJSON, ListPartnerPresets200ResponseFromJSON, PartnerAnalyticsByManagedUserFromJSON, PartnerAnalyticsSummaryFromJSON, PartnerAnalyticsTimelineFromJSON, PartnerAnalyticsTopWidgetsFromJSON, PartnerContractFromJSON, PartnerNotificationDeliveryLogFromJSON, PartnerNotificationPageFromJSON, PartnerNotificationSettingsFromJSON, PartnerNotificationSettingsChangeFromJSON, PartnerPresetFromJSON, PartnerPresetRemovalFromJSON, PartnerStorageDestinationFromJSON, PartnerStorageRemovalFromJSON, PartnerStorageUsageFromJSON, SetPartnerPresetRequestToJSON, SetPartnerStorageDestinationRequestToJSON, UpdatePartnerNotificationSettingsRequestToJSON, } from '../models/index.js';
24
+ import { AddPartnerCreditsRequestToJSON, ConfigureAutoReloadRequestToJSON, GetPartnerCreditBalance200ResponseFromJSON, ListPartnerPresets200ResponseFromJSON, MyPartnersFromJSON, PartnerAnalyticsByManagedUserFromJSON, PartnerAnalyticsSummaryFromJSON, PartnerAnalyticsTimelineFromJSON, PartnerAnalyticsTopWidgetsFromJSON, PartnerContractFromJSON, PartnerNotificationDeliveryLogFromJSON, PartnerNotificationPageFromJSON, PartnerNotificationSettingsFromJSON, PartnerNotificationSettingsChangeFromJSON, PartnerPresetFromJSON, PartnerPresetRemovalFromJSON, PartnerStorageDestinationFromJSON, PartnerStorageRemovalFromJSON, PartnerStorageUsageFromJSON, SetPartnerPresetRequestToJSON, SetPartnerStorageDestinationRequestToJSON, UpdatePartnerNotificationSettingsRequestToJSON, } from '../models/index.js';
25
25
  /**
26
26
  *
27
27
  */
@@ -150,6 +150,40 @@ export class PartnersApi extends runtime.BaseAPI {
150
150
  yield this.configureAutoReloadRaw(requestParameters, initOverrides);
151
151
  });
152
152
  }
153
+ /**
154
+ * Returns the partner (nearly always one) that the signed-in account administers, with the id every other partner route asks for and the standing it is in: `active`, `inactive` (not activated yet) or `suspended` (paused, with the reason Widgetic gave). A partner API key is that account\'s key, so it reads its own partner here. An account that administers no partner is not refused: it gets `standing: not_a_partner` and an empty list, so a dashboard can tell \"this is not a partner account\" from \"something failed\". The call stays open while the partner is paused or not yet active: that is when its dashboard has to say why.
155
+ * Find the partner you administer
156
+ */
157
+ getMyPartnersRaw(initOverrides) {
158
+ return __awaiter(this, void 0, void 0, function* () {
159
+ const queryParameters = {};
160
+ const headerParameters = {};
161
+ if (this.configuration && this.configuration.accessToken) {
162
+ const token = this.configuration.accessToken;
163
+ const tokenString = yield token("apiKeyAuth", []);
164
+ if (tokenString) {
165
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
166
+ }
167
+ }
168
+ const response = yield this.request({
169
+ path: `/partners/mine`,
170
+ method: 'GET',
171
+ headers: headerParameters,
172
+ query: queryParameters,
173
+ }, initOverrides);
174
+ return new runtime.JSONApiResponse(response, (jsonValue) => MyPartnersFromJSON(jsonValue));
175
+ });
176
+ }
177
+ /**
178
+ * Returns the partner (nearly always one) that the signed-in account administers, with the id every other partner route asks for and the standing it is in: `active`, `inactive` (not activated yet) or `suspended` (paused, with the reason Widgetic gave). A partner API key is that account\'s key, so it reads its own partner here. An account that administers no partner is not refused: it gets `standing: not_a_partner` and an empty list, so a dashboard can tell \"this is not a partner account\" from \"something failed\". The call stays open while the partner is paused or not yet active: that is when its dashboard has to say why.
179
+ * Find the partner you administer
180
+ */
181
+ getMyPartners(initOverrides) {
182
+ return __awaiter(this, void 0, void 0, function* () {
183
+ const response = yield this.getMyPartnersRaw(initOverrides);
184
+ return yield response.value();
185
+ });
186
+ }
153
187
  /**
154
188
  * Lists every one of your managed users with what their widgets and compositions did in a period: views, interactions and visitors, and how many widgets and compositions they have made. A managed user whose widgets were not viewed is listed too, with zeros. The most viewed come first, and `page.hasMore` says whether more follow. Only the compositions made for a managed user count for it: file them under the user when you create them (`managedUserId` on `createComposition`), or let the user\'s editor session do it, which files everything under its user. What a visitor did with a composition that is not filed under anyone is in the summary of the whole account (`getPartnerAnalyticsSummary`) and in no managed user\'s row. The period works as it does for `getPartnerAnalyticsSummary`. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
155
189
  * What each managed user\'s widgets did
@@ -0,0 +1,86 @@
1
+ /**
2
+ * Widgetic API Gateway
3
+ * API documentation for the Widgetic API Gateway
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * A partner as the person who administers it reads it: which partner it is, what standing it is in, and why it is paused when it is. The webhook address, its secret and the billing settings have their own routes and are not part of it.
14
+ *
15
+ * @export
16
+ * @interface MyPartner
17
+ */
18
+ export interface MyPartner {
19
+ /**
20
+ * The id every other partner route asks for (`/partners/{partnerId}/...`)
21
+ * @type {string}
22
+ * @memberof MyPartner
23
+ */
24
+ id: string;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof MyPartner
29
+ */
30
+ name: string;
31
+ /**
32
+ * `active` while the partner is in force. `inactive` until Widgetic activates it (and after a deactivation). `suspended` while it is paused, which is done by hand and comes back when Widgetic resumes it.
33
+ *
34
+ * @type {string}
35
+ * @memberof MyPartner
36
+ */
37
+ status: MyPartnerStatusEnum;
38
+ /**
39
+ *
40
+ * @type {string}
41
+ * @memberof MyPartner
42
+ */
43
+ contactEmail?: string | null;
44
+ /**
45
+ * The domains Widgetic added to the embeds of this partner's customers. The domains the person added themselves are on the domains route of the account.
46
+ *
47
+ * @type {Array<string>}
48
+ * @memberof MyPartner
49
+ */
50
+ allowedDomains: Array<string>;
51
+ /**
52
+ * When the partner was paused; null unless it is paused now
53
+ * @type {Date}
54
+ * @memberof MyPartner
55
+ */
56
+ suspendedAt: Date | null;
57
+ /**
58
+ * The reason given when the partner was paused, as the partner is told it; null unless it is paused now
59
+ * @type {string}
60
+ * @memberof MyPartner
61
+ */
62
+ suspensionReason: string | null;
63
+ /**
64
+ *
65
+ * @type {Date}
66
+ * @memberof MyPartner
67
+ */
68
+ createdAt?: Date | null;
69
+ }
70
+ /**
71
+ * @export
72
+ */
73
+ export declare const MyPartnerStatusEnum: {
74
+ readonly Active: "active";
75
+ readonly Inactive: "inactive";
76
+ readonly Suspended: "suspended";
77
+ };
78
+ export type MyPartnerStatusEnum = typeof MyPartnerStatusEnum[keyof typeof MyPartnerStatusEnum];
79
+ /**
80
+ * Check if a given object implements the MyPartner interface.
81
+ */
82
+ export declare function instanceOfMyPartner(value: object): value is MyPartner;
83
+ export declare function MyPartnerFromJSON(json: any): MyPartner;
84
+ export declare function MyPartnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): MyPartner;
85
+ export declare function MyPartnerToJSON(json: any): MyPartner;
86
+ export declare function MyPartnerToJSONTyped(value?: MyPartner | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,75 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Widgetic API Gateway
5
+ * API documentation for the Widgetic API Gateway
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * @export
16
+ */
17
+ export const MyPartnerStatusEnum = {
18
+ Active: 'active',
19
+ Inactive: 'inactive',
20
+ Suspended: 'suspended'
21
+ };
22
+ /**
23
+ * Check if a given object implements the MyPartner interface.
24
+ */
25
+ export function instanceOfMyPartner(value) {
26
+ if (!('id' in value) || value['id'] === undefined)
27
+ return false;
28
+ if (!('name' in value) || value['name'] === undefined)
29
+ return false;
30
+ if (!('status' in value) || value['status'] === undefined)
31
+ return false;
32
+ if (!('allowedDomains' in value) || value['allowedDomains'] === undefined)
33
+ return false;
34
+ if (!('suspendedAt' in value) || value['suspendedAt'] === undefined)
35
+ return false;
36
+ if (!('suspensionReason' in value) || value['suspensionReason'] === undefined)
37
+ return false;
38
+ return true;
39
+ }
40
+ export function MyPartnerFromJSON(json) {
41
+ return MyPartnerFromJSONTyped(json, false);
42
+ }
43
+ export function MyPartnerFromJSONTyped(json, ignoreDiscriminator) {
44
+ if (json == null) {
45
+ return json;
46
+ }
47
+ return {
48
+ 'id': json['id'],
49
+ 'name': json['name'],
50
+ 'status': json['status'],
51
+ 'contactEmail': json['contactEmail'] == null ? undefined : json['contactEmail'],
52
+ 'allowedDomains': json['allowedDomains'],
53
+ 'suspendedAt': (json['suspendedAt'] == null ? null : new Date(json['suspendedAt'])),
54
+ 'suspensionReason': json['suspensionReason'],
55
+ 'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
56
+ };
57
+ }
58
+ export function MyPartnerToJSON(json) {
59
+ return MyPartnerToJSONTyped(json, false);
60
+ }
61
+ export function MyPartnerToJSONTyped(value, ignoreDiscriminator = false) {
62
+ if (value == null) {
63
+ return value;
64
+ }
65
+ return {
66
+ 'id': value['id'],
67
+ 'name': value['name'],
68
+ 'status': value['status'],
69
+ 'contactEmail': value['contactEmail'],
70
+ 'allowedDomains': value['allowedDomains'],
71
+ 'suspendedAt': (value['suspendedAt'] == null ? null : value['suspendedAt'].toISOString()),
72
+ 'suspensionReason': value['suspensionReason'],
73
+ 'createdAt': value['createdAt'] == null ? undefined : (value['createdAt'].toISOString()),
74
+ };
75
+ }
@@ -0,0 +1,50 @@
1
+ /**
2
+ * Widgetic API Gateway
3
+ * API documentation for the Widgetic API Gateway
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { MyPartner } from './MyPartner';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface MyPartners
17
+ */
18
+ export interface MyPartners {
19
+ /**
20
+ * The standing of the account as a whole, the word every gate reads: `not_a_partner` when the account administers no partner; otherwise `active` when any of its partners is active, else `suspended` when any is paused, else `inactive`.
21
+ *
22
+ * @type {string}
23
+ * @memberof MyPartners
24
+ */
25
+ standing: MyPartnersStandingEnum;
26
+ /**
27
+ * The partners the account administers (nearly always one), the oldest first
28
+ * @type {Array<MyPartner>}
29
+ * @memberof MyPartners
30
+ */
31
+ partners: Array<MyPartner>;
32
+ }
33
+ /**
34
+ * @export
35
+ */
36
+ export declare const MyPartnersStandingEnum: {
37
+ readonly NotAPartner: "not_a_partner";
38
+ readonly Inactive: "inactive";
39
+ readonly Active: "active";
40
+ readonly Suspended: "suspended";
41
+ };
42
+ export type MyPartnersStandingEnum = typeof MyPartnersStandingEnum[keyof typeof MyPartnersStandingEnum];
43
+ /**
44
+ * Check if a given object implements the MyPartners interface.
45
+ */
46
+ export declare function instanceOfMyPartners(value: object): value is MyPartners;
47
+ export declare function MyPartnersFromJSON(json: any): MyPartners;
48
+ export declare function MyPartnersFromJSONTyped(json: any, ignoreDiscriminator: boolean): MyPartners;
49
+ export declare function MyPartnersToJSON(json: any): MyPartners;
50
+ export declare function MyPartnersToJSONTyped(value?: MyPartners | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,57 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Widgetic API Gateway
5
+ * API documentation for the Widgetic API Gateway
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { MyPartnerFromJSON, MyPartnerToJSON, } from './MyPartner.js';
15
+ /**
16
+ * @export
17
+ */
18
+ export const MyPartnersStandingEnum = {
19
+ NotAPartner: 'not_a_partner',
20
+ Inactive: 'inactive',
21
+ Active: 'active',
22
+ Suspended: 'suspended'
23
+ };
24
+ /**
25
+ * Check if a given object implements the MyPartners interface.
26
+ */
27
+ export function instanceOfMyPartners(value) {
28
+ if (!('standing' in value) || value['standing'] === undefined)
29
+ return false;
30
+ if (!('partners' in value) || value['partners'] === undefined)
31
+ return false;
32
+ return true;
33
+ }
34
+ export function MyPartnersFromJSON(json) {
35
+ return MyPartnersFromJSONTyped(json, false);
36
+ }
37
+ export function MyPartnersFromJSONTyped(json, ignoreDiscriminator) {
38
+ if (json == null) {
39
+ return json;
40
+ }
41
+ return {
42
+ 'standing': json['standing'],
43
+ 'partners': (json['partners'].map(MyPartnerFromJSON)),
44
+ };
45
+ }
46
+ export function MyPartnersToJSON(json) {
47
+ return MyPartnersToJSONTyped(json, false);
48
+ }
49
+ export function MyPartnersToJSONTyped(value, ignoreDiscriminator = false) {
50
+ if (value == null) {
51
+ return value;
52
+ }
53
+ return {
54
+ 'standing': value['standing'],
55
+ 'partners': (value['partners'].map(MyPartnerToJSON)),
56
+ };
57
+ }
@@ -386,6 +386,8 @@ export * from './MetricsLatencyGet200ResponseDataValue';
386
386
  export * from './ModifyCodeRequest';
387
387
  export * from './MonthlySummary';
388
388
  export * from './MoveSubscriptionSurfaceRequest';
389
+ export * from './MyPartner';
390
+ export * from './MyPartners';
389
391
  export * from './MyPreset';
390
392
  export * from './MyPresetCopy';
391
393
  export * from './NewAnalyticsEvent';
@@ -388,6 +388,8 @@ export * from './MetricsLatencyGet200ResponseDataValue.js';
388
388
  export * from './ModifyCodeRequest.js';
389
389
  export * from './MonthlySummary.js';
390
390
  export * from './MoveSubscriptionSurfaceRequest.js';
391
+ export * from './MyPartner.js';
392
+ export * from './MyPartners.js';
391
393
  export * from './MyPreset.js';
392
394
  export * from './MyPresetCopy.js';
393
395
  export * from './NewAnalyticsEvent.js';
@@ -0,0 +1,86 @@
1
+ /**
2
+ * Widgetic API Gateway
3
+ * API documentation for the Widgetic API Gateway
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * A partner as the person who administers it reads it: which partner it is, what standing it is in, and why it is paused when it is. The webhook address, its secret and the billing settings have their own routes and are not part of it.
14
+ *
15
+ * @export
16
+ * @interface MyPartner
17
+ */
18
+ export interface MyPartner {
19
+ /**
20
+ * The id every other partner route asks for (`/partners/{partnerId}/...`)
21
+ * @type {string}
22
+ * @memberof MyPartner
23
+ */
24
+ id: string;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof MyPartner
29
+ */
30
+ name: string;
31
+ /**
32
+ * `active` while the partner is in force. `inactive` until Widgetic activates it (and after a deactivation). `suspended` while it is paused, which is done by hand and comes back when Widgetic resumes it.
33
+ *
34
+ * @type {string}
35
+ * @memberof MyPartner
36
+ */
37
+ status: MyPartnerStatusEnum;
38
+ /**
39
+ *
40
+ * @type {string}
41
+ * @memberof MyPartner
42
+ */
43
+ contactEmail?: string | null;
44
+ /**
45
+ * The domains Widgetic added to the embeds of this partner's customers. The domains the person added themselves are on the domains route of the account.
46
+ *
47
+ * @type {Array<string>}
48
+ * @memberof MyPartner
49
+ */
50
+ allowedDomains: Array<string>;
51
+ /**
52
+ * When the partner was paused; null unless it is paused now
53
+ * @type {Date}
54
+ * @memberof MyPartner
55
+ */
56
+ suspendedAt: Date | null;
57
+ /**
58
+ * The reason given when the partner was paused, as the partner is told it; null unless it is paused now
59
+ * @type {string}
60
+ * @memberof MyPartner
61
+ */
62
+ suspensionReason: string | null;
63
+ /**
64
+ *
65
+ * @type {Date}
66
+ * @memberof MyPartner
67
+ */
68
+ createdAt?: Date | null;
69
+ }
70
+ /**
71
+ * @export
72
+ */
73
+ export declare const MyPartnerStatusEnum: {
74
+ readonly Active: "active";
75
+ readonly Inactive: "inactive";
76
+ readonly Suspended: "suspended";
77
+ };
78
+ export type MyPartnerStatusEnum = typeof MyPartnerStatusEnum[keyof typeof MyPartnerStatusEnum];
79
+ /**
80
+ * Check if a given object implements the MyPartner interface.
81
+ */
82
+ export declare function instanceOfMyPartner(value: object): value is MyPartner;
83
+ export declare function MyPartnerFromJSON(json: any): MyPartner;
84
+ export declare function MyPartnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): MyPartner;
85
+ export declare function MyPartnerToJSON(json: any): MyPartner;
86
+ export declare function MyPartnerToJSONTyped(value?: MyPartner | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,83 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Widgetic API Gateway
6
+ * API documentation for the Widgetic API Gateway
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.MyPartnerStatusEnum = void 0;
17
+ exports.instanceOfMyPartner = instanceOfMyPartner;
18
+ exports.MyPartnerFromJSON = MyPartnerFromJSON;
19
+ exports.MyPartnerFromJSONTyped = MyPartnerFromJSONTyped;
20
+ exports.MyPartnerToJSON = MyPartnerToJSON;
21
+ exports.MyPartnerToJSONTyped = MyPartnerToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.MyPartnerStatusEnum = {
26
+ Active: 'active',
27
+ Inactive: 'inactive',
28
+ Suspended: 'suspended'
29
+ };
30
+ /**
31
+ * Check if a given object implements the MyPartner interface.
32
+ */
33
+ function instanceOfMyPartner(value) {
34
+ if (!('id' in value) || value['id'] === undefined)
35
+ return false;
36
+ if (!('name' in value) || value['name'] === undefined)
37
+ return false;
38
+ if (!('status' in value) || value['status'] === undefined)
39
+ return false;
40
+ if (!('allowedDomains' in value) || value['allowedDomains'] === undefined)
41
+ return false;
42
+ if (!('suspendedAt' in value) || value['suspendedAt'] === undefined)
43
+ return false;
44
+ if (!('suspensionReason' in value) || value['suspensionReason'] === undefined)
45
+ return false;
46
+ return true;
47
+ }
48
+ function MyPartnerFromJSON(json) {
49
+ return MyPartnerFromJSONTyped(json, false);
50
+ }
51
+ function MyPartnerFromJSONTyped(json, ignoreDiscriminator) {
52
+ if (json == null) {
53
+ return json;
54
+ }
55
+ return {
56
+ 'id': json['id'],
57
+ 'name': json['name'],
58
+ 'status': json['status'],
59
+ 'contactEmail': json['contactEmail'] == null ? undefined : json['contactEmail'],
60
+ 'allowedDomains': json['allowedDomains'],
61
+ 'suspendedAt': (json['suspendedAt'] == null ? null : new Date(json['suspendedAt'])),
62
+ 'suspensionReason': json['suspensionReason'],
63
+ 'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
64
+ };
65
+ }
66
+ function MyPartnerToJSON(json) {
67
+ return MyPartnerToJSONTyped(json, false);
68
+ }
69
+ function MyPartnerToJSONTyped(value, ignoreDiscriminator = false) {
70
+ if (value == null) {
71
+ return value;
72
+ }
73
+ return {
74
+ 'id': value['id'],
75
+ 'name': value['name'],
76
+ 'status': value['status'],
77
+ 'contactEmail': value['contactEmail'],
78
+ 'allowedDomains': value['allowedDomains'],
79
+ 'suspendedAt': (value['suspendedAt'] == null ? null : value['suspendedAt'].toISOString()),
80
+ 'suspensionReason': value['suspensionReason'],
81
+ 'createdAt': value['createdAt'] == null ? undefined : (value['createdAt'].toISOString()),
82
+ };
83
+ }
@@ -0,0 +1,50 @@
1
+ /**
2
+ * Widgetic API Gateway
3
+ * API documentation for the Widgetic API Gateway
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { MyPartner } from './MyPartner';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface MyPartners
17
+ */
18
+ export interface MyPartners {
19
+ /**
20
+ * The standing of the account as a whole, the word every gate reads: `not_a_partner` when the account administers no partner; otherwise `active` when any of its partners is active, else `suspended` when any is paused, else `inactive`.
21
+ *
22
+ * @type {string}
23
+ * @memberof MyPartners
24
+ */
25
+ standing: MyPartnersStandingEnum;
26
+ /**
27
+ * The partners the account administers (nearly always one), the oldest first
28
+ * @type {Array<MyPartner>}
29
+ * @memberof MyPartners
30
+ */
31
+ partners: Array<MyPartner>;
32
+ }
33
+ /**
34
+ * @export
35
+ */
36
+ export declare const MyPartnersStandingEnum: {
37
+ readonly NotAPartner: "not_a_partner";
38
+ readonly Inactive: "inactive";
39
+ readonly Active: "active";
40
+ readonly Suspended: "suspended";
41
+ };
42
+ export type MyPartnersStandingEnum = typeof MyPartnersStandingEnum[keyof typeof MyPartnersStandingEnum];
43
+ /**
44
+ * Check if a given object implements the MyPartners interface.
45
+ */
46
+ export declare function instanceOfMyPartners(value: object): value is MyPartners;
47
+ export declare function MyPartnersFromJSON(json: any): MyPartners;
48
+ export declare function MyPartnersFromJSONTyped(json: any, ignoreDiscriminator: boolean): MyPartners;
49
+ export declare function MyPartnersToJSON(json: any): MyPartners;
50
+ export declare function MyPartnersToJSONTyped(value?: MyPartners | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,65 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Widgetic API Gateway
6
+ * API documentation for the Widgetic API Gateway
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.MyPartnersStandingEnum = void 0;
17
+ exports.instanceOfMyPartners = instanceOfMyPartners;
18
+ exports.MyPartnersFromJSON = MyPartnersFromJSON;
19
+ exports.MyPartnersFromJSONTyped = MyPartnersFromJSONTyped;
20
+ exports.MyPartnersToJSON = MyPartnersToJSON;
21
+ exports.MyPartnersToJSONTyped = MyPartnersToJSONTyped;
22
+ const MyPartner_1 = require("./MyPartner");
23
+ /**
24
+ * @export
25
+ */
26
+ exports.MyPartnersStandingEnum = {
27
+ NotAPartner: 'not_a_partner',
28
+ Inactive: 'inactive',
29
+ Active: 'active',
30
+ Suspended: 'suspended'
31
+ };
32
+ /**
33
+ * Check if a given object implements the MyPartners interface.
34
+ */
35
+ function instanceOfMyPartners(value) {
36
+ if (!('standing' in value) || value['standing'] === undefined)
37
+ return false;
38
+ if (!('partners' in value) || value['partners'] === undefined)
39
+ return false;
40
+ return true;
41
+ }
42
+ function MyPartnersFromJSON(json) {
43
+ return MyPartnersFromJSONTyped(json, false);
44
+ }
45
+ function MyPartnersFromJSONTyped(json, ignoreDiscriminator) {
46
+ if (json == null) {
47
+ return json;
48
+ }
49
+ return {
50
+ 'standing': json['standing'],
51
+ 'partners': (json['partners'].map(MyPartner_1.MyPartnerFromJSON)),
52
+ };
53
+ }
54
+ function MyPartnersToJSON(json) {
55
+ return MyPartnersToJSONTyped(json, false);
56
+ }
57
+ function MyPartnersToJSONTyped(value, ignoreDiscriminator = false) {
58
+ if (value == null) {
59
+ return value;
60
+ }
61
+ return {
62
+ 'standing': value['standing'],
63
+ 'partners': (value['partners'].map(MyPartner_1.MyPartnerToJSON)),
64
+ };
65
+ }
@@ -386,6 +386,8 @@ export * from './MetricsLatencyGet200ResponseDataValue';
386
386
  export * from './ModifyCodeRequest';
387
387
  export * from './MonthlySummary';
388
388
  export * from './MoveSubscriptionSurfaceRequest';
389
+ export * from './MyPartner';
390
+ export * from './MyPartners';
389
391
  export * from './MyPreset';
390
392
  export * from './MyPresetCopy';
391
393
  export * from './NewAnalyticsEvent';
@@ -404,6 +404,8 @@ __exportStar(require("./MetricsLatencyGet200ResponseDataValue"), exports);
404
404
  __exportStar(require("./ModifyCodeRequest"), exports);
405
405
  __exportStar(require("./MonthlySummary"), exports);
406
406
  __exportStar(require("./MoveSubscriptionSurfaceRequest"), exports);
407
+ __exportStar(require("./MyPartner"), exports);
408
+ __exportStar(require("./MyPartners"), exports);
407
409
  __exportStar(require("./MyPreset"), exports);
408
410
  __exportStar(require("./MyPresetCopy"), exports);
409
411
  __exportStar(require("./NewAnalyticsEvent"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@widgetic/api-sdk",
3
- "version": "1.0.28",
3
+ "version": "1.0.30",
4
4
  "description": "Official JavaScript/TypeScript client for the Widgetic API (ESM & CJS)",
5
5
  "author": "Widgetic",
6
6
  "repository": {