@seamapi/http 2.23.7 → 2.24.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/README.md +5 -0
- package/lib/request-parameters.d.ts +1 -1
- package/lib/request-parameters.js +3 -3
- package/lib/request-parameters.js.map +1 -1
- package/lib/resolve-action-attempt.d.ts +2 -0
- package/lib/resolve-action-attempt.js +25 -27
- package/lib/resolve-action-attempt.js.map +1 -1
- package/lib/routes/access-codes/access-codes.d.ts +5 -5
- package/lib/routes/access-codes/access-codes.js +20 -1
- package/lib/routes/access-codes/access-codes.js.map +1 -1
- package/lib/routes/access-codes/simulate/simulate.d.ts +2 -2
- package/lib/routes/access-codes/simulate/simulate.js +2 -1
- package/lib/routes/access-codes/simulate/simulate.js.map +1 -1
- package/lib/routes/access-codes/unmanaged/unmanaged.d.ts +4 -4
- package/lib/routes/access-codes/unmanaged/unmanaged.js +6 -1
- package/lib/routes/access-codes/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/access-grants/access-grants.d.ts +6 -6
- package/lib/routes/access-grants/access-grants.js +19 -1
- package/lib/routes/access-grants/access-grants.js.map +1 -1
- package/lib/routes/access-grants/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/access-grants/unmanaged/unmanaged.js +4 -1
- package/lib/routes/access-grants/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/access-methods/access-methods.d.ts +5 -5
- package/lib/routes/access-methods/access-methods.js +19 -1
- package/lib/routes/access-methods/access-methods.js.map +1 -1
- package/lib/routes/access-methods/unmanaged/unmanaged.d.ts +2 -2
- package/lib/routes/access-methods/unmanaged/unmanaged.js +3 -1
- package/lib/routes/access-methods/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/acs/access-groups/access-groups.d.ts +2 -2
- package/lib/routes/acs/access-groups/access-groups.js +8 -1
- package/lib/routes/acs/access-groups/access-groups.js.map +1 -1
- package/lib/routes/acs/acs.d.ts +2 -2
- package/lib/routes/acs/acs.js.map +1 -1
- package/lib/routes/acs/credentials/credentials.d.ts +3 -3
- package/lib/routes/acs/credentials/credentials.js +9 -1
- package/lib/routes/acs/credentials/credentials.js.map +1 -1
- package/lib/routes/acs/encoders/encoders.d.ts +3 -3
- package/lib/routes/acs/encoders/encoders.js +6 -1
- package/lib/routes/acs/encoders/encoders.js.map +1 -1
- package/lib/routes/acs/encoders/simulate/simulate.d.ts +2 -2
- package/lib/routes/acs/encoders/simulate/simulate.js +5 -1
- package/lib/routes/acs/encoders/simulate/simulate.js.map +1 -1
- package/lib/routes/acs/entrances/entrances.d.ts +3 -3
- package/lib/routes/acs/entrances/entrances.js +6 -1
- package/lib/routes/acs/entrances/entrances.js.map +1 -1
- package/lib/routes/acs/systems/systems.d.ts +2 -2
- package/lib/routes/acs/systems/systems.js +5 -1
- package/lib/routes/acs/systems/systems.js.map +1 -1
- package/lib/routes/acs/users/users.d.ts +10 -10
- package/lib/routes/acs/users/users.js +46 -1
- package/lib/routes/acs/users/users.js.map +1 -1
- package/lib/routes/action-attempts/action-attempts.d.ts +3 -3
- package/lib/routes/action-attempts/action-attempts.js +3 -1
- package/lib/routes/action-attempts/action-attempts.js.map +1 -1
- package/lib/routes/client-sessions/client-sessions.d.ts +3 -3
- package/lib/routes/client-sessions/client-sessions.js +15 -1
- package/lib/routes/client-sessions/client-sessions.js.map +1 -1
- package/lib/routes/connect-webviews/connect-webviews.d.ts +3 -3
- package/lib/routes/connect-webviews/connect-webviews.js +5 -1
- package/lib/routes/connect-webviews/connect-webviews.js.map +1 -1
- package/lib/routes/connected-accounts/connected-accounts.d.ts +4 -4
- package/lib/routes/connected-accounts/connected-accounts.js +6 -1
- package/lib/routes/connected-accounts/connected-accounts.js.map +1 -1
- package/lib/routes/connected-accounts/simulate/simulate.d.ts +2 -2
- package/lib/routes/connected-accounts/simulate/simulate.js +2 -1
- package/lib/routes/connected-accounts/simulate/simulate.js.map +1 -1
- package/lib/routes/customers/customers.d.ts +2 -2
- package/lib/routes/customers/customers.js +4 -1
- package/lib/routes/customers/customers.js.map +1 -1
- package/lib/routes/devices/devices.d.ts +4 -4
- package/lib/routes/devices/devices.js +6 -1
- package/lib/routes/devices/devices.js.map +1 -1
- package/lib/routes/devices/simulate/simulate.d.ts +2 -2
- package/lib/routes/devices/simulate/simulate.js +7 -1
- package/lib/routes/devices/simulate/simulate.js.map +1 -1
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +4 -4
- package/lib/routes/devices/unmanaged/unmanaged.js +4 -1
- package/lib/routes/devices/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/events/events.d.ts +4 -4
- package/lib/routes/events/events.js +31 -1
- package/lib/routes/events/events.js.map +1 -1
- package/lib/routes/instant-keys/instant-keys.d.ts +3 -3
- package/lib/routes/instant-keys/instant-keys.js +4 -1
- package/lib/routes/instant-keys/instant-keys.js.map +1 -1
- package/lib/routes/locks/locks.d.ts +3 -3
- package/lib/routes/locks/locks.js +6 -1
- package/lib/routes/locks/locks.js.map +1 -1
- package/lib/routes/locks/simulate/simulate.d.ts +2 -2
- package/lib/routes/locks/simulate/simulate.js +3 -1
- package/lib/routes/locks/simulate/simulate.js.map +1 -1
- package/lib/routes/noise-sensors/noise-sensors.d.ts +2 -2
- package/lib/routes/noise-sensors/noise-sensors.js +2 -1
- package/lib/routes/noise-sensors/noise-sensors.js.map +1 -1
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.d.ts +2 -2
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js +6 -1
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js.map +1 -1
- package/lib/routes/noise-sensors/simulate/simulate.d.ts +2 -2
- package/lib/routes/noise-sensors/simulate/simulate.js +2 -1
- package/lib/routes/noise-sensors/simulate/simulate.js.map +1 -1
- package/lib/routes/phones/phones.d.ts +2 -2
- package/lib/routes/phones/phones.js +4 -1
- package/lib/routes/phones/phones.js.map +1 -1
- package/lib/routes/phones/simulate/simulate.d.ts +2 -2
- package/lib/routes/phones/simulate/simulate.js +2 -1
- package/lib/routes/phones/simulate/simulate.js.map +1 -1
- package/lib/routes/seam-http-endpoints.d.ts +2 -2
- package/lib/routes/seam-http-endpoints.js.map +1 -1
- package/lib/routes/seam-http.d.ts +2 -2
- package/lib/routes/seam-http.js.map +1 -1
- package/lib/routes/spaces/spaces.d.ts +5 -5
- package/lib/routes/spaces/spaces.js +18 -1
- package/lib/routes/spaces/spaces.js.map +1 -1
- package/lib/routes/thermostats/daily-programs/daily-programs.d.ts +2 -2
- package/lib/routes/thermostats/daily-programs/daily-programs.js +4 -1
- package/lib/routes/thermostats/daily-programs/daily-programs.js.map +1 -1
- package/lib/routes/thermostats/schedules/schedules.d.ts +2 -2
- package/lib/routes/thermostats/schedules/schedules.js +6 -1
- package/lib/routes/thermostats/schedules/schedules.js.map +1 -1
- package/lib/routes/thermostats/simulate/simulate.d.ts +2 -2
- package/lib/routes/thermostats/simulate/simulate.js +3 -1
- package/lib/routes/thermostats/simulate/simulate.js.map +1 -1
- package/lib/routes/thermostats/thermostats.d.ts +2 -2
- package/lib/routes/thermostats/thermostats.js +15 -1
- package/lib/routes/thermostats/thermostats.js.map +1 -1
- package/lib/routes/user-identities/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/user-identities/unmanaged/unmanaged.js +4 -1
- package/lib/routes/user-identities/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/user-identities/user-identities.d.ts +5 -5
- package/lib/routes/user-identities/user-identities.js +21 -1
- package/lib/routes/user-identities/user-identities.js.map +1 -1
- package/lib/routes/webhooks/webhooks.d.ts +2 -2
- package/lib/routes/webhooks/webhooks.js +6 -1
- package/lib/routes/webhooks/webhooks.js.map +1 -1
- package/lib/routes/workspaces/workspaces.d.ts +2 -2
- package/lib/routes/workspaces/workspaces.js +6 -1
- package/lib/routes/workspaces/workspaces.js.map +1 -1
- package/lib/seam-http-request.d.ts +7 -2
- package/lib/seam-http-request.js +11 -5
- package/lib/seam-http-request.js.map +1 -1
- package/lib/seam-paginator.d.ts +2 -2
- package/lib/seam-paginator.js +12 -8
- package/lib/seam-paginator.js.map +1 -1
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +1 -1
- package/src/lib/request-parameters.ts +5 -2
- package/src/lib/resolve-action-attempt.ts +34 -37
- package/src/lib/routes/access-codes/access-codes.ts +94 -59
- package/src/lib/routes/access-codes/simulate/simulate.ts +6 -2
- package/src/lib/routes/access-codes/unmanaged/unmanaged.ts +28 -17
- package/src/lib/routes/access-grants/access-grants.ts +101 -71
- package/src/lib/routes/access-grants/unmanaged/unmanaged.ts +9 -3
- package/src/lib/routes/access-methods/access-methods.ts +83 -51
- package/src/lib/routes/access-methods/unmanaged/unmanaged.ts +7 -2
- package/src/lib/routes/acs/access-groups/access-groups.ts +12 -2
- package/src/lib/routes/acs/acs.ts +2 -2
- package/src/lib/routes/acs/credentials/credentials.ts +14 -3
- package/src/lib/routes/acs/encoders/encoders.ts +11 -3
- package/src/lib/routes/acs/encoders/simulate/simulate.ts +9 -2
- package/src/lib/routes/acs/entrances/entrances.ts +11 -3
- package/src/lib/routes/acs/systems/systems.ts +9 -2
- package/src/lib/routes/acs/users/users.ts +214 -137
- package/src/lib/routes/action-attempts/action-attempts.ts +8 -3
- package/src/lib/routes/client-sessions/client-sessions.ts +54 -29
- package/src/lib/routes/connect-webviews/connect-webviews.ts +10 -3
- package/src/lib/routes/connected-accounts/connected-accounts.ts +24 -13
- package/src/lib/routes/connected-accounts/simulate/simulate.ts +6 -2
- package/src/lib/routes/customers/customers.ts +8 -2
- package/src/lib/routes/devices/devices.ts +27 -13
- package/src/lib/routes/devices/simulate/simulate.ts +11 -2
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +22 -13
- package/src/lib/routes/events/events.ts +427 -362
- package/src/lib/routes/instant-keys/instant-keys.ts +21 -12
- package/src/lib/routes/locks/locks.ts +23 -12
- package/src/lib/routes/locks/simulate/simulate.ts +7 -2
- package/src/lib/routes/noise-sensors/noise-sensors.ts +6 -2
- package/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +10 -2
- package/src/lib/routes/noise-sensors/simulate/simulate.ts +6 -2
- package/src/lib/routes/phones/phones.ts +8 -2
- package/src/lib/routes/phones/simulate/simulate.ts +6 -2
- package/src/lib/routes/seam-http-endpoints.ts +2 -2
- package/src/lib/routes/seam-http.ts +2 -2
- package/src/lib/routes/spaces/spaces.ts +73 -44
- package/src/lib/routes/thermostats/daily-programs/daily-programs.ts +8 -2
- package/src/lib/routes/thermostats/schedules/schedules.ts +10 -2
- package/src/lib/routes/thermostats/simulate/simulate.ts +7 -2
- package/src/lib/routes/thermostats/thermostats.ts +19 -2
- package/src/lib/routes/user-identities/unmanaged/unmanaged.ts +9 -3
- package/src/lib/routes/user-identities/user-identities.ts +60 -28
- package/src/lib/routes/webhooks/webhooks.ts +10 -2
- package/src/lib/routes/workspaces/workspaces.ts +10 -2
- package/src/lib/seam-http-request.ts +24 -6
- package/src/lib/seam-paginator.ts +22 -12
- package/src/lib/version.ts +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { type Client } from '../../client.js';
|
|
2
2
|
import { type SeamHttpFromPublishableKeyOptions, type SeamHttpOptions, type SeamHttpOptionsWithApiKey, type SeamHttpOptionsWithClient, type SeamHttpOptionsWithClientSessionToken, type SeamHttpOptionsWithConsoleSessionToken, type SeamHttpOptionsWithPersonalAccessToken, type SeamHttpRequestOptions } from '../../options.js';
|
|
3
3
|
import type { Webhook } from '../../resources/webhook.js';
|
|
4
|
-
import { SeamHttpRequest } from '../../seam-http-request.js';
|
|
4
|
+
import { SeamHttpRequest, type SeamPaginatedRequest } from '../../seam-http-request.js';
|
|
5
5
|
import { SeamPaginator } from '../../seam-paginator.js';
|
|
6
6
|
export declare class SeamHttpWebhooks {
|
|
7
7
|
client: Client;
|
|
@@ -13,7 +13,7 @@ export declare class SeamHttpWebhooks {
|
|
|
13
13
|
static fromPublishableKey(publishableKey: string, userIdentifierKey: string, options?: SeamHttpFromPublishableKeyOptions): Promise<SeamHttpWebhooks>;
|
|
14
14
|
static fromConsoleSessionToken(consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'], workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'], options?: Omit<SeamHttpOptionsWithConsoleSessionToken, 'consoleSessionToken' | 'workspaceId'>): SeamHttpWebhooks;
|
|
15
15
|
static fromPersonalAccessToken(personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'], workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'], options?: Omit<SeamHttpOptionsWithPersonalAccessToken, 'personalAccessToken' | 'workspaceId'>): SeamHttpWebhooks;
|
|
16
|
-
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request:
|
|
16
|
+
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
17
17
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
18
18
|
/**
|
|
19
19
|
* Creates a new [webhook](https://docs.seam.co/developer-tools/webhooks).
|
|
@@ -7,7 +7,7 @@ import { createClient } from '../../client.js';
|
|
|
7
7
|
import { isSeamHttpOptionsWithApiKey, isSeamHttpOptionsWithClient, isSeamHttpOptionsWithClientSessionToken, isSeamHttpOptionsWithConsoleSessionToken, isSeamHttpOptionsWithPersonalAccessToken, SeamHttpInvalidOptionsError, } from '../../options.js';
|
|
8
8
|
import { limitToSeamHttpRequestOptions, parseOptions, } from '../../parse-options.js';
|
|
9
9
|
import { SeamHttpClientSessions } from '../../routes/client-sessions/index.js';
|
|
10
|
-
import { SeamHttpRequest } from '../../seam-http-request.js';
|
|
10
|
+
import { SeamHttpRequest, } from '../../seam-http-request.js';
|
|
11
11
|
import { SeamPaginator } from '../../seam-paginator.js';
|
|
12
12
|
export class SeamHttpWebhooks {
|
|
13
13
|
client;
|
|
@@ -93,6 +93,7 @@ export class SeamHttpWebhooks {
|
|
|
93
93
|
parameters,
|
|
94
94
|
hasRequiredParameters: true,
|
|
95
95
|
requiredParameterNames: ['url'],
|
|
96
|
+
atLeastOneParameterNames: [],
|
|
96
97
|
responseKey: 'webhook',
|
|
97
98
|
options,
|
|
98
99
|
});
|
|
@@ -108,6 +109,7 @@ export class SeamHttpWebhooks {
|
|
|
108
109
|
parameters,
|
|
109
110
|
hasRequiredParameters: true,
|
|
110
111
|
requiredParameterNames: ['webhook_id'],
|
|
112
|
+
atLeastOneParameterNames: [],
|
|
111
113
|
responseKey: undefined,
|
|
112
114
|
options,
|
|
113
115
|
});
|
|
@@ -123,6 +125,7 @@ export class SeamHttpWebhooks {
|
|
|
123
125
|
parameters,
|
|
124
126
|
hasRequiredParameters: true,
|
|
125
127
|
requiredParameterNames: ['webhook_id'],
|
|
128
|
+
atLeastOneParameterNames: [],
|
|
126
129
|
responseKey: 'webhook',
|
|
127
130
|
options,
|
|
128
131
|
});
|
|
@@ -138,6 +141,7 @@ export class SeamHttpWebhooks {
|
|
|
138
141
|
parameters,
|
|
139
142
|
hasRequiredParameters: false,
|
|
140
143
|
requiredParameterNames: [],
|
|
144
|
+
atLeastOneParameterNames: [],
|
|
141
145
|
responseKey: 'webhooks',
|
|
142
146
|
options,
|
|
143
147
|
});
|
|
@@ -153,6 +157,7 @@ export class SeamHttpWebhooks {
|
|
|
153
157
|
parameters,
|
|
154
158
|
hasRequiredParameters: true,
|
|
155
159
|
requiredParameterNames: ['event_types', 'webhook_id'],
|
|
160
|
+
atLeastOneParameterNames: [],
|
|
156
161
|
responseKey: undefined,
|
|
157
162
|
options,
|
|
158
163
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../../../src/lib/routes/webhooks/webhooks.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,mCAAmC,EACnC,+BAA+B,GAChC,MAAM,aAAa,CAAA;AACpB,OAAO,EAAe,YAAY,EAAE,MAAM,eAAe,CAAA;AACzD,OAAO,EACL,2BAA2B,EAC3B,2BAA2B,EAC3B,uCAAuC,EACvC,wCAAwC,EACxC,wCAAwC,EAExC,2BAA2B,GAQ5B,MAAM,gBAAgB,CAAA;AACvB,OAAO,EACL,6BAA6B,EAC7B,YAAY,GACb,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAC5E,OAAO,
|
|
1
|
+
{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../../../src/lib/routes/webhooks/webhooks.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,mCAAmC,EACnC,+BAA+B,GAChC,MAAM,aAAa,CAAA;AACpB,OAAO,EAAe,YAAY,EAAE,MAAM,eAAe,CAAA;AACzD,OAAO,EACL,2BAA2B,EAC3B,2BAA2B,EAC3B,uCAAuC,EACvC,wCAAwC,EACxC,wCAAwC,EAExC,2BAA2B,GAQ5B,MAAM,gBAAgB,CAAA;AACvB,OAAO,EACL,6BAA6B,EAC7B,YAAY,GACb,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAC5E,OAAO,EACL,eAAe,GAEhB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAErD,MAAM,OAAO,gBAAgB;IAC3B,MAAM,CAAQ;IACL,QAAQ,CAAkC;IAEnD,YAAY,kBAA4C,EAAE;QACxD,MAAM,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC,CAAA;QAC7C,IAAI,CAAC,MAAM,GAAG,QAAQ,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;QAC1E,IAAI,CAAC,QAAQ,GAAG,6BAA6B,CAAC,OAAO,CAAC,CAAA;IACxD,CAAC;IAED,MAAM,CAAC,UAAU,CACf,MAA2C,EAC3C,UAAqD,EAAE;QAEvD,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAA;QACjD,IAAI,CAAC,2BAA2B,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,2BAA2B,CAAC,gBAAgB,CAAC,CAAA;QACzD,CAAC;QACD,OAAO,IAAI,gBAAgB,CAAC,kBAAkB,CAAC,CAAA;IACjD,CAAC;IAED,MAAM,CAAC,UAAU,CACf,MAA2C,EAC3C,UAAqD,EAAE;QAEvD,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAA;QACjD,IAAI,CAAC,2BAA2B,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,2BAA2B,CAAC,gBAAgB,CAAC,CAAA;QACzD,CAAC;QACD,OAAO,IAAI,gBAAgB,CAAC,kBAAkB,CAAC,CAAA;IACjD,CAAC;IAED,MAAM,CAAC,sBAAsB,CAC3B,kBAA+E,EAC/E,UAGI,EAAE;QAEN,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,kBAAkB,EAAE,CAAA;QAC7D,IAAI,CAAC,uCAAuC,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACjE,MAAM,IAAI,2BAA2B,CAAC,4BAA4B,CAAC,CAAA;QACrE,CAAC;QACD,OAAO,IAAI,gBAAgB,CAAC,kBAAkB,CAAC,CAAA;IACjD,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAC7B,cAAsB,EACtB,iBAAyB,EACzB,UAA6C,EAAE;QAE/C,+BAA+B,CAAC,iBAAiB,CAAC,CAAA;QAClD,MAAM,aAAa,GAAG,YAAY,CAAC,EAAE,GAAG,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;QAClE,IAAI,2BAA2B,CAAC,aAAa,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,2BAA2B,CACnC,2EAA2E,CAC5E,CAAA;QACH,CAAC;QACD,MAAM,MAAM,GAAG,YAAY,CAAC,aAAa,CAAC,CAAA;QAC1C,MAAM,cAAc,GAAG,sBAAsB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QAChE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC;YACjD,mBAAmB,EAAE,iBAAiB;SACvC,CAAC,CAAA;QACF,OAAO,gBAAgB,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IAChE,CAAC;IAED,MAAM,CAAC,uBAAuB,CAC5B,mBAAkF,EAClF,WAAkE,EAClE,UAGI,EAAE;QAEN,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,CAAA;QAC3E,IAAI,CAAC,wCAAwC,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,2BAA2B,CACnC,4CAA4C,CAC7C,CAAA;QACH,CAAC;QACD,OAAO,IAAI,gBAAgB,CAAC,kBAAkB,CAAC,CAAA;IACjD,CAAC;IAED,MAAM,CAAC,uBAAuB,CAC5B,mBAAkF,EAClF,WAAkE,EAClE,UAGI,EAAE;QAEN,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,CAAA;QAC3E,IAAI,CAAC,wCAAwC,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,2BAA2B,CACnC,4CAA4C,CAC7C,CAAA;QACH,CAAC;QACD,OAAO,IAAI,gBAAgB,CAAC,kBAAkB,CAAC,CAAA;IACjD,CAAC;IAED,eAAe,CACb,OAAsD;QAEtD,OAAO,IAAI,aAAa,CAA0B,IAAI,EAAE,OAAO,CAAC,CAAA;IAClE,CAAC;IAED,KAAK,CAAC,wBAAwB,CAC5B,kBAA+E;QAE/E,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAA;QACxC,MAAM,WAAW,GAAG,mCAAmC,CAAC;YACtD,kBAAkB;SACnB,CAAC,CAAA;QACF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3C,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CACb,qFAAqF,CACtF,CAAA;YACH,CAAC;QACH,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,GAAG,WAAW,EAAE,CAAA;QAC7D,MAAM,cAAc,GAAG,sBAAsB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACrE,MAAM,cAAc,CAAC,GAAG,EAAE,CAAA;IAC5B,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,UAAoC,EACpC,UAAiC,EAAE;QAEnC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,kBAAkB;YAC5B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,UAAU;YACV,qBAAqB,EAAE,IAAI;YAC3B,sBAAsB,EAAE,CAAC,KAAK,CAAC;YAC/B,wBAAwB,EAAE,EAAE;YAC5B,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,UAAoC,EACpC,UAAiC,EAAE;QAEnC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,kBAAkB;YAC5B,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,UAAU;YAClB,UAAU;YACV,qBAAqB,EAAE,IAAI;YAC3B,sBAAsB,EAAE,CAAC,YAAY,CAAC;YACtC,wBAAwB,EAAE,EAAE;YAC5B,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,GAAG,CACD,UAAiC,EACjC,UAA8B,EAAE;QAEhC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,eAAe;YACzB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,UAAU;YAClB,UAAU;YACV,qBAAqB,EAAE,IAAI;YAC3B,sBAAsB,EAAE,CAAC,YAAY,CAAC;YACtC,wBAAwB,EAAE,EAAE;YAC5B,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,IAAI,CACF,UAAmC,EACnC,UAA+B,EAAE;QAEjC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,gBAAgB;YAC1B,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,UAAU;YAClB,UAAU;YACV,qBAAqB,EAAE,KAAK;YAC5B,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,WAAW,EAAE,UAAU;YACvB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,UAAoC,EACpC,UAAiC,EAAE;QAEnC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,kBAAkB;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU;YAChB,UAAU;YACV,qBAAqB,EAAE,IAAI;YAC3B,sBAAsB,EAAE,CAAC,aAAa,EAAE,YAAY,CAAC;YACrD,wBAAwB,EAAE,EAAE;YAC5B,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;CACF"}
|
|
@@ -2,7 +2,7 @@ import { type Client } from '../../client.js';
|
|
|
2
2
|
import { type SeamHttpFromPublishableKeyOptions, type SeamHttpOptions, type SeamHttpOptionsWithApiKey, type SeamHttpOptionsWithClient, type SeamHttpOptionsWithClientSessionToken, type SeamHttpOptionsWithConsoleSessionToken, type SeamHttpOptionsWithPersonalAccessToken, type SeamHttpRequestOptions } from '../../options.js';
|
|
3
3
|
import type { ActionAttempt } from '../../resources/action-attempt.js';
|
|
4
4
|
import type { Workspace } from '../../resources/workspace.js';
|
|
5
|
-
import { SeamHttpRequest } from '../../seam-http-request.js';
|
|
5
|
+
import { SeamHttpRequest, type SeamPaginatedRequest } from '../../seam-http-request.js';
|
|
6
6
|
import { SeamPaginator } from '../../seam-paginator.js';
|
|
7
7
|
export declare class SeamHttpWorkspaces {
|
|
8
8
|
client: Client;
|
|
@@ -14,7 +14,7 @@ export declare class SeamHttpWorkspaces {
|
|
|
14
14
|
static fromPublishableKey(publishableKey: string, userIdentifierKey: string, options?: SeamHttpFromPublishableKeyOptions): Promise<SeamHttpWorkspaces>;
|
|
15
15
|
static fromConsoleSessionToken(consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'], workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'], options?: Omit<SeamHttpOptionsWithConsoleSessionToken, 'consoleSessionToken' | 'workspaceId'>): SeamHttpWorkspaces;
|
|
16
16
|
static fromPersonalAccessToken(personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'], workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'], options?: Omit<SeamHttpOptionsWithPersonalAccessToken, 'personalAccessToken' | 'workspaceId'>): SeamHttpWorkspaces;
|
|
17
|
-
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request:
|
|
17
|
+
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
18
18
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
19
19
|
/**
|
|
20
20
|
* Creates a new [workspace](https://docs.seam.co/core-concepts/workspaces).
|
|
@@ -8,7 +8,7 @@ import { isSeamHttpOptionsWithApiKey, isSeamHttpOptionsWithClient, isSeamHttpOpt
|
|
|
8
8
|
import { limitToSeamHttpRequestOptions, parseOptions, } from '../../parse-options.js';
|
|
9
9
|
import { SeamHttpActionAttempts } from '../../routes/action-attempts/index.js';
|
|
10
10
|
import { SeamHttpClientSessions } from '../../routes/client-sessions/index.js';
|
|
11
|
-
import { SeamHttpRequest } from '../../seam-http-request.js';
|
|
11
|
+
import { SeamHttpRequest, } from '../../seam-http-request.js';
|
|
12
12
|
import { SeamPaginator } from '../../seam-paginator.js';
|
|
13
13
|
export class SeamHttpWorkspaces {
|
|
14
14
|
client;
|
|
@@ -94,6 +94,7 @@ export class SeamHttpWorkspaces {
|
|
|
94
94
|
parameters,
|
|
95
95
|
hasRequiredParameters: true,
|
|
96
96
|
requiredParameterNames: ['name'],
|
|
97
|
+
atLeastOneParameterNames: [],
|
|
97
98
|
responseKey: 'workspace',
|
|
98
99
|
options,
|
|
99
100
|
});
|
|
@@ -109,6 +110,7 @@ export class SeamHttpWorkspaces {
|
|
|
109
110
|
parameters,
|
|
110
111
|
hasRequiredParameters: false,
|
|
111
112
|
requiredParameterNames: [],
|
|
113
|
+
atLeastOneParameterNames: [],
|
|
112
114
|
responseKey: 'workspace',
|
|
113
115
|
options,
|
|
114
116
|
});
|
|
@@ -124,6 +126,7 @@ export class SeamHttpWorkspaces {
|
|
|
124
126
|
parameters,
|
|
125
127
|
hasRequiredParameters: false,
|
|
126
128
|
requiredParameterNames: [],
|
|
129
|
+
atLeastOneParameterNames: [],
|
|
127
130
|
responseKey: 'workspaces',
|
|
128
131
|
options,
|
|
129
132
|
});
|
|
@@ -139,6 +142,7 @@ export class SeamHttpWorkspaces {
|
|
|
139
142
|
parameters,
|
|
140
143
|
hasRequiredParameters: false,
|
|
141
144
|
requiredParameterNames: [],
|
|
145
|
+
atLeastOneParameterNames: [],
|
|
142
146
|
responseKey: 'action_attempt',
|
|
143
147
|
options,
|
|
144
148
|
actionAttempts: () => SeamHttpActionAttempts.fromClient(this.client, {
|
|
@@ -158,6 +162,7 @@ export class SeamHttpWorkspaces {
|
|
|
158
162
|
parameters,
|
|
159
163
|
hasRequiredParameters: false,
|
|
160
164
|
requiredParameterNames: [],
|
|
165
|
+
atLeastOneParameterNames: [],
|
|
161
166
|
responseKey: undefined,
|
|
162
167
|
options,
|
|
163
168
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workspaces.js","sourceRoot":"","sources":["../../../src/lib/routes/workspaces/workspaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,mCAAmC,EACnC,+BAA+B,GAChC,MAAM,aAAa,CAAA;AACpB,OAAO,EAAe,YAAY,EAAE,MAAM,eAAe,CAAA;AACzD,OAAO,EACL,2BAA2B,EAC3B,2BAA2B,EAC3B,uCAAuC,EACvC,wCAAwC,EACxC,wCAAwC,EAExC,2BAA2B,GAQ5B,MAAM,gBAAgB,CAAA;AACvB,OAAO,EACL,6BAA6B,EAC7B,YAAY,GACb,MAAM,sBAAsB,CAAA;AAG7B,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAC5E,OAAO,
|
|
1
|
+
{"version":3,"file":"workspaces.js","sourceRoot":"","sources":["../../../src/lib/routes/workspaces/workspaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,mCAAmC,EACnC,+BAA+B,GAChC,MAAM,aAAa,CAAA;AACpB,OAAO,EAAe,YAAY,EAAE,MAAM,eAAe,CAAA;AACzD,OAAO,EACL,2BAA2B,EAC3B,2BAA2B,EAC3B,uCAAuC,EACvC,wCAAwC,EACxC,wCAAwC,EAExC,2BAA2B,GAQ5B,MAAM,gBAAgB,CAAA;AACvB,OAAO,EACL,6BAA6B,EAC7B,YAAY,GACb,MAAM,sBAAsB,CAAA;AAG7B,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAC5E,OAAO,EACL,eAAe,GAEhB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAErD,MAAM,OAAO,kBAAkB;IAC7B,MAAM,CAAQ;IACL,QAAQ,CAAkC;IAEnD,YAAY,kBAA4C,EAAE;QACxD,MAAM,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC,CAAA;QAC7C,IAAI,CAAC,MAAM,GAAG,QAAQ,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;QAC1E,IAAI,CAAC,QAAQ,GAAG,6BAA6B,CAAC,OAAO,CAAC,CAAA;IACxD,CAAC;IAED,MAAM,CAAC,UAAU,CACf,MAA2C,EAC3C,UAAqD,EAAE;QAEvD,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAA;QACjD,IAAI,CAAC,2BAA2B,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,2BAA2B,CAAC,gBAAgB,CAAC,CAAA;QACzD,CAAC;QACD,OAAO,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,CAAA;IACnD,CAAC;IAED,MAAM,CAAC,UAAU,CACf,MAA2C,EAC3C,UAAqD,EAAE;QAEvD,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAA;QACjD,IAAI,CAAC,2BAA2B,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,2BAA2B,CAAC,gBAAgB,CAAC,CAAA;QACzD,CAAC;QACD,OAAO,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,CAAA;IACnD,CAAC;IAED,MAAM,CAAC,sBAAsB,CAC3B,kBAA+E,EAC/E,UAGI,EAAE;QAEN,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,kBAAkB,EAAE,CAAA;QAC7D,IAAI,CAAC,uCAAuC,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACjE,MAAM,IAAI,2BAA2B,CAAC,4BAA4B,CAAC,CAAA;QACrE,CAAC;QACD,OAAO,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,CAAA;IACnD,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAC7B,cAAsB,EACtB,iBAAyB,EACzB,UAA6C,EAAE;QAE/C,+BAA+B,CAAC,iBAAiB,CAAC,CAAA;QAClD,MAAM,aAAa,GAAG,YAAY,CAAC,EAAE,GAAG,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;QAClE,IAAI,2BAA2B,CAAC,aAAa,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,2BAA2B,CACnC,6EAA6E,CAC9E,CAAA;QACH,CAAC;QACD,MAAM,MAAM,GAAG,YAAY,CAAC,aAAa,CAAC,CAAA;QAC1C,MAAM,cAAc,GAAG,sBAAsB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QAChE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC;YACjD,mBAAmB,EAAE,iBAAiB;SACvC,CAAC,CAAA;QACF,OAAO,kBAAkB,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IAClE,CAAC;IAED,MAAM,CAAC,uBAAuB,CAC5B,mBAAkF,EAClF,WAAkE,EAClE,UAGI,EAAE;QAEN,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,CAAA;QAC3E,IAAI,CAAC,wCAAwC,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,2BAA2B,CACnC,4CAA4C,CAC7C,CAAA;QACH,CAAC;QACD,OAAO,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,CAAA;IACnD,CAAC;IAED,MAAM,CAAC,uBAAuB,CAC5B,mBAAkF,EAClF,WAAkE,EAClE,UAGI,EAAE;QAEN,MAAM,kBAAkB,GAAG,EAAE,GAAG,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,CAAA;QAC3E,IAAI,CAAC,wCAAwC,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,2BAA2B,CACnC,4CAA4C,CAC7C,CAAA;QACH,CAAC;QACD,OAAO,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,CAAA;IACnD,CAAC;IAED,eAAe,CACb,OAAsD;QAEtD,OAAO,IAAI,aAAa,CAA0B,IAAI,EAAE,OAAO,CAAC,CAAA;IAClE,CAAC;IAED,KAAK,CAAC,wBAAwB,CAC5B,kBAA+E;QAE/E,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAA;QACxC,MAAM,WAAW,GAAG,mCAAmC,CAAC;YACtD,kBAAkB;SACnB,CAAC,CAAA;QACF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3C,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CACb,qFAAqF,CACtF,CAAA;YACH,CAAC;QACH,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,GAAG,WAAW,EAAE,CAAA;QAC7D,MAAM,cAAc,GAAG,sBAAsB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACrE,MAAM,cAAc,CAAC,GAAG,EAAE,CAAA;IAC5B,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,UAAsC,EACtC,UAAmC,EAAE;QAErC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,oBAAoB;YAC9B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,UAAU;YACV,qBAAqB,EAAE,IAAI;YAC3B,sBAAsB,EAAE,CAAC,MAAM,CAAC;YAChC,wBAAwB,EAAE,EAAE;YAC5B,WAAW,EAAE,WAAW;YACxB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,GAAG,CACD,UAAoC,EACpC,UAAgC,EAAE;QAElC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,iBAAiB;YAC3B,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,UAAU;YAClB,UAAU;YACV,qBAAqB,EAAE,KAAK;YAC5B,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,WAAW,EAAE,WAAW;YACxB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,IAAI,CACF,UAAqC,EACrC,UAAiC,EAAE;QAEnC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,kBAAkB;YAC5B,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,UAAU;YAClB,UAAU;YACV,qBAAqB,EAAE,KAAK;YAC5B,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,WAAW,EAAE,YAAY;YACzB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,YAAY,CACV,UAA6C,EAC7C,UAAyC,EAAE;QAE3C,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,2BAA2B;YACrC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,UAAU;YACV,qBAAqB,EAAE,KAAK;YAC5B,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,WAAW,EAAE,gBAAgB;YAC7B,OAAO;YACP,cAAc,EAAE,GAAG,EAAE,CACnB,sBAAsB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE;gBAC7C,GAAG,IAAI,CAAC,QAAQ;gBAChB,oBAAoB,EAAE,KAAK;aAC5B,CAAC;SACL,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,UAAuC,EACvC,UAAmC,EAAE;QAErC,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/B,QAAQ,EAAE,oBAAoB;YAC9B,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,UAAU;YAChB,UAAU;YACV,qBAAqB,EAAE,KAAK;YAC5B,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,WAAW,EAAE,SAAS;YACtB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;CACF"}
|
|
@@ -18,6 +18,7 @@ interface SeamHttpRequestConfig<TResponseKey> {
|
|
|
18
18
|
readonly parameters?: unknown;
|
|
19
19
|
readonly hasRequiredParameters?: boolean;
|
|
20
20
|
readonly requiredParameterNames?: readonly string[];
|
|
21
|
+
readonly atLeastOneParameterNames?: readonly string[];
|
|
21
22
|
}
|
|
22
23
|
/**
|
|
23
24
|
* A lazy request to the Seam API.
|
|
@@ -38,7 +39,7 @@ interface SeamHttpRequestConfig<TResponseKey> {
|
|
|
38
39
|
* Before sending, the request may be inspected
|
|
39
40
|
* with `url`, `pathname`, `method`, `params`, and `body`.
|
|
40
41
|
*/
|
|
41
|
-
export declare class SeamHttpRequest<const TResponse, const TResponseKey extends keyof TResponse | undefined> implements Promise<TResponseKey extends keyof TResponse ? TResponse[TResponseKey] : undefined> {
|
|
42
|
+
export declare class SeamHttpRequest<const TResponse, const TResponseKey extends keyof TResponse | undefined, const THasPagination extends boolean = boolean> implements Promise<TResponseKey extends keyof TResponse ? TResponse[TResponseKey] : undefined> {
|
|
42
43
|
#private;
|
|
43
44
|
readonly [Symbol.toStringTag]: string;
|
|
44
45
|
constructor(parent: SeamHttpRequestParent, config: SeamHttpRequestConfig<TResponseKey>);
|
|
@@ -47,7 +48,7 @@ export declare class SeamHttpRequest<const TResponse, const TResponseKey extends
|
|
|
47
48
|
* or undefined if the endpoint returns an empty response.
|
|
48
49
|
*/
|
|
49
50
|
get responseKey(): TResponseKey;
|
|
50
|
-
get hasPagination():
|
|
51
|
+
get hasPagination(): THasPagination;
|
|
51
52
|
/**
|
|
52
53
|
* The full request URL including any serialized query parameters.
|
|
53
54
|
*/
|
|
@@ -78,6 +79,10 @@ export declare class SeamHttpRequest<const TResponse, const TResponseKey extends
|
|
|
78
79
|
catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null | undefined): Promise<(TResponseKey extends keyof TResponse ? TResponse[TResponseKey] : undefined) | TResult>;
|
|
79
80
|
finally(onfinally?: (() => void) | null | undefined): Promise<TResponseKey extends keyof TResponse ? TResponse[TResponseKey] : undefined>;
|
|
80
81
|
}
|
|
82
|
+
/**
|
|
83
|
+
* A SeamHttpRequest for an endpoint that supports pagination.
|
|
84
|
+
*/
|
|
85
|
+
export type SeamPaginatedRequest<TResponse, TResponseKey extends keyof TResponse | undefined> = SeamHttpRequest<TResponse, TResponseKey, true>;
|
|
81
86
|
/**
|
|
82
87
|
* Reads the response data at the response key,
|
|
83
88
|
* throwing a {@link SeamHttpInvalidResponseError} for a success response
|
package/lib/seam-http-request.js
CHANGED
|
@@ -39,16 +39,14 @@ export class SeamHttpRequest {
|
|
|
39
39
|
return this.#config.responseKey;
|
|
40
40
|
}
|
|
41
41
|
get hasPagination() {
|
|
42
|
-
return this.#config.hasPagination ?? false;
|
|
42
|
+
return (this.#config.hasPagination ?? false);
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
45
45
|
* The full request URL including any serialized query parameters.
|
|
46
46
|
*/
|
|
47
47
|
get url() {
|
|
48
48
|
const { client } = this.#parent;
|
|
49
|
-
const serializer =
|
|
50
|
-
? client.defaults.paramsSerializer
|
|
51
|
-
: serializeUrlSearchParams;
|
|
49
|
+
const serializer = getParamsSerializer(client.defaults.paramsSerializer);
|
|
52
50
|
const origin = getUrlPrefix(client.defaults.baseURL ?? '');
|
|
53
51
|
const path = this.params == null
|
|
54
52
|
? this.pathname
|
|
@@ -116,7 +114,7 @@ export class SeamHttpRequest {
|
|
|
116
114
|
return await this.#fetchResponsePromise;
|
|
117
115
|
}
|
|
118
116
|
async #fetchResponse() {
|
|
119
|
-
assertValidRequestParameters(this.#config.parameters, this.pathname, this.#config.hasRequiredParameters ?? false, this.#config.requiredParameterNames ?? []);
|
|
117
|
+
assertValidRequestParameters(this.#config.parameters, this.pathname, this.#config.hasRequiredParameters ?? false, this.#config.requiredParameterNames ?? [], this.#config.atLeastOneParameterNames ?? []);
|
|
120
118
|
const { client } = this.#parent;
|
|
121
119
|
const response = await client.request({
|
|
122
120
|
url: this.pathname,
|
|
@@ -136,6 +134,14 @@ export class SeamHttpRequest {
|
|
|
136
134
|
return await this.execute().finally(onfinally);
|
|
137
135
|
}
|
|
138
136
|
}
|
|
137
|
+
const getParamsSerializer = (paramsSerializer) => {
|
|
138
|
+
if (typeof paramsSerializer === 'function')
|
|
139
|
+
return paramsSerializer;
|
|
140
|
+
if (typeof paramsSerializer?.serialize === 'function') {
|
|
141
|
+
return paramsSerializer.serialize;
|
|
142
|
+
}
|
|
143
|
+
return serializeUrlSearchParams;
|
|
144
|
+
};
|
|
139
145
|
/**
|
|
140
146
|
* Reads the response data at the response key,
|
|
141
147
|
* throwing a {@link SeamHttpInvalidResponseError} for a success response
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"seam-http-request.js","sourceRoot":"","sources":["../src/lib/seam-http-request.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAA;AACtE,OAAO,EAEL,oBAAoB,GACrB,MAAM,6BAA6B,CAAA;AAEpC,OAAO,EAAE,4BAA4B,EAAE,MAAM,sBAAsB,CAAA;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAA;
|
|
1
|
+
{"version":3,"file":"seam-http-request.js","sourceRoot":"","sources":["../src/lib/seam-http-request.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAA;AACtE,OAAO,EAEL,oBAAoB,GACrB,MAAM,6BAA6B,CAAA;AAEpC,OAAO,EAAE,4BAA4B,EAAE,MAAM,sBAAsB,CAAA;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAA;AAsB5E;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,eAAe;IAOjB,CAAC,MAAM,CAAC,WAAW,CAAC,GAAW,iBAAiB,CAAA;IAEhD,OAAO,CAAuB;IAC9B,OAAO,CAAqC;IAErD,eAAe,GAEJ,IAAI,CAAA;IAEf,qBAAqB,GAA8B,IAAI,CAAA;IAEvD,YACE,MAA6B,EAC7B,MAA2C;QAE3C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;IACvB,CAAC;IAED;;;OAGG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAA;IACjC,CAAC;IAED,IAAW,aAAa;QACtB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,KAAK,CAAmB,CAAA;IAChE,CAAC;IAED;;OAEG;IACH,IAAW,GAAG;QACZ,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAE/B,MAAM,UAAU,GAAG,mBAAmB,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;QAExE,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC,CAAA;QAE1D,MAAM,IAAI,GACR,IAAI,CAAC,MAAM,IAAI,IAAI;YACjB,CAAC,CAAC,IAAI,CAAC,QAAQ;YACf,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAA;QAEnD,OAAO,IAAI,GAAG,CAAC,GAAG,MAAM,GAAG,IAAI,EAAE,CAAC,CAAA;IACpC,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC;YAC1C,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ;YACvB,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAA;IACjC,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;IAC5B,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;IAC5B,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;IAC1B,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,OAAO;QAGX,IAAI,CAAC,eAAe,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAA;QACxC,OAAO,MAAM,IAAI,CAAC,eAAe,CAAA;IACnC,CAAC;IAED,KAAK,CAAC,QAAQ;QAGZ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QAM3C,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACnC,OAAO,SAAqB,CAAA;QAC9B,CAAC;QAED,MAAM,IAAI,GAAG,gBAAgB,CAC3B,QAAQ,EACR,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,QAAQ,CACF,CAAA;QAEb,IAAI,IAAI,CAAC,WAAW,KAAK,gBAAgB,EAAE,CAAC;YAC1C,MAAM,oBAAoB,GACxB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,oBAAoB;gBAC1C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAA;YAE5C,IAAI,oBAAoB,KAAK,KAAK,EAAE,CAAC;gBACnC,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,IAAI,EAAE,CAAC;oBACxC,MAAM,IAAI,KAAK,CACb,qEAAqE,CACtE,CAAA;gBACH,CAAC;gBACD,MAAM,cAAc,GAClB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,KAAK,UAAU;oBAC/C,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;oBAC/B,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAA;gBACjC,MAAM,aAAa,GAAG,MAAM,oBAAoB,CAC9C,IAAgC,EAChC,cAAc,EACd,OAAO,oBAAoB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,oBAAoB,CACtE,CAAA;gBACD,OAAO,aAAyB,CAAA;YAClC,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,aAAa;QACjB,IAAI,CAAC,qBAAqB,KAAK,IAAI,CAAC,cAAc,EAAE,CAAA;QACpD,OAAO,MAAM,IAAI,CAAC,qBAAqB,CAAA;IACzC,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,4BAA4B,CAC1B,IAAI,CAAC,OAAO,CAAC,UAAU,EACvB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,OAAO,CAAC,qBAAqB,IAAI,KAAK,EAC3C,IAAI,CAAC,OAAO,CAAC,sBAAsB,IAAI,EAAE,EACzC,IAAI,CAAC,OAAO,CAAC,wBAAwB,IAAI,EAAE,CAC5C,CAAA;QAED,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAC/B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YACpC,GAAG,EAAE,IAAI,CAAC,QAAQ;YAClB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAA;QACF,OAAO,QAAQ,CAAC,IAA4B,CAAA;IAC9C,CAAC;IAED,KAAK,CAAC,IAAI,CAMR,WAOa,EACb,UAGa;QAEb,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAA;IAC3D,CAAC;IAED,KAAK,CAAC,KAAK,CACT,UAC0E;QAO1E,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;IAC/C,CAAC;IAED,KAAK,CAAC,OAAO,CACX,SAA2C;QAI3C,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAChD,CAAC;CACF;AAED,MAAM,mBAAmB,GAAG,CAC1B,gBAAwD,EACT,EAAE;IACjD,IAAI,OAAO,gBAAgB,KAAK,UAAU;QAAE,OAAO,gBAAgB,CAAA;IACnE,IAAI,OAAO,gBAAgB,EAAE,SAAS,KAAK,UAAU,EAAE,CAAC;QACtD,OAAO,gBAAgB,CAAC,SAAS,CAAA;IACnC,CAAC;IACD,OAAO,wBAAwB,CAAA;AACjC,CAAC,CAAA;AAUD;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAI9B,QAAmB,EACnB,WAAyB,EACzB,IAAY,EACa,EAAE;IAC3B,IAAI,QAAQ,IAAI,IAAI,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACrD,MAAM,IAAI,4BAA4B,CACpC,IAAI,EACJ,MAAM,CAAC,WAAW,CAAC,EACnB,OAAO,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,QAAQ,+BAA+B,CACnF,CAAA;IACH,CAAC;IAED,IAAI,CAAC,CAAC,WAAW,IAAI,QAAQ,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,4BAA4B,CACpC,IAAI,EACJ,MAAM,CAAC,WAAW,CAAC,EACnB,qCAAqC,CACtC,CAAA;IACH,CAAC;IAED,OAAO,QAAQ,CAAC,WAAW,CAAC,CAAA;AAC9B,CAAC,CAAA;AAED,MAAM,YAAY,GAAG,CAAC,KAAa,EAAU,EAAE;IAC7C,IAAI,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAA;QACrC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAC9C,OAAO,GAAG,CAAA;IACZ,CAAC;IACD,IAAI,UAAU,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAA;QAC5D,OAAO,IAAI,GAAG,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,GAAG,QAAQ,EAAE,CAAC;aACvD,QAAQ,EAAE;aACV,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IACvB,CAAC;IACD,MAAM,IAAI,KAAK,CACb,8BAA8B,KAAK,+BAA+B,CACnE,CAAA;AACH,CAAC,CAAA;AAED,kEAAkE;AAClE,wEAAwE;AACxE,8CAA8C;AAC9C,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAW,EAAE;IACnD,IAAI,CAAC;QACH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAA;QACnC,OAAO,QAAQ,KAAK,OAAO,IAAI,QAAQ,KAAK,QAAQ,CAAA;IACtD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC,CAAA"}
|
package/lib/seam-paginator.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { Client } from './client.js';
|
|
2
2
|
import type { SeamHttpRequestOptions } from './options.js';
|
|
3
|
-
import {
|
|
3
|
+
import { type SeamPaginatedRequest } from './seam-http-request.js';
|
|
4
4
|
interface SeamPaginatorParent {
|
|
5
5
|
readonly client: Client;
|
|
6
6
|
readonly defaults: Required<SeamHttpRequestOptions>;
|
|
@@ -28,7 +28,7 @@ interface Pagination {
|
|
|
28
28
|
*/
|
|
29
29
|
export declare class SeamPaginator<const TResponse, const TResponseKey extends keyof TResponse> implements AsyncIterable<EnsureReadonlyArray<TResponse[TResponseKey]>> {
|
|
30
30
|
#private;
|
|
31
|
-
constructor(parent: SeamPaginatorParent, request:
|
|
31
|
+
constructor(parent: SeamPaginatorParent, request: SeamPaginatedRequest<TResponse, TResponseKey>);
|
|
32
32
|
/**
|
|
33
33
|
* Fetches the first page of results along with the pagination state.
|
|
34
34
|
*/
|
package/lib/seam-paginator.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { SeamHttpInvalidResponseError } from './seam-http-error.js';
|
|
2
|
-
import { readResponseData, SeamHttpRequest } from './seam-http-request.js';
|
|
2
|
+
import { readResponseData, SeamHttpRequest, } from './seam-http-request.js';
|
|
3
3
|
/**
|
|
4
4
|
* Iterates over paginated results from Seam API list endpoints.
|
|
5
5
|
*
|
|
@@ -40,16 +40,19 @@ export class SeamPaginator {
|
|
|
40
40
|
if (responseKey == null) {
|
|
41
41
|
throw new Error('Cannot paginate a response without a responseKey');
|
|
42
42
|
}
|
|
43
|
+
const method = this.#request.method;
|
|
44
|
+
const requestData = {
|
|
45
|
+
...(usesParams(method)
|
|
46
|
+
? (this.#request.params ?? {})
|
|
47
|
+
: (this.#request.body ?? {})),
|
|
48
|
+
page_cursor: nextPageCursor,
|
|
49
|
+
};
|
|
43
50
|
const request = new SeamHttpRequest(this.#parent, {
|
|
44
51
|
pathname: this.#request.pathname,
|
|
45
|
-
method
|
|
52
|
+
method,
|
|
46
53
|
responseKey,
|
|
47
|
-
params:
|
|
48
|
-
|
|
49
|
-
: undefined,
|
|
50
|
-
body: this.#request.body != null
|
|
51
|
-
? { ...this.#request.body, page_cursor: nextPageCursor }
|
|
52
|
-
: undefined,
|
|
54
|
+
params: usesParams(method) ? requestData : undefined,
|
|
55
|
+
body: usesParams(method) ? undefined : requestData,
|
|
53
56
|
});
|
|
54
57
|
const response = await request.fetchResponse();
|
|
55
58
|
const data = readResponseData(response, responseKey, request.pathname);
|
|
@@ -113,4 +116,5 @@ export class SeamPaginator {
|
|
|
113
116
|
}
|
|
114
117
|
}
|
|
115
118
|
}
|
|
119
|
+
const usesParams = (method) => ['GET', 'DELETE'].includes(method.toUpperCase());
|
|
116
120
|
//# sourceMappingURL=seam-paginator.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"seam-paginator.js","sourceRoot":"","sources":["../src/lib/seam-paginator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,4BAA4B,EAAE,MAAM,sBAAsB,CAAA;AACnE,OAAO,
|
|
1
|
+
{"version":3,"file":"seam-paginator.js","sourceRoot":"","sources":["../src/lib/seam-paginator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,4BAA4B,EAAE,MAAM,sBAAsB,CAAA;AACnE,OAAO,EACL,gBAAgB,EAChB,eAAe,GAEhB,MAAM,wBAAwB,CAAA;AAoB/B;;;;;;;;GAQG;AACH,MAAM,OAAO,aAAa;IAIf,QAAQ,CAA+C;IACvD,OAAO,CAAqB;IAErC,YACE,MAA2B,EAC3B,OAAsD;QAEtD,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACb,OAAO,OAAO,CAAC,QAAQ,uCAAuC,CAC/D,CAAA;QACH,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;IACzB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS;QAGb,OAAO,MAAM,IAAI,CAAC,MAAM,EAAE,CAAA;IAC5B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ,CACZ,cAA4C;QAE5C,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAA;QACxE,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;IAC1C,CAAC;IAED,KAAK,CAAC,MAAM,CACV,cAA6C;QAE7C,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAA;QAE7C,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;QACrE,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAA;QAEnC,MAAM,WAAW,GAAG;YAClB,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC;gBACpB,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,EAAE,CAAC;gBAC9B,CAAC,CAAC,CAAE,IAAI,CAAC,QAAQ,CAAC,IAAuC,IAAI,EAAE,CAAC,CAAC;YACnE,WAAW,EAAE,cAAc;SAC5B,CAAA;QAED,MAAM,OAAO,GAAG,IAAI,eAAe,CAA0B,IAAI,CAAC,OAAO,EAAE;YACzE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ;YAChC,MAAM;YACN,WAAW;YACX,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;YACpD,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW;SACnD,CAAC,CAAA;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,aAAa,EAAE,CAAA;QAC9C,MAAM,IAAI,GAAG,gBAAgB,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;QAEtE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,4BAA4B,CACpC,OAAO,CAAC,QAAQ,EAChB,MAAM,CAAC,WAAW,CAAC,EACnB,OAAO,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,IAAI,oBAAoB,CAChE,CAAA;QACH,CAAC;QAED,MAAM,cAAc,GAAG,gBAAgB,CACrC,QAAmC,EACnC,YAAY,EACZ,OAAO,CAAC,QAAQ,CACjB,CAAA;QAED,IAAI,cAAc,KAAK,IAAI,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YAClE,MAAM,IAAI,4BAA4B,CACpC,OAAO,CAAC,QAAQ,EAChB,YAAY,EACZ,OAAO,cAAc,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,cAAc,iCAAiC,CACjG,CAAA;QACH,CAAC;QAED,MAAM,kBAAkB,GAAG,cAAgC,CAAA;QAE3D,MAAM,UAAU,GAAe;YAC7B,WAAW,EAAE,kBAAkB,CAAC,aAAa,IAAI,KAAK;YACtD,cAAc,EAAE,kBAAkB,CAAC,gBAAgB,IAAI,IAAI;YAC3D,WAAW,EAAE,kBAAkB,CAAC,aAAa,IAAI,IAAI;SACtD,CAAA;QAED,OAAO;YACL,IAAoD;YACpD,UAAU;SACF,CAAA;IACZ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc;QAGlB,MAAM,KAAK,GAAG,EAAiD,CAAA;QAC/D,IAAI,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;YAC3C,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;QACxB,CAAC;QACD,OAAO,KAAqD,CAAA;IAC9D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,CAAC,OAAO;QACZ,IAAI,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;YAC3C,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;gBAC3B,MAAM,IAAI,CAAA;YACZ,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;QAG3B,IAAI,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;YAC3C,MAAM,OAAO,CAAA;QACf,CAAC;IACH,CAAC;IAED,KAAK,CAAC,CAAC,KAAK;QAGV,MAAM,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAA;QAC7C,IAAI,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAA;QACjC,MAAM,IAAI,CAAA;QACV,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,cAAc,CAAA;YACrC,IAAI,MAAM,IAAI,IAAI,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC;gBAAE,OAAM;YACrD,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;YACvB,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;YAClC,MAAM,IAAI,CAAA;QACZ,CAAC;IACH,CAAC;CACF;AAED,MAAM,UAAU,GAAG,CAAC,MAAc,EAAW,EAAE,CAC7C,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAA"}
|
package/lib/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
declare const seamapiJavascriptHttpVersion = "2.
|
|
1
|
+
declare const seamapiJavascriptHttpVersion = "2.24.0";
|
|
2
2
|
export default seamapiJavascriptHttpVersion;
|
package/lib/version.js
CHANGED
package/package.json
CHANGED
|
@@ -10,6 +10,7 @@ export const assertValidRequestParameters = (
|
|
|
10
10
|
path: string,
|
|
11
11
|
hasRequiredParameters: boolean,
|
|
12
12
|
requiredParameterNames: readonly string[],
|
|
13
|
+
atLeastOneParameterNames: readonly string[],
|
|
13
14
|
): void => {
|
|
14
15
|
if (parameters === undefined) {
|
|
15
16
|
if (hasRequiredParameters) {
|
|
@@ -37,8 +38,10 @@ export const assertValidRequestParameters = (
|
|
|
37
38
|
}
|
|
38
39
|
|
|
39
40
|
if (
|
|
40
|
-
|
|
41
|
-
|
|
41
|
+
atLeastOneParameterNames.length > 0 &&
|
|
42
|
+
atLeastOneParameterNames.every(
|
|
43
|
+
(name) => parameterValues[name] === undefined,
|
|
44
|
+
)
|
|
42
45
|
) {
|
|
43
46
|
throw new TypeError(`At least one parameter is required for ${path}`)
|
|
44
47
|
}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { SeamHttpInvalidOptionsError } from './options.js'
|
|
1
2
|
import type { ActionAttempt } from './resources/action-attempt.js'
|
|
2
3
|
|
|
3
4
|
/**
|
|
@@ -29,55 +30,51 @@ export interface ResolveActionAttemptOptions {
|
|
|
29
30
|
* @throws {@link SeamActionAttemptFailedError} if the action attempt fails.
|
|
30
31
|
* @throws {@link SeamActionAttemptTimeoutError} if the action attempt
|
|
31
32
|
* does not resolve within the timeout.
|
|
33
|
+
* @throws {@link SeamHttpInvalidOptionsError} if the timeout is negative
|
|
34
|
+
* or the pollingInterval is not greater than zero.
|
|
32
35
|
*/
|
|
33
36
|
export const resolveActionAttempt = async <T extends ActionAttempt>(
|
|
34
37
|
actionAttempt: T,
|
|
35
38
|
actionAttempts: ActionAttemptsClient,
|
|
36
39
|
{ timeout = 10_000, pollingInterval = 1_000 }: ResolveActionAttemptOptions,
|
|
37
40
|
): Promise<SucceededActionAttempt<T>> => {
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
reject(new SeamActionAttemptTimeoutError<T>(actionAttempt, timeout))
|
|
43
|
-
}, timeout)
|
|
44
|
-
},
|
|
45
|
-
)
|
|
46
|
-
|
|
47
|
-
try {
|
|
48
|
-
return await Promise.race([
|
|
49
|
-
pollActionAttempt<T>(actionAttempt, actionAttempts, { pollingInterval }),
|
|
50
|
-
timeoutPromise,
|
|
51
|
-
])
|
|
52
|
-
} finally {
|
|
53
|
-
if (timeoutRef != null) globalThis.clearTimeout(timeoutRef)
|
|
41
|
+
if (Number.isNaN(timeout) || timeout < 0) {
|
|
42
|
+
throw new SeamHttpInvalidOptionsError(
|
|
43
|
+
`The timeout option must not be negative, got ${timeout}`,
|
|
44
|
+
)
|
|
54
45
|
}
|
|
55
|
-
}
|
|
56
46
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
): Promise<SucceededActionAttempt<T>> => {
|
|
62
|
-
if (isSuccessfulActionAttempt(actionAttempt)) {
|
|
63
|
-
return actionAttempt
|
|
47
|
+
if (Number.isNaN(pollingInterval) || pollingInterval <= 0) {
|
|
48
|
+
throw new SeamHttpInvalidOptionsError(
|
|
49
|
+
`The pollingInterval option must be greater than zero, got ${pollingInterval}`,
|
|
50
|
+
)
|
|
64
51
|
}
|
|
65
52
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
53
|
+
const deadline = Date.now() + timeout
|
|
54
|
+
let currentActionAttempt = actionAttempt
|
|
55
|
+
|
|
56
|
+
while (true) {
|
|
57
|
+
if (isSuccessfulActionAttempt(currentActionAttempt)) {
|
|
58
|
+
return currentActionAttempt
|
|
59
|
+
}
|
|
69
60
|
|
|
70
|
-
|
|
61
|
+
if (isFailedActionAttempt(currentActionAttempt)) {
|
|
62
|
+
throw new SeamActionAttemptFailedError(currentActionAttempt)
|
|
63
|
+
}
|
|
71
64
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
65
|
+
const remaining = deadline - Date.now()
|
|
66
|
+
if (remaining <= 0) {
|
|
67
|
+
throw new SeamActionAttemptTimeoutError<T>(currentActionAttempt, timeout)
|
|
68
|
+
}
|
|
75
69
|
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
70
|
+
await new Promise((resolve) =>
|
|
71
|
+
setTimeout(resolve, Math.min(pollingInterval, remaining)),
|
|
72
|
+
)
|
|
73
|
+
|
|
74
|
+
currentActionAttempt = (await actionAttempts.get({
|
|
75
|
+
action_attempt_id: currentActionAttempt.action_attempt_id,
|
|
76
|
+
})) as unknown as T
|
|
77
|
+
}
|
|
81
78
|
}
|
|
82
79
|
|
|
83
80
|
/**
|
|
@@ -146,7 +143,7 @@ export class SeamActionAttemptTimeoutError<
|
|
|
146
143
|
> extends SeamActionAttemptError<T> {
|
|
147
144
|
constructor(actionAttempt: T, timeout: number) {
|
|
148
145
|
super(
|
|
149
|
-
`Timed out waiting for action
|
|
146
|
+
`Timed out waiting for action attempt after ${timeout}ms`,
|
|
150
147
|
actionAttempt,
|
|
151
148
|
)
|
|
152
149
|
this.name = this.constructor.name
|