@forumulate/sdk 0.11.0 → 0.11.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/http.d.ts CHANGED
@@ -6,7 +6,7 @@
6
6
  * and not another.
7
7
  */
8
8
  /** Kept in step with package.json by `coverage.test.ts`. */
9
- export declare const SDK_VERSION = "0.11.0";
9
+ export declare const SDK_VERSION = "0.11.1";
10
10
  /** The API's error envelope: `{ error: { code, message, details? }, requestId? }`. */
11
11
  export interface ForumulateErrorInit {
12
12
  /** Field-level detail, e.g. `{ title: ['Required'] }` for `validation.failed`. */
package/dist/http.js CHANGED
@@ -11,7 +11,7 @@ exports.ForumulateError = exports.SDK_VERSION = void 0;
11
11
  exports.retryDelayMs = retryDelayMs;
12
12
  exports.send = send;
13
13
  /** Kept in step with package.json by `coverage.test.ts`. */
14
- exports.SDK_VERSION = '0.11.0';
14
+ exports.SDK_VERSION = '0.11.1';
15
15
  /**
16
16
  * Thrown for any non-2xx API response, and for a network failure that
17
17
  * outlived its retries (`status: 0`, `code: 'network.error'`). Mirrors the
@@ -481,6 +481,12 @@ export declare const OPERATIONS: {
481
481
  readonly subscribe: "POST ~P/changelog/subscribe";
482
482
  readonly list: "GET ~P/changelog p";
483
483
  }];
484
+ readonly PublicChangelogDocument: readonly ["changelog.publicDocument", {
485
+ readonly spaceJson: "GET ~P/changelog/changelog.json p";
486
+ readonly spaceXml: "GET ~P/changelog/changelog.xml p";
487
+ readonly siteJson: "GET /public/orgs/{orgId}/sites/{siteSlug}/changelog.json p";
488
+ readonly siteXml: "GET /public/orgs/{orgId}/sites/{siteSlug}/changelog.xml p";
489
+ }];
484
490
  readonly PublicChangelogFeeds: readonly ["changelog.publicFeeds", {
485
491
  readonly rss: "GET ~P/changelog/rss.xml";
486
492
  readonly atom: "GET ~P/changelog/atom.xml";
@@ -1102,11 +1108,6 @@ export declare const OPERATIONS: {
1102
1108
  readonly launchData: "GET /course-xapi/{id}/{token}/activities/state";
1103
1109
  readonly saveState: "PUT /course-xapi/{id}/{token}/activities/state";
1104
1110
  }];
1105
- readonly CoursePackageFilesController: readonly ["courses.packageFilesController", {
1106
- readonly 'preflight[0]': "OPTIONS /course-xapi/{id}/{token}/statements";
1107
- readonly 'preflight[1]': "OPTIONS /course-xapi/{id}/{token}/fetch";
1108
- readonly 'preflight[2]': "OPTIONS /course-xapi/{id}/{token}/activities/state";
1109
- }];
1110
1111
  readonly CoursePackages: readonly ["courses.packages", {
1111
1112
  readonly upload: "POST ~s/course/lessons/{slug}/package m";
1112
1113
  readonly launch: "GET ~s/course/lessons/{slug}/package";
@@ -2585,6 +2586,10 @@ export declare const OPERATIONS: {
2585
2586
  readonly import: "POST ~s/docs/openapi/import";
2586
2587
  readonly importFile: "POST ~s/docs/openapi/import-file";
2587
2588
  }];
2589
+ readonly OpenApiAutoResync: readonly ["openapi.autoResync", {
2590
+ readonly state: "GET ~s/docs/openapi/specs/{id}/auto-resync";
2591
+ readonly configure: "PUT ~s/docs/openapi/specs/{id}/auto-resync";
2592
+ }];
2588
2593
  readonly OpenApiProxy: readonly ["openapi.proxy", {
2589
2594
  readonly forward: "POST ~P/openapi-proxy";
2590
2595
  }];
@@ -2598,6 +2603,9 @@ export declare const OPERATIONS: {
2598
2603
  readonly download: "GET ~P/sdk/{language}";
2599
2604
  readonly downloadPackage: "GET ~P/sdk/{language}/package b";
2600
2605
  }];
2606
+ readonly OpenApiResyncHook: readonly ["openapi.resyncHook", {
2607
+ readonly trigger: "POST /hooks/openapi/{orgId}/specs/{specId}";
2608
+ }];
2601
2609
  readonly SdkPublishing: readonly ["openapi.sdkPublishing", {
2602
2610
  readonly listRegistries: "GET ~o/sdk/registries p";
2603
2611
  readonly getRegistry: "GET ~o/sdk/registries/{registry}";
@@ -3421,6 +3429,14 @@ export declare const OPERATIONS: {
3421
3429
  readonly replace: "PUT ~o/sites/{siteId}/i18n/labels";
3422
3430
  readonly merge: "PATCH ~o/sites/{siteId}/i18n/labels";
3423
3431
  }];
3432
+ readonly SiteMachineFiles: readonly ["sites.machineFiles", {
3433
+ readonly getRobots: "GET ~o/sites/{siteId}/robots";
3434
+ readonly setRobots: "PUT ~o/sites/{siteId}/robots";
3435
+ readonly patchRobots: "PATCH ~o/sites/{siteId}/robots";
3436
+ readonly getLlms: "GET ~o/sites/{siteId}/llms";
3437
+ readonly setLlms: "PUT ~o/sites/{siteId}/llms";
3438
+ readonly patchLlms: "PATCH ~o/sites/{siteId}/llms";
3439
+ }];
3424
3440
  readonly SitePreview: readonly ["sites.preview", {
3425
3441
  readonly list: "GET ~o/sites/{siteId}/preview-tokens p";
3426
3442
  readonly mint: "POST ~o/sites/{siteId}/preview-tokens";
@@ -3454,6 +3470,9 @@ export declare const OPERATIONS: {
3454
3470
  readonly SiteRobots: readonly ["sites.robots", {
3455
3471
  readonly robots: "GET /public/orgs/{orgId}/sites/{siteSlug}/robots.txt";
3456
3472
  }];
3473
+ readonly SiteRobotsPreview: readonly ["sites.robotsPreview", {
3474
+ readonly preview: "POST ~o/sites/{siteId}/robots/preview";
3475
+ }];
3457
3476
  readonly SiteSearch: readonly ["sites.search", {
3458
3477
  readonly suggest: "GET /public/orgs/{orgId}/sites/{slug}/search/suggest";
3459
3478
  readonly ask: "POST /public/orgs/{orgId}/sites/{slug}/search/answer";
@@ -80,6 +80,7 @@ exports.OPERATIONS = {
80
80
  ChangelogImport: ['changelog.import', { import: 'POST ~s/changelog/import' }],
81
81
  ChangelogNotes: ['changelog.notes', { pullRequests: 'GET ~s/changelog/pull-requests p', draft: 'POST ~s/changelog/draft-notes' }],
82
82
  PublicChangelog: ['changelog.public', { comment: 'POST ~P/changelog/t/{slug}/comment', pieceMarkdown: 'GET ~P/changelog/t/{slug}.md', release: 'GET ~P/changelog/t/{slug}', react: 'POST ~P/changelog/t/{slug}/react', subscribe: 'POST ~P/changelog/subscribe', list: 'GET ~P/changelog p' }],
83
+ PublicChangelogDocument: ['changelog.publicDocument', { spaceJson: 'GET ~P/changelog/changelog.json p', spaceXml: 'GET ~P/changelog/changelog.xml p', siteJson: 'GET /public/orgs/{orgId}/sites/{siteSlug}/changelog.json p', siteXml: 'GET /public/orgs/{orgId}/sites/{siteSlug}/changelog.xml p' }],
83
84
  PublicChangelogFeeds: ['changelog.publicFeeds', { rss: 'GET ~P/changelog/rss.xml', atom: 'GET ~P/changelog/atom.xml', jsonFeed: 'GET ~P/changelog/feed.json' }],
84
85
  PublicChangelogMarkdown: ['changelog.publicMarkdown', { whole: 'GET ~P/changelog/changelog.md', search: 'GET ~P/changelog/search p' }],
85
86
  PublicChangelogWidget: ['changelog.publicWidget', { get: 'GET ~P/changelog/widget', hit: 'POST ~P/changelog/widget/hit', watching: 'GET ~P/changelog/watch', watch: 'PUT ~P/changelog/watch', unwatch: 'DELETE ~P/changelog/watch' }],
@@ -152,7 +153,6 @@ exports.OPERATIONS = {
152
153
  MyCoursePaths: ['courses.myPaths', { mine: 'GET ~o/me/course-paths p' }],
153
154
  CourseOffers: ['courses.offers', { list: 'GET ~s/course/offers p', create: 'POST ~s/course/offers', update: 'PUT ~s/course/offers/{offerId}', remove: 'DELETE ~s/course/offers/{offerId}', bulk: 'POST ~s/course/coupons/bulk', earnings: 'GET ~s/course/earnings', instructors: 'PUT ~s/course/instructors', patchInstructors: 'PATCH ~s/course/instructors', payout: 'POST ~s/course/payouts', rev: 'GET ~s/course/revenue', csv: 'GET ~s/course/revenue/export.csv', delete: '=remove DELETE ~s/course/offers/{offerId}' }],
154
155
  CoursePackageFiles: ['courses.packageFiles', { file: 'GET /course-packages/{id}/{token}/{p0} b', fileDepth2: 'GET /course-packages/{id}/{token}/{p0}/{p1} b', fileDepth3: 'GET /course-packages/{id}/{token}/{p0}/{p1}/{p2} b', fileDepth4: 'GET /course-packages/{id}/{token}/{p0}/{p1}/{p2}/{p3} b', fileDepth5: 'GET /course-packages/{id}/{token}/{p0}/{p1}/{p2}/{p3}/{p4} b', fileDepth6: 'GET /course-packages/{id}/{token}/{p0}/{p1}/{p2}/{p3}/{p4}/{p5} b', fileDepth7: 'GET /course-packages/{id}/{token}/{p0}/{p1}/{p2}/{p3}/{p4}/{p5}/{p6} b', fileDepth8: 'GET /course-packages/{id}/{token}/{p0}/{p1}/{p2}/{p3}/{p4}/{p5}/{p6}/{p7} b', fileDepth9: 'GET /course-packages/{id}/{token}/{p0}/{p1}/{p2}/{p3}/{p4}/{p5}/{p6}/{p7}/{p8} b', fileDepth10: 'GET /course-packages/{id}/{token}/{p0}/{p1}/{p2}/{p3}/{p4}/{p5}/{p6}/{p7}/{p8}/{p9} b', putStatements: 'PUT /course-xapi/{id}/{token}/statements', statements: 'POST /course-xapi/{id}/{token}/statements', fetch: 'POST /course-xapi/{id}/{token}/fetch', launchData: 'GET /course-xapi/{id}/{token}/activities/state', saveState: 'PUT /course-xapi/{id}/{token}/activities/state' }],
155
- CoursePackageFilesController: ['courses.packageFilesController', { 'preflight[0]': 'OPTIONS /course-xapi/{id}/{token}/statements', 'preflight[1]': 'OPTIONS /course-xapi/{id}/{token}/fetch', 'preflight[2]': 'OPTIONS /course-xapi/{id}/{token}/activities/state' }],
156
156
  CoursePackages: ['courses.packages', { upload: 'POST ~s/course/lessons/{slug}/package m', launch: 'GET ~s/course/lessons/{slug}/package', commit: 'POST ~s/course/packages/{packageId}/state' }],
157
157
  CoursePaths: ['courses.paths', { list: 'GET ~o/course-paths p', create: 'POST ~o/course-paths', replace: 'PUT ~o/course-paths/{pathId}', remove: 'DELETE ~o/course-paths/{pathId}', delete: '=remove DELETE ~o/course-paths/{pathId}' }],
158
158
  CoursePublic: ['courses.public', { outline: 'GET ~P/course/outline' }],
@@ -358,9 +358,11 @@ exports.OPERATIONS = {
358
358
  OauthToken: ['oauthToken', { token: 'POST /v1/oauth/token' }],
359
359
  ObjectSchema: ['objectSchema', { site: 'GET ~o/sites/{siteId}/config/schema', space: 'GET ~s/config/schema' }],
360
360
  OpenApi: ['openapi', { listSpecs: 'GET ~s/docs/openapi/specs p', registerSpec: 'POST ~s/docs/openapi/specs', resyncSpec: 'POST ~s/docs/openapi/specs/{id}/resync', resyncStatus: 'GET ~s/docs/openapi/specs/{id}/resync/{jobId}', specReference: 'GET ~s/docs/openapi/specs/{id}/reference', removeSpec: 'DELETE ~s/docs/openapi/specs/{id}', sdkLanguages: 'GET ~s/docs/openapi/sdk/languages p', specSdk: 'GET ~s/docs/openapi/specs/{id}/sdk/{language}', specSdkPackage: 'GET ~s/docs/openapi/specs/{id}/sdk/{language}/package b', specLint: 'GET ~s/docs/openapi/specs/{id}/lint', lintUrl: 'POST ~s/docs/openapi/lint', operations: 'POST ~s/docs/openapi/operations', resolve: 'POST ~s/docs/openapi/resolve', generate: 'POST ~s/docs/openapi/generate', generateStatus: 'GET ~s/docs/openapi/generate/{jobId}', import: 'POST ~s/docs/openapi/import', importFile: 'POST ~s/docs/openapi/import-file' }],
361
+ OpenApiAutoResync: ['openapi.autoResync', { state: 'GET ~s/docs/openapi/specs/{id}/auto-resync', configure: 'PUT ~s/docs/openapi/specs/{id}/auto-resync' }],
361
362
  OpenApiProxy: ['openapi.proxy', { forward: 'POST ~P/openapi-proxy' }],
362
363
  OpenApiExportPublic: ['openapi.publicExport', { spec: 'GET ~P/api-export/spec', collection: 'GET ~P/api-export/collections/{kind}', mock: 'GET ~P/api-export/mock-server b' }],
363
364
  OpenApiSdkPublic: ['openapi.publicSdk', { languages: 'GET ~P/sdk/languages p', download: 'GET ~P/sdk/{language}', downloadPackage: 'GET ~P/sdk/{language}/package b' }],
365
+ OpenApiResyncHook: ['openapi.resyncHook', { trigger: 'POST /hooks/openapi/{orgId}/specs/{specId}' }],
364
366
  SdkPublishing: ['openapi.sdkPublishing', { listRegistries: 'GET ~o/sdk/registries p', getRegistry: 'GET ~o/sdk/registries/{registry}', setRegistry: 'PUT ~o/sdk/registries/{registry}', patchRegistry: 'PATCH ~o/sdk/registries/{registry}', deleteRegistry: 'DELETE ~o/sdk/registries/{registry}', testRegistry: 'POST ~o/sdk/registries/{registry}/test', registerPackage: 'POST ~s/docs/openapi/specs/{specId}/sdk/{language}/register', listPackages: 'GET ~s/sdk/packages p', publish: 'POST ~o/sdk/packages/{packageId}/publish', listPublishes: 'GET ~o/sdk/packages/{packageId}/publishes p' }],
365
367
  OperatorIssuers: ['operatorIssuers', { list: 'GET ~o/operator-issuers p', create: 'POST ~o/operator-issuers', remove: 'DELETE ~o/operator-issuers/{issuerId}', link: 'POST ~o/operator-issuers/{issuerId}/link', delete: '=remove DELETE ~o/operator-issuers/{issuerId}' }],
366
368
  Org: ['orgs', { emailSettings: 'GET ~o/email-settings', setEmailFrom: 'PATCH ~o/email-from', emailBranding: 'GET ~o/email-branding', setEmailBranding: 'PATCH ~o/email-branding', legalStatus: 'GET ~o/legal', upsertLegal: 'POST ~o/legal', legalEmbedAcceptances: 'GET ~o/legal/{kind}/acceptances', legalAcceptanceGate: 'GET ~o/legal/acceptance', setLegalAcceptanceGate: 'PUT ~o/legal/acceptance', legalEditionDiff: 'GET ~o/legal/{kind}/diff', setLegalEditionNote: 'PUT ~o/legal/{kind}/editions/{version}', legalEmbedAcceptancesCsv: 'GET ~o/legal/{kind}/acceptances.csv t', bindLegalPage: 'POST ~o/legal/bind', unbindLegal: 'DELETE ~o/legal/{kind}', suggestedLegal: 'GET ~o/legal/suggested p', reorderLegal: 'POST ~o/legal/reorder', acceptLegal: 'POST ~o/legal/{documentId}/accept', plan: 'GET ~o/plan', setPlan: 'PATCH ~o/plan', setOverride: 'PATCH ~o/plan/overrides', export: 'GET ~o/export', import: 'POST ~o/import', create: 'POST /orgs', list: 'GET /orgs p', renameSlug: 'PATCH ~o/slug', get: 'GET ~o', update: 'PATCH ~o', remove: 'DELETE ~o', getSiem: 'GET ~o/siem', setSiem: 'PUT ~o/siem', patchSiem: 'PATCH ~o/siem', delete: '=remove DELETE ~o' }],
@@ -480,12 +482,14 @@ exports.OPERATIONS = {
480
482
  SiteFrontPage: ['sites.frontPage', { get: 'GET ~o/sites/{siteId}/front-page', set: 'PUT ~o/sites/{siteId}/front-page', patch: 'PATCH ~o/sites/{siteId}/front-page', remove: 'DELETE ~o/sites/{siteId}/front-page', delete: '=remove DELETE ~o/sites/{siteId}/front-page', update: '=patch PATCH ~o/sites/{siteId}/front-page' }],
481
483
  SiteImport: ['sites.import', { zip: 'POST ~s/site-import/zip m', url: 'POST ~s/site-import/url' }],
482
484
  SiteLabels: ['sites.labels', { strings: 'GET ~o/sites/{siteId}/i18n/strings', labels: 'GET ~o/sites/{siteId}/i18n/labels', replace: 'PUT ~o/sites/{siteId}/i18n/labels', merge: 'PATCH ~o/sites/{siteId}/i18n/labels' }],
485
+ SiteMachineFiles: ['sites.machineFiles', { getRobots: 'GET ~o/sites/{siteId}/robots', setRobots: 'PUT ~o/sites/{siteId}/robots', patchRobots: 'PATCH ~o/sites/{siteId}/robots', getLlms: 'GET ~o/sites/{siteId}/llms', setLlms: 'PUT ~o/sites/{siteId}/llms', patchLlms: 'PATCH ~o/sites/{siteId}/llms' }],
483
486
  SitePreview: ['sites.preview', { list: 'GET ~o/sites/{siteId}/preview-tokens p', mint: 'POST ~o/sites/{siteId}/preview-tokens', rotate: 'POST ~o/sites/{siteId}/preview-tokens/{tokenId}/rotate', revoke: 'DELETE ~o/sites/{siteId}/preview-tokens/{tokenId}' }],
484
487
  PublicSite: ['sites.public', { overview: 'GET /public/orgs/{orgId}/sites/{slug}', search: 'GET /public/orgs/{orgId}/sites/{slug}/search', ask: 'POST /public/orgs/{orgId}/sites/{slug}/ask' }],
485
488
  SiteConsentPublic: ['sites.publicConsent', { resolved: 'GET /public/orgs/{orgId}/sites/{siteSlug}/consent' }],
486
489
  SiteReaderAuth: ['sites.readerAuth', { get: 'GET ~o/sites/{siteId}/reader-auth', set: 'PUT ~o/sites/{siteId}/reader-auth', patch: 'PATCH ~o/sites/{siteId}/reader-auth', remove: 'DELETE ~o/sites/{siteId}/reader-auth', delete: '=remove DELETE ~o/sites/{siteId}/reader-auth', update: '=patch PATCH ~o/sites/{siteId}/reader-auth' }],
487
490
  SiteReaderPolicy: ['sites.readerPolicy', { getLegalGate: 'GET ~o/sites/{siteId}/legal-gate', setLegalGate: 'PUT ~o/sites/{siteId}/legal-gate', removeLegalGate: 'DELETE ~o/sites/{siteId}/legal-gate', getReaderIdentity: 'GET ~o/sites/{siteId}/reader-identity', setReaderIdentity: 'PUT ~o/sites/{siteId}/reader-identity', removeReaderIdentity: 'DELETE ~o/sites/{siteId}/reader-identity' }],
488
491
  SiteRobots: ['sites.robots', { robots: 'GET /public/orgs/{orgId}/sites/{siteSlug}/robots.txt' }],
492
+ SiteRobotsPreview: ['sites.robotsPreview', { preview: 'POST ~o/sites/{siteId}/robots/preview' }],
489
493
  SiteSearch: ['sites.search', { suggest: 'GET /public/orgs/{orgId}/sites/{slug}/search/suggest', ask: 'POST /public/orgs/{orgId}/sites/{slug}/search/answer', event: 'POST /public/orgs/{orgId}/sites/{slug}/search-events' }],
490
494
  SiteSettings: ['sites.settings', { getSeo: 'GET ~o/sites/{siteId}/seo', setSeo: 'PUT ~o/sites/{siteId}/seo', patchSeo: 'PATCH ~o/sites/{siteId}/seo', getAnalytics: 'GET ~o/sites/{siteId}/analytics-tags', setAnalytics: 'PUT ~o/sites/{siteId}/analytics-tags', getComments: 'GET ~o/sites/{siteId}/comment-settings', setComments: 'PUT ~o/sites/{siteId}/comment-settings', getDiscovery: 'GET ~o/sites/{siteId}/discovery', setDiscovery: 'PUT ~o/sites/{siteId}/discovery', getAi: 'GET ~o/sites/{siteId}/ai-settings', setAi: 'PUT ~o/sites/{siteId}/ai-settings', getReaderThemes: 'GET ~o/sites/{siteId}/reader-themes p', setReaderThemes: 'PUT ~o/sites/{siteId}/reader-themes', getVisitorAuth: 'GET ~o/sites/{siteId}/visitor-auth', setVisitorAuth: 'PUT ~o/sites/{siteId}/visitor-auth', themeOrigins: 'GET ~o/sites/{siteId}/theme/origins', removeThemeOrigin: 'DELETE ~o/sites/{siteId}/theme/origins/{origin}', restoreThemeOrigin: 'POST ~o/sites/{siteId}/theme/origins/{origin}' }],
491
495
  SpaceSnapshot: ['snapshots', { list: 'GET ~s/snapshots p', create: 'POST ~s/snapshots', restore: 'POST ~s/snapshots/{id}/restore', remove: 'DELETE ~s/snapshots/{id}', delete: '=remove DELETE ~s/snapshots/{id}' }],
package/dist/schema.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  [diffend] Oversized file quarantined before diffing.
2
2
  name: package/dist/schema.d.ts
3
- size: 34908034 bytes
4
- sha256: 5bba4965271a2132ae626fa786e7c85ee86475645998ce4ccda9db2396040f52
3
+ size: 34702332 bytes
4
+ sha256: 861c073c09e845a2ba396ebe1adb7a51c8f8d6b89c64dcb964753f3c0cd26c98
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forumulate/sdk",
3
- "version": "0.11.0",
3
+ "version": "0.11.1",
4
4
  "description": "Typed TypeScript client for the Forumulate REST API.",
5
5
  "license": "MIT",
6
6
  "homepage": "https://forumulate.com/reference",