@steamsets/client-ts 0.33.1 → 0.33.3

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.
Files changed (86) hide show
  1. package/README.md +4 -0
  2. package/funcs/adminCmsDelete.d.ts +19 -0
  3. package/funcs/adminCmsDelete.d.ts.map +1 -0
  4. package/funcs/adminCmsDelete.js +135 -0
  5. package/funcs/adminCmsDelete.js.map +1 -0
  6. package/funcs/leaderboardLeaderboardGetChanges.d.ts +16 -0
  7. package/funcs/leaderboardLeaderboardGetChanges.d.ts.map +1 -0
  8. package/funcs/leaderboardLeaderboardGetChanges.js +134 -0
  9. package/funcs/leaderboardLeaderboardGetChanges.js.map +1 -0
  10. package/jsr.json +1 -1
  11. package/lib/config.d.ts +2 -2
  12. package/lib/config.js +2 -2
  13. package/models/components/index.d.ts +4 -0
  14. package/models/components/index.d.ts.map +1 -1
  15. package/models/components/index.js +4 -0
  16. package/models/components/index.js.map +1 -1
  17. package/models/components/leaderboardchange.d.ts +19 -0
  18. package/models/components/leaderboardchange.d.ts.map +1 -0
  19. package/models/components/leaderboardchange.js +59 -0
  20. package/models/components/leaderboardchange.js.map +1 -0
  21. package/models/components/leaderboardgetchangesrequestbody.d.ts +104 -0
  22. package/models/components/leaderboardgetchangesrequestbody.d.ts.map +1 -0
  23. package/models/components/leaderboardgetchangesrequestbody.js +109 -0
  24. package/models/components/leaderboardgetchangesrequestbody.js.map +1 -0
  25. package/models/components/leaderboardgetchangesresponsebody.d.ts +15 -0
  26. package/models/components/leaderboardgetchangesresponsebody.d.ts.map +1 -0
  27. package/models/components/leaderboardgetchangesresponsebody.js +57 -0
  28. package/models/components/leaderboardgetchangesresponsebody.js.map +1 -0
  29. package/models/components/v1admincmscreaterequestbody.d.ts +1 -16
  30. package/models/components/v1admincmscreaterequestbody.d.ts.map +1 -1
  31. package/models/components/v1admincmscreaterequestbody.js +2 -15
  32. package/models/components/v1admincmscreaterequestbody.js.map +1 -1
  33. package/models/components/v1admincmsdeleterequestbody.d.ts +12 -0
  34. package/models/components/v1admincmsdeleterequestbody.d.ts.map +1 -0
  35. package/models/components/v1admincmsdeleterequestbody.js +54 -0
  36. package/models/components/v1admincmsdeleterequestbody.js.map +1 -0
  37. package/models/components/v1admincmsreorderrequestbody.d.ts +1 -16
  38. package/models/components/v1admincmsreorderrequestbody.d.ts.map +1 -1
  39. package/models/components/v1admincmsreorderrequestbody.js +2 -15
  40. package/models/components/v1admincmsreorderrequestbody.js.map +1 -1
  41. package/models/operations/cmsdelete.d.ts +11 -0
  42. package/models/operations/cmsdelete.d.ts.map +1 -0
  43. package/models/operations/cmsdelete.js +56 -0
  44. package/models/operations/cmsdelete.js.map +1 -0
  45. package/models/operations/cmslist.d.ts +1 -22
  46. package/models/operations/cmslist.d.ts.map +1 -1
  47. package/models/operations/cmslist.js +2 -18
  48. package/models/operations/cmslist.js.map +1 -1
  49. package/models/operations/index.d.ts +2 -0
  50. package/models/operations/index.d.ts.map +1 -1
  51. package/models/operations/index.js +2 -0
  52. package/models/operations/index.js.map +1 -1
  53. package/models/operations/leaderboardgetchanges.d.ts +15 -0
  54. package/models/operations/leaderboardgetchanges.d.ts.map +1 -0
  55. package/models/operations/leaderboardgetchanges.js +59 -0
  56. package/models/operations/leaderboardgetchanges.js.map +1 -0
  57. package/models/operations/list.d.ts +1 -22
  58. package/models/operations/list.d.ts.map +1 -1
  59. package/models/operations/list.js +2 -18
  60. package/models/operations/list.js.map +1 -1
  61. package/package.json +1 -1
  62. package/sdk/admin.d.ts +7 -0
  63. package/sdk/admin.d.ts.map +1 -1
  64. package/sdk/admin.js +10 -0
  65. package/sdk/admin.js.map +1 -1
  66. package/sdk/leaderboard.d.ts +4 -0
  67. package/sdk/leaderboard.d.ts.map +1 -1
  68. package/sdk/leaderboard.js +7 -0
  69. package/sdk/leaderboard.js.map +1 -1
  70. package/src/funcs/adminCmsDelete.ts +189 -0
  71. package/src/funcs/leaderboardLeaderboardGetChanges.ts +188 -0
  72. package/src/lib/config.ts +2 -2
  73. package/src/models/components/index.ts +4 -0
  74. package/src/models/components/leaderboardchange.ts +51 -0
  75. package/src/models/components/leaderboardgetchangesrequestbody.ts +147 -0
  76. package/src/models/components/leaderboardgetchangesresponsebody.ts +45 -0
  77. package/src/models/components/v1admincmscreaterequestbody.ts +2 -23
  78. package/src/models/components/v1admincmsdeleterequestbody.ts +38 -0
  79. package/src/models/components/v1admincmsreorderrequestbody.ts +2 -23
  80. package/src/models/operations/cmsdelete.ts +37 -0
  81. package/src/models/operations/cmslist.ts +2 -27
  82. package/src/models/operations/index.ts +2 -0
  83. package/src/models/operations/leaderboardgetchanges.ts +46 -0
  84. package/src/models/operations/list.ts +2 -27
  85. package/src/sdk/admin.ts +18 -0
  86. package/src/sdk/leaderboard.ts +15 -0
@@ -0,0 +1,38 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+
8
+ export type V1AdminCmsDeleteRequestBody = {
9
+ documentUid: string;
10
+ };
11
+
12
+ /** @internal */
13
+ export type V1AdminCmsDeleteRequestBody$Outbound = {
14
+ document_uid: string;
15
+ };
16
+
17
+ /** @internal */
18
+ export const V1AdminCmsDeleteRequestBody$outboundSchema: z.ZodType<
19
+ V1AdminCmsDeleteRequestBody$Outbound,
20
+ z.ZodTypeDef,
21
+ V1AdminCmsDeleteRequestBody
22
+ > = z.object({
23
+ documentUid: z.string(),
24
+ }).transform((v) => {
25
+ return remap$(v, {
26
+ documentUid: "document_uid",
27
+ });
28
+ });
29
+
30
+ export function v1AdminCmsDeleteRequestBodyToJSON(
31
+ v1AdminCmsDeleteRequestBody: V1AdminCmsDeleteRequestBody,
32
+ ): string {
33
+ return JSON.stringify(
34
+ V1AdminCmsDeleteRequestBody$outboundSchema.parse(
35
+ v1AdminCmsDeleteRequestBody,
36
+ ),
37
+ );
38
+ }
@@ -3,38 +3,17 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod/v3";
6
- import { ClosedEnum } from "../../types/enums.js";
7
6
  import {
8
7
  ReorderItemReq,
9
8
  ReorderItemReq$Outbound,
10
9
  ReorderItemReq$outboundSchema,
11
10
  } from "./reorderitemreq.js";
12
11
 
13
- export const V1AdminCmsReorderRequestBodyType = {
14
- NavItem: "nav_item",
15
- Faq: "faq",
16
- Partner: "partner",
17
- FooterCategory: "footer_category",
18
- FooterLink: "footer_link",
19
- DonateFeature: "donate_feature",
20
- RoleMeta: "role_meta",
21
- StaffText: "staff_text",
22
- Page: "page",
23
- } as const;
24
- export type V1AdminCmsReorderRequestBodyType = ClosedEnum<
25
- typeof V1AdminCmsReorderRequestBodyType
26
- >;
27
-
28
12
  export type V1AdminCmsReorderRequestBody = {
29
13
  items: Array<ReorderItemReq> | null;
30
- type: V1AdminCmsReorderRequestBodyType;
14
+ type: string;
31
15
  };
32
16
 
33
- /** @internal */
34
- export const V1AdminCmsReorderRequestBodyType$outboundSchema: z.ZodNativeEnum<
35
- typeof V1AdminCmsReorderRequestBodyType
36
- > = z.nativeEnum(V1AdminCmsReorderRequestBodyType);
37
-
38
17
  /** @internal */
39
18
  export type V1AdminCmsReorderRequestBody$Outbound = {
40
19
  items: Array<ReorderItemReq$Outbound> | null;
@@ -48,7 +27,7 @@ export const V1AdminCmsReorderRequestBody$outboundSchema: z.ZodType<
48
27
  V1AdminCmsReorderRequestBody
49
28
  > = z.object({
50
29
  items: z.nullable(z.array(ReorderItemReq$outboundSchema)),
51
- type: V1AdminCmsReorderRequestBodyType$outboundSchema,
30
+ type: z.string(),
52
31
  });
53
32
 
54
33
  export function v1AdminCmsReorderRequestBodyToJSON(
@@ -0,0 +1,37 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import * as components from "../components/index.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+
12
+ export type CmsDeleteResponse = {
13
+ httpMeta: components.HTTPMetadata;
14
+ };
15
+
16
+ /** @internal */
17
+ export const CmsDeleteResponse$inboundSchema: z.ZodType<
18
+ CmsDeleteResponse,
19
+ z.ZodTypeDef,
20
+ unknown
21
+ > = z.object({
22
+ HttpMeta: components.HTTPMetadata$inboundSchema,
23
+ }).transform((v) => {
24
+ return remap$(v, {
25
+ "HttpMeta": "httpMeta",
26
+ });
27
+ });
28
+
29
+ export function cmsDeleteResponseFromJSON(
30
+ jsonString: string,
31
+ ): SafeParseResult<CmsDeleteResponse, SDKValidationError> {
32
+ return safeParse(
33
+ jsonString,
34
+ (x) => CmsDeleteResponse$inboundSchema.parse(JSON.parse(x)),
35
+ `Failed to parse 'CmsDeleteResponse' from JSON`,
36
+ );
37
+ }
@@ -5,35 +5,15 @@
5
5
  import * as z from "zod/v3";
6
6
  import { remap as remap$ } from "../../lib/primitives.js";
7
7
  import { safeParse } from "../../lib/schemas.js";
8
- import { ClosedEnum } from "../../types/enums.js";
9
8
  import { Result as SafeParseResult } from "../../types/fp.js";
10
9
  import * as components from "../components/index.js";
11
10
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
12
11
 
13
- /**
14
- * Document type
15
- */
16
- export const Type = {
17
- NavItem: "nav_item",
18
- Faq: "faq",
19
- Partner: "partner",
20
- FooterCategory: "footer_category",
21
- FooterLink: "footer_link",
22
- DonateFeature: "donate_feature",
23
- RoleMeta: "role_meta",
24
- StaffText: "staff_text",
25
- Page: "page",
26
- } as const;
27
- /**
28
- * Document type
29
- */
30
- export type Type = ClosedEnum<typeof Type>;
31
-
32
12
  export type CmsListRequest = {
33
13
  /**
34
14
  * Document type
35
15
  */
36
- type: Type;
16
+ type: string;
37
17
  };
38
18
 
39
19
  export type CmsListResponse = {
@@ -46,11 +26,6 @@ export type CmsListResponse = {
46
26
  | undefined;
47
27
  };
48
28
 
49
- /** @internal */
50
- export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
51
- Type,
52
- );
53
-
54
29
  /** @internal */
55
30
  export type CmsListRequest$Outbound = {
56
31
  type: string;
@@ -62,7 +37,7 @@ export const CmsListRequest$outboundSchema: z.ZodType<
62
37
  z.ZodTypeDef,
63
38
  CmsListRequest
64
39
  > = z.object({
65
- type: Type$outboundSchema,
40
+ type: z.string(),
66
41
  });
67
42
 
68
43
  export function cmsListRequestToJSON(cmsListRequest: CmsListRequest): string {
@@ -58,6 +58,7 @@ export * from "./badgesuggesttags.js";
58
58
  export * from "./badgetagbadge.js";
59
59
  export * from "./cmsarchive.js";
60
60
  export * from "./cmscreate.js";
61
+ export * from "./cmsdelete.js";
61
62
  export * from "./cmslist.js";
62
63
  export * from "./cmslistassets.js";
63
64
  export * from "./cmspreviewtoken.js";
@@ -68,6 +69,7 @@ export * from "./cmsuploadimage.js";
68
69
  export * from "./cmsversions.js";
69
70
  export * from "./leaderboardgetaccountleaderboard.js";
70
71
  export * from "./leaderboardgetaccountsmeta.js";
72
+ export * from "./leaderboardgetchanges.js";
71
73
  export * from "./leaderboardgetgroupleaderboard.js";
72
74
  export * from "./leaderboardgetgroupsmeta.js";
73
75
  export * from "./leaderboardgetlowestranks.js";
@@ -0,0 +1,46 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import * as components from "../components/index.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+
12
+ export type LeaderboardGetChangesResponse = {
13
+ httpMeta: components.HTTPMetadata;
14
+ /**
15
+ * OK
16
+ */
17
+ leaderboardGetChangesResponseBody?:
18
+ | components.LeaderboardGetChangesResponseBody
19
+ | undefined;
20
+ };
21
+
22
+ /** @internal */
23
+ export const LeaderboardGetChangesResponse$inboundSchema: z.ZodType<
24
+ LeaderboardGetChangesResponse,
25
+ z.ZodTypeDef,
26
+ unknown
27
+ > = z.object({
28
+ HttpMeta: components.HTTPMetadata$inboundSchema,
29
+ LeaderboardGetChangesResponseBody: components
30
+ .LeaderboardGetChangesResponseBody$inboundSchema.optional(),
31
+ }).transform((v) => {
32
+ return remap$(v, {
33
+ "HttpMeta": "httpMeta",
34
+ "LeaderboardGetChangesResponseBody": "leaderboardGetChangesResponseBody",
35
+ });
36
+ });
37
+
38
+ export function leaderboardGetChangesResponseFromJSON(
39
+ jsonString: string,
40
+ ): SafeParseResult<LeaderboardGetChangesResponse, SDKValidationError> {
41
+ return safeParse(
42
+ jsonString,
43
+ (x) => LeaderboardGetChangesResponse$inboundSchema.parse(JSON.parse(x)),
44
+ `Failed to parse 'LeaderboardGetChangesResponse' from JSON`,
45
+ );
46
+ }
@@ -5,35 +5,15 @@
5
5
  import * as z from "zod/v3";
6
6
  import { remap as remap$ } from "../../lib/primitives.js";
7
7
  import { safeParse } from "../../lib/schemas.js";
8
- import { ClosedEnum } from "../../types/enums.js";
9
8
  import { Result as SafeParseResult } from "../../types/fp.js";
10
9
  import * as components from "../components/index.js";
11
10
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
12
11
 
13
- /**
14
- * Document type
15
- */
16
- export const QueryParamType = {
17
- NavItem: "nav_item",
18
- Faq: "faq",
19
- Partner: "partner",
20
- FooterCategory: "footer_category",
21
- FooterLink: "footer_link",
22
- DonateFeature: "donate_feature",
23
- RoleMeta: "role_meta",
24
- StaffText: "staff_text",
25
- Page: "page",
26
- } as const;
27
- /**
28
- * Document type
29
- */
30
- export type QueryParamType = ClosedEnum<typeof QueryParamType>;
31
-
32
12
  export type ListRequest = {
33
13
  /**
34
14
  * Document type
35
15
  */
36
- type: QueryParamType;
16
+ type: string;
37
17
  /**
38
18
  * Locale code (e.g. en, de). Defaults to en.
39
19
  */
@@ -52,11 +32,6 @@ export type ListResponse = {
52
32
  v1CmsListResponseBody?: components.V1CmsListResponseBody | undefined;
53
33
  };
54
34
 
55
- /** @internal */
56
- export const QueryParamType$outboundSchema: z.ZodNativeEnum<
57
- typeof QueryParamType
58
- > = z.nativeEnum(QueryParamType);
59
-
60
35
  /** @internal */
61
36
  export type ListRequest$Outbound = {
62
37
  type: string;
@@ -70,7 +45,7 @@ export const ListRequest$outboundSchema: z.ZodType<
70
45
  z.ZodTypeDef,
71
46
  ListRequest
72
47
  > = z.object({
73
- type: QueryParamType$outboundSchema,
48
+ type: z.string(),
74
49
  locale: z.string().optional(),
75
50
  preview: z.string().optional(),
76
51
  });
package/src/sdk/admin.ts CHANGED
@@ -5,6 +5,7 @@
5
5
  import { adminAdminUpdateRoleOverride } from "../funcs/adminAdminUpdateRoleOverride.js";
6
6
  import { adminCmsArchive } from "../funcs/adminCmsArchive.js";
7
7
  import { adminCmsCreate } from "../funcs/adminCmsCreate.js";
8
+ import { adminCmsDelete } from "../funcs/adminCmsDelete.js";
8
9
  import { adminCmsList } from "../funcs/adminCmsList.js";
9
10
  import { adminCmsListAssets } from "../funcs/adminCmsListAssets.js";
10
11
  import { adminCmsPreviewToken } from "../funcs/adminCmsPreviewToken.js";
@@ -51,6 +52,23 @@ export class Admin extends ClientSDK {
51
52
  ));
52
53
  }
53
54
 
55
+ /**
56
+ * Permanently delete a CMS document and all its versions
57
+ *
58
+ * @remarks
59
+ * Hard delete: removes the cms_document row + every cms_document_version row pointing at it. Irreversible. Public reads stay correct because the type cache is invalidated. The CMS admin UI should restrict this to archived documents to give staff one extra step before destruction.
60
+ */
61
+ async cmsDelete(
62
+ request: components.V1AdminCmsDeleteRequestBody,
63
+ options?: RequestOptions,
64
+ ): Promise<operations.CmsDeleteResponse> {
65
+ return unwrapAsync(adminCmsDelete(
66
+ this,
67
+ request,
68
+ options,
69
+ ));
70
+ }
71
+
54
72
  /**
55
73
  * List CMS documents (drafts + published) for editor
56
74
  */
@@ -7,6 +7,7 @@ import { leaderboardGetAccountsMeta } from "../funcs/leaderboardGetAccountsMeta.
7
7
  import { leaderboardGetGroup } from "../funcs/leaderboardGetGroup.js";
8
8
  import { leaderboardGetGroupsMeta } from "../funcs/leaderboardGetGroupsMeta.js";
9
9
  import { leaderboardGetLowestRanks } from "../funcs/leaderboardGetLowestRanks.js";
10
+ import { leaderboardLeaderboardGetChanges } from "../funcs/leaderboardLeaderboardGetChanges.js";
10
11
  import { leaderboardPreviewAccountRank } from "../funcs/leaderboardPreviewAccountRank.js";
11
12
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
12
13
  import * as components from "../models/components/index.js";
@@ -42,6 +43,20 @@ export class Leaderboard extends ClientSDK {
42
43
  ));
43
44
  }
44
45
 
46
+ /**
47
+ * Top movers in a windowed delta on a leaderboard
48
+ */
49
+ async leaderboardGetChanges(
50
+ request: components.LeaderboardGetChangesRequestBody,
51
+ options?: RequestOptions,
52
+ ): Promise<operations.LeaderboardGetChangesResponse> {
53
+ return unwrapAsync(leaderboardLeaderboardGetChanges(
54
+ this,
55
+ request,
56
+ options,
57
+ ));
58
+ }
59
+
45
60
  /**
46
61
  * Get group leaderboard
47
62
  */