@taskeren/bungie-api-ts 5.10.0 → 5.10.2

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 (162) hide show
  1. package/package.json +66 -27
  2. package/.babelrc +0 -4
  3. package/.gitattributes +0 -2
  4. package/.github/workflows/pr-build.yml +0 -50
  5. package/.github/workflows/publish.yml +0 -48
  6. package/.github/workflows/update.yml +0 -55
  7. package/.gitmodules +0 -3
  8. package/.nvmrc +0 -1
  9. package/.prettierrc +0 -10
  10. package/.vscode/extensions.json +0 -8
  11. package/.vscode/settings.json +0 -7
  12. package/LICENSE.md +0 -21
  13. package/api-src/.github/workflows/close-inactive.yml +0 -24
  14. package/api-src/CHANGELOG.md +0 -271
  15. package/api-src/CONTRIBUTING.md +0 -19
  16. package/api-src/LICENSE +0 -28
  17. package/api-src/README.md +0 -378
  18. package/api-src/openapi-2.json +0 -44518
  19. package/api-src/openapi.json +0 -46467
  20. package/build.sh +0 -30
  21. package/generated-src/app/api.ts +0 -50
  22. package/generated-src/app/index.ts +0 -17
  23. package/generated-src/app/interfaces.ts +0 -119
  24. package/generated-src/common.ts +0 -985
  25. package/generated-src/communitycontent/api.ts +0 -36
  26. package/generated-src/communitycontent/index.ts +0 -16
  27. package/generated-src/content/api.ts +0 -142
  28. package/generated-src/content/index.ts +0 -17
  29. package/generated-src/content/interfaces.ts +0 -225
  30. package/generated-src/core/api.ts +0 -57
  31. package/generated-src/core/index.ts +0 -17
  32. package/generated-src/core/interfaces.ts +0 -151
  33. package/generated-src/destiny2/api.ts +0 -821
  34. package/generated-src/destiny2/index.ts +0 -17
  35. package/generated-src/destiny2/interfaces.ts +0 -15714
  36. package/generated-src/destiny2/manifest.ts +0 -341
  37. package/generated-src/fireteam/api.ts +0 -151
  38. package/generated-src/fireteam/index.ts +0 -17
  39. package/generated-src/fireteam/interfaces.ts +0 -183
  40. package/generated-src/forum/api.ts +0 -197
  41. package/generated-src/forum/index.ts +0 -17
  42. package/generated-src/forum/interfaces.ts +0 -171
  43. package/generated-src/groupv2/api.ts +0 -515
  44. package/generated-src/groupv2/index.ts +0 -17
  45. package/generated-src/groupv2/interfaces.ts +0 -773
  46. package/generated-src/http.ts +0 -52
  47. package/generated-src/index.ts +0 -37
  48. package/generated-src/package.json.notyet +0 -99
  49. package/generated-src/platform.ts +0 -39
  50. package/generated-src/social/api.ts +0 -115
  51. package/generated-src/social/index.ts +0 -17
  52. package/generated-src/social/interfaces.ts +0 -89
  53. package/generated-src/tokens/api.ts +0 -126
  54. package/generated-src/tokens/index.ts +0 -17
  55. package/generated-src/tokens/interfaces.ts +0 -102
  56. package/generated-src/trending/api.ts +0 -62
  57. package/generated-src/trending/index.ts +0 -17
  58. package/generated-src/trending/interfaces.ts +0 -188
  59. package/generated-src/user/api.ts +0 -130
  60. package/generated-src/user/index.ts +0 -17
  61. package/generated-src/user/interfaces.ts +0 -338
  62. package/generator/generate-api.ts +0 -254
  63. package/generator/generate-common.ts +0 -123
  64. package/generator/generate-index.ts +0 -45
  65. package/generator/generate-interfaces.ts +0 -173
  66. package/generator/generate-manifest.ts +0 -217
  67. package/generator/generate-package-json.ts +0 -45
  68. package/generator/generate.ts +0 -54
  69. package/generator/http.ts +0 -52
  70. package/generator/missing-props.ts +0 -11
  71. package/generator/type-index.ts +0 -184
  72. package/generator/util.ts +0 -131
  73. package/lib/README.md +0 -97
  74. package/lib/bungie-api-LICENSE +0 -29
  75. package/lib/package.json +0 -99
  76. package/test-consumer.ts +0 -5
  77. package/tests/__snapshots__/config-builders.test.ts.snap +0 -343
  78. package/tests/config-builders.test.ts +0 -145
  79. package/tests/manifest-fetcher.test.ts +0 -43
  80. package/tests/test-manifest.js +0 -69
  81. package/tsconfig-package.json +0 -14
  82. package/tsconfig.json +0 -17
  83. /package/{lib/app → app}/api.d.ts +0 -0
  84. /package/{lib/app → app}/api.js +0 -0
  85. /package/{lib/app → app}/index.d.ts +0 -0
  86. /package/{lib/app → app}/index.js +0 -0
  87. /package/{lib/app → app}/interfaces.d.ts +0 -0
  88. /package/{lib/app → app}/interfaces.js +0 -0
  89. /package/{lib/common.d.ts → common.d.ts} +0 -0
  90. /package/{lib/common.js → common.js} +0 -0
  91. /package/{lib/communitycontent → communitycontent}/api.d.ts +0 -0
  92. /package/{lib/communitycontent → communitycontent}/api.js +0 -0
  93. /package/{lib/communitycontent → communitycontent}/index.d.ts +0 -0
  94. /package/{lib/communitycontent → communitycontent}/index.js +0 -0
  95. /package/{lib/content → content}/api.d.ts +0 -0
  96. /package/{lib/content → content}/api.js +0 -0
  97. /package/{lib/content → content}/index.d.ts +0 -0
  98. /package/{lib/content → content}/index.js +0 -0
  99. /package/{lib/content → content}/interfaces.d.ts +0 -0
  100. /package/{lib/content → content}/interfaces.js +0 -0
  101. /package/{lib/core → core}/api.d.ts +0 -0
  102. /package/{lib/core → core}/api.js +0 -0
  103. /package/{lib/core → core}/index.d.ts +0 -0
  104. /package/{lib/core → core}/index.js +0 -0
  105. /package/{lib/core → core}/interfaces.d.ts +0 -0
  106. /package/{lib/core → core}/interfaces.js +0 -0
  107. /package/{lib/destiny2 → destiny2}/api.d.ts +0 -0
  108. /package/{lib/destiny2 → destiny2}/api.js +0 -0
  109. /package/{lib/destiny2 → destiny2}/index.d.ts +0 -0
  110. /package/{lib/destiny2 → destiny2}/index.js +0 -0
  111. /package/{lib/destiny2 → destiny2}/interfaces.d.ts +0 -0
  112. /package/{lib/destiny2 → destiny2}/interfaces.js +0 -0
  113. /package/{lib/destiny2 → destiny2}/manifest.d.ts +0 -0
  114. /package/{lib/destiny2 → destiny2}/manifest.js +0 -0
  115. /package/{lib/fireteam → fireteam}/api.d.ts +0 -0
  116. /package/{lib/fireteam → fireteam}/api.js +0 -0
  117. /package/{lib/fireteam → fireteam}/index.d.ts +0 -0
  118. /package/{lib/fireteam → fireteam}/index.js +0 -0
  119. /package/{lib/fireteam → fireteam}/interfaces.d.ts +0 -0
  120. /package/{lib/fireteam → fireteam}/interfaces.js +0 -0
  121. /package/{lib/forum → forum}/api.d.ts +0 -0
  122. /package/{lib/forum → forum}/api.js +0 -0
  123. /package/{lib/forum → forum}/index.d.ts +0 -0
  124. /package/{lib/forum → forum}/index.js +0 -0
  125. /package/{lib/forum → forum}/interfaces.d.ts +0 -0
  126. /package/{lib/forum → forum}/interfaces.js +0 -0
  127. /package/{lib/groupv2 → groupv2}/api.d.ts +0 -0
  128. /package/{lib/groupv2 → groupv2}/api.js +0 -0
  129. /package/{lib/groupv2 → groupv2}/index.d.ts +0 -0
  130. /package/{lib/groupv2 → groupv2}/index.js +0 -0
  131. /package/{lib/groupv2 → groupv2}/interfaces.d.ts +0 -0
  132. /package/{lib/groupv2 → groupv2}/interfaces.js +0 -0
  133. /package/{lib/http.d.ts → http.d.ts} +0 -0
  134. /package/{lib/http.js → http.js} +0 -0
  135. /package/{lib/index.d.ts → index.d.ts} +0 -0
  136. /package/{lib/index.js → index.js} +0 -0
  137. /package/{lib/platform.d.ts → platform.d.ts} +0 -0
  138. /package/{lib/platform.js → platform.js} +0 -0
  139. /package/{lib/social → social}/api.d.ts +0 -0
  140. /package/{lib/social → social}/api.js +0 -0
  141. /package/{lib/social → social}/index.d.ts +0 -0
  142. /package/{lib/social → social}/index.js +0 -0
  143. /package/{lib/social → social}/interfaces.d.ts +0 -0
  144. /package/{lib/social → social}/interfaces.js +0 -0
  145. /package/{lib/tokens → tokens}/api.d.ts +0 -0
  146. /package/{lib/tokens → tokens}/api.js +0 -0
  147. /package/{lib/tokens → tokens}/index.d.ts +0 -0
  148. /package/{lib/tokens → tokens}/index.js +0 -0
  149. /package/{lib/tokens → tokens}/interfaces.d.ts +0 -0
  150. /package/{lib/tokens → tokens}/interfaces.js +0 -0
  151. /package/{lib/trending → trending}/api.d.ts +0 -0
  152. /package/{lib/trending → trending}/api.js +0 -0
  153. /package/{lib/trending → trending}/index.d.ts +0 -0
  154. /package/{lib/trending → trending}/index.js +0 -0
  155. /package/{lib/trending → trending}/interfaces.d.ts +0 -0
  156. /package/{lib/trending → trending}/interfaces.js +0 -0
  157. /package/{lib/user → user}/api.d.ts +0 -0
  158. /package/{lib/user → user}/api.js +0 -0
  159. /package/{lib/user → user}/index.d.ts +0 -0
  160. /package/{lib/user → user}/index.js +0 -0
  161. /package/{lib/user → user}/interfaces.d.ts +0 -0
  162. /package/{lib/user → user}/interfaces.js +0 -0
@@ -1,36 +0,0 @@
1
- /**
2
- * Bungie.Net API
3
- * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
4
- *
5
- * OpenAPI spec version: 2.21.9
6
- * Contact: support@bungie.com
7
- *
8
- * NOTE: This class is auto generated by the bungie-api-ts code generator program.
9
- * https://github.com/DestinyItemManager/bungie-api-ts
10
- * Do not edit these files manually.
11
- */
12
-
13
- import { HttpClient, get, post } from '../http.js';
14
-
15
- import {
16
- CommunityContentSortMode,
17
- ForumTopicsCategoryFiltersEnum,
18
- PostSearchResponse
19
- } from '../forum/interfaces.js';
20
- import {
21
- ServerResponse
22
- } from '../common.js';
23
-
24
- export interface GetCommunityContentParams {
25
- /** The type of media to get */
26
- mediaFilter: ForumTopicsCategoryFiltersEnum;
27
- /** Zero based page */
28
- page: number;
29
- /** The sort mode. */
30
- sort: CommunityContentSortMode;
31
- }
32
-
33
- /** Returns community content. */
34
- export function getCommunityContent(http: HttpClient, params: GetCommunityContentParams): Promise<ServerResponse<PostSearchResponse>> {
35
- return get(http, `https://www.bungie.net/Platform/CommunityContent/Get/${params.sort}/${params.mediaFilter}/${params.page}/`);
36
- }
@@ -1,16 +0,0 @@
1
- /**
2
- * Bungie.Net API
3
- * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
4
- *
5
- * OpenAPI spec version: 2.21.9
6
- * Contact: support@bungie.com
7
- *
8
- * NOTE: This class is auto generated by the bungie-api-ts code generator program.
9
- * https://github.com/DestinyItemManager/bungie-api-ts
10
- * Do not edit these files manually.
11
- */
12
-
13
- export * from '../common.js';
14
- export * from '../platform.js';
15
- export type {HttpClientConfig, HttpClient} from '../http.js';
16
- export * from './api.js';
@@ -1,142 +0,0 @@
1
- /**
2
- * Bungie.Net API
3
- * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
4
- *
5
- * OpenAPI spec version: 2.21.9
6
- * Contact: support@bungie.com
7
- *
8
- * NOTE: This class is auto generated by the bungie-api-ts code generator program.
9
- * https://github.com/DestinyItemManager/bungie-api-ts
10
- * Do not edit these files manually.
11
- */
12
-
13
- import { HttpClient, get, post } from '../http.js';
14
-
15
- import {
16
- ContentItemPublicContract,
17
- ContentTypeDescription,
18
- NewsArticleRssResponse,
19
- SearchResultOfContentItemPublicContract
20
- } from './interfaces.js';
21
- import {
22
- ServerResponse
23
- } from '../common.js';
24
-
25
- const API_BASE = "https://www.bungie.net/Platform/Content/";
26
-
27
- export interface GetContentTypeParams {
28
- type: string;
29
- }
30
-
31
- /** Gets an object describing a particular variant of content. */
32
- export function getContentType(http: HttpClient, params: GetContentTypeParams): Promise<ServerResponse<ContentTypeDescription>> {
33
- return get(http, `${API_BASE}GetContentType/${params.type}/`);
34
- }
35
-
36
- export interface GetContentByIdParams {
37
- /** false */
38
- head?: boolean;
39
- id: string;
40
- locale: string;
41
- }
42
-
43
- /** Returns a content item referenced by id */
44
- export function getContentById(http: HttpClient, params: GetContentByIdParams): Promise<ServerResponse<ContentItemPublicContract>> {
45
- const strParams: Record<string, string> = {};
46
- if (params.head !== undefined) { strParams.head = params.head.toString(); }
47
- return get(http, `${API_BASE}GetContentById/${params.id}/${params.locale}/`, strParams);
48
- }
49
-
50
- export interface GetContentByTagAndTypeParams {
51
- /** Not used. */
52
- head?: boolean;
53
- locale: string;
54
- tag: string;
55
- type: string;
56
- }
57
-
58
- /** Returns the newest item that matches a given tag and Content Type. */
59
- export function getContentByTagAndType(http: HttpClient, params: GetContentByTagAndTypeParams): Promise<ServerResponse<ContentItemPublicContract>> {
60
- const strParams: Record<string, string> = {};
61
- if (params.head !== undefined) { strParams.head = params.head.toString(); }
62
- return get(http, `${API_BASE}GetContentByTagAndType/${params.tag}/${params.type}/${params.locale}/`, strParams);
63
- }
64
-
65
- export interface SearchContentWithTextParams {
66
- /** Content type tag: Help, News, etc. Supply multiple ctypes separated by space. */
67
- ctype?: string;
68
- /** Page number for the search results, starting with page 1. */
69
- currentpage?: number;
70
- /** Not used. */
71
- head?: boolean;
72
- locale: string;
73
- /** Word or phrase for the search. */
74
- searchtext?: string;
75
- /** For analytics, hint at the part of the app that triggered the search. Optional. */
76
- source?: string;
77
- /** Tag used on the content to be searched. */
78
- tag?: string;
79
- }
80
-
81
- /**
82
- * Gets content based on querystring information passed in. Provides basic search
83
- * and text search capabilities.
84
- */
85
- export function searchContentWithText(http: HttpClient, params: SearchContentWithTextParams): Promise<ServerResponse<SearchResultOfContentItemPublicContract>> {
86
- const strParams: Record<string, string> = {};
87
- if (params.ctype !== undefined) { strParams.ctype = params.ctype; }
88
- if (params.currentpage !== undefined) { strParams.currentpage = params.currentpage.toString(); }
89
- if (params.head !== undefined) { strParams.head = params.head.toString(); }
90
- if (params.searchtext !== undefined) { strParams.searchtext = params.searchtext; }
91
- if (params.source !== undefined) { strParams.source = params.source; }
92
- if (params.tag !== undefined) { strParams.tag = params.tag; }
93
- return get(http, `${API_BASE}Search/${params.locale}/`, strParams);
94
- }
95
-
96
- export interface SearchContentByTagAndTypeParams {
97
- /** Page number for the search results starting with page 1. */
98
- currentpage?: number;
99
- /** Not used. */
100
- head?: boolean;
101
- /** Not used. */
102
- itemsperpage?: number;
103
- locale: string;
104
- tag: string;
105
- type: string;
106
- }
107
-
108
- /** Searches for Content Items that match the given Tag and Content Type. */
109
- export function searchContentByTagAndType(http: HttpClient, params: SearchContentByTagAndTypeParams): Promise<ServerResponse<SearchResultOfContentItemPublicContract>> {
110
- const strParams: Record<string, string> = {};
111
- if (params.currentpage !== undefined) { strParams.currentpage = params.currentpage.toString(); }
112
- if (params.head !== undefined) { strParams.head = params.head.toString(); }
113
- if (params.itemsperpage !== undefined) { strParams.itemsperpage = params.itemsperpage.toString(); }
114
- return get(http, `${API_BASE}SearchContentByTagAndType/${params.tag}/${params.type}/${params.locale}/`, strParams);
115
- }
116
-
117
- export interface SearchHelpArticlesParams {
118
- searchtext: string;
119
- size: string;
120
- }
121
-
122
- /** Search for Help Articles. */
123
- export function searchHelpArticles(http: HttpClient, params: SearchHelpArticlesParams): Promise<ServerResponse<object>> {
124
- return get(http, `${API_BASE}SearchHelpArticles/${params.searchtext}/${params.size}/`);
125
- }
126
-
127
- export interface RssNewsArticlesParams {
128
- /** Optionally filter response to only include news items in a certain category. */
129
- categoryfilter?: string;
130
- /** Optionally include full content body for each news item. */
131
- includebody?: boolean;
132
- /** Zero-based pagination token for paging through result sets. */
133
- pageToken: string;
134
- }
135
-
136
- /** Returns a JSON string response that is the RSS feed for news articles. */
137
- export function rssNewsArticles(http: HttpClient, params: RssNewsArticlesParams): Promise<ServerResponse<NewsArticleRssResponse>> {
138
- const strParams: Record<string, string> = {};
139
- if (params.categoryfilter !== undefined) { strParams.categoryfilter = params.categoryfilter; }
140
- if (params.includebody !== undefined) { strParams.includebody = params.includebody.toString(); }
141
- return get(http, `${API_BASE}Rss/NewsArticles/${params.pageToken}/`, strParams);
142
- }
@@ -1,17 +0,0 @@
1
- /**
2
- * Bungie.Net API
3
- * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
4
- *
5
- * OpenAPI spec version: 2.21.9
6
- * Contact: support@bungie.com
7
- *
8
- * NOTE: This class is auto generated by the bungie-api-ts code generator program.
9
- * https://github.com/DestinyItemManager/bungie-api-ts
10
- * Do not edit these files manually.
11
- */
12
-
13
- export * from '../common.js';
14
- export * from '../platform.js';
15
- export type {HttpClientConfig, HttpClient} from '../http.js';
16
- export * from './api.js';
17
- export * from './interfaces.js';
@@ -1,225 +0,0 @@
1
- /**
2
- * Bungie.Net API
3
- * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
4
- *
5
- * OpenAPI spec version: 2.21.9
6
- * Contact: support@bungie.com
7
- *
8
- * NOTE: This class is auto generated by the bungie-api-ts code generator program.
9
- * https://github.com/DestinyItemManager/bungie-api-ts
10
- * Do not edit these files manually.
11
- */
12
-
13
- import {
14
- GeneralUser
15
- } from '../user/interfaces.js';
16
- import {
17
- PagedQuery
18
- } from '../common.js';
19
-
20
- export interface ContentTypeDescription {
21
- readonly cType: string;
22
- readonly name: string;
23
- readonly contentDescription: string;
24
- readonly previewImage: string;
25
- readonly priority: number;
26
- readonly reminder: string;
27
- readonly properties: ContentTypeProperty[];
28
- readonly tagMetadata: TagMetadataDefinition[];
29
- readonly tagMetadataItems: { [key: string]: TagMetadataItem };
30
- readonly usageExamples: string[];
31
- readonly showInContentEditor: boolean;
32
- readonly typeOf: string;
33
- readonly bindIdentifierToProperty: string;
34
- readonly boundRegex: string;
35
- readonly forceIdentifierBinding: boolean;
36
- readonly allowComments: boolean;
37
- readonly autoEnglishPropertyFallback: boolean;
38
- readonly bulkUploadable: boolean;
39
- readonly previews: ContentPreview[];
40
- readonly suppressCmsPath: boolean;
41
- readonly propertySections: ContentTypePropertySection[];
42
- }
43
-
44
- export interface ContentTypeProperty {
45
- readonly name: string;
46
- readonly rootPropertyName: string;
47
- readonly readableName: string;
48
- readonly value: string;
49
- readonly propertyDescription: string;
50
- readonly localizable: boolean;
51
- readonly fallback: boolean;
52
- readonly enabled: boolean;
53
- readonly order: number;
54
- readonly visible: boolean;
55
- readonly isTitle: boolean;
56
- readonly required: boolean;
57
- readonly maxLength: number;
58
- readonly maxByteLength: number;
59
- readonly maxFileSize: number;
60
- readonly regexp: string;
61
- readonly validateAs: string;
62
- readonly rssAttribute: string;
63
- readonly visibleDependency: string;
64
- readonly visibleOn: string;
65
- readonly datatype: ContentPropertyDataTypeEnum;
66
- readonly attributes: { [key: string]: string };
67
- readonly childProperties: ContentTypeProperty[];
68
- readonly contentTypeAllowed: string;
69
- readonly bindToProperty: string;
70
- readonly boundRegex: string;
71
- readonly representationSelection: { [key: string]: string };
72
- readonly defaultValues: ContentTypeDefaultValue[];
73
- readonly isExternalAllowed: boolean;
74
- readonly propertySection: string;
75
- readonly weight: number;
76
- readonly entitytype: string;
77
- readonly isCombo: boolean;
78
- readonly suppressProperty: boolean;
79
- readonly legalContentTypes: string[];
80
- readonly representationValidationString: string;
81
- readonly minWidth: number;
82
- readonly maxWidth: number;
83
- readonly minHeight: number;
84
- readonly maxHeight: number;
85
- readonly isVideo: boolean;
86
- readonly isImage: boolean;
87
- }
88
-
89
- export const enum ContentPropertyDataTypeEnum {
90
- None = 0,
91
- Plaintext = 1,
92
- Html = 2,
93
- Dropdown = 3,
94
- List = 4,
95
- Json = 5,
96
- Content = 6,
97
- Representation = 7,
98
- Set = 8,
99
- File = 9,
100
- FolderSet = 10,
101
- Date = 11,
102
- MultilinePlaintext = 12,
103
- DestinyContent = 13,
104
- Color = 14
105
- }
106
-
107
- export interface ContentTypeDefaultValue {
108
- readonly whenClause: string;
109
- readonly whenValue: string;
110
- readonly defaultValue: string;
111
- }
112
-
113
- export interface TagMetadataDefinition {
114
- readonly description: string;
115
- readonly order: number;
116
- readonly items: TagMetadataItem[];
117
- readonly datatype: string;
118
- readonly name: string;
119
- readonly isRequired: boolean;
120
- }
121
-
122
- export interface TagMetadataItem {
123
- readonly description: string;
124
- readonly tagText: string;
125
- readonly groups: string[];
126
- readonly isDefault: boolean;
127
- readonly name: string;
128
- }
129
-
130
- export interface ContentPreview {
131
- readonly name: string;
132
- readonly path: string;
133
- readonly itemInSet: boolean;
134
- readonly setTag: string;
135
- readonly setNesting: number;
136
- readonly useSetId: number;
137
- }
138
-
139
- export interface ContentTypePropertySection {
140
- readonly name: string;
141
- readonly readableName: string;
142
- readonly collapsed: boolean;
143
- }
144
-
145
- export interface ContentItemPublicContract {
146
- readonly contentId: string;
147
- readonly cType: string;
148
- readonly cmsPath: string;
149
- readonly creationDate: string;
150
- readonly modifyDate: string;
151
- readonly allowComments: boolean;
152
- readonly hasAgeGate: boolean;
153
- readonly minimumAge: number;
154
- readonly ratingImagePath: string;
155
- readonly author: GeneralUser;
156
- readonly autoEnglishPropertyFallback: boolean;
157
- /**
158
- * Firehose content is really a collection of metadata and "properties", which are
159
- * the potentially-but-not-strictly localizable data that comprises the meat of
160
- * whatever content is being shown.
161
- *
162
- * As Cole Porter would have crooned, "Anything Goes" with Firehose properties.
163
- * They are most often strings, but they can theoretically be anything. They are
164
- * JSON encoded, and could be JSON structures, simple strings, numbers etc... The
165
- * Content Type of the item (cType) will describe the properties, and thus how they
166
- * ought to be deserialized.
167
- */
168
- readonly properties: { [key: string]: object };
169
- readonly representations: ContentRepresentation[];
170
- /** NOTE: Tags will always be lower case. */
171
- readonly tags: string[];
172
- readonly commentSummary: CommentSummary;
173
- }
174
-
175
- export interface ContentRepresentation {
176
- readonly name: string;
177
- readonly path: string;
178
- readonly validationString: string;
179
- }
180
-
181
- export interface CommentSummary {
182
- readonly topicId: string;
183
- readonly commentCount: number;
184
- }
185
-
186
- export interface SearchResultOfContentItemPublicContract {
187
- readonly results: ContentItemPublicContract[];
188
- readonly totalResults: number;
189
- readonly hasMore: boolean;
190
- readonly query: PagedQuery;
191
- readonly replacementContinuationToken: string;
192
- /**
193
- * If useTotalResults is true, then totalResults represents an accurate count.
194
- *
195
- * If False, it does not, and may be estimated/only the size of the current page.
196
- *
197
- * Either way, you should probably always only trust hasMore.
198
- *
199
- * This is a long-held historical throwback to when we used to do paging with known
200
- * total results. Those queries toasted our database, and we were left to hastily
201
- * alter our endpoints and create backward- compatible shims, of which
202
- * useTotalResults is one.
203
- */
204
- readonly useTotalResults: boolean;
205
- }
206
-
207
- export interface NewsArticleRssResponse {
208
- readonly CurrentPaginationToken: number;
209
- readonly NextPaginationToken?: number;
210
- readonly ResultCountThisPage: number;
211
- readonly NewsArticles: NewsArticleRssItem[];
212
- readonly CategoryFilter: string;
213
- readonly PagerAction: string;
214
- }
215
-
216
- export interface NewsArticleRssItem {
217
- readonly Title: string;
218
- readonly Link: string;
219
- readonly PubDate: string;
220
- readonly UniqueIdentifier: string;
221
- readonly Description: string;
222
- readonly HtmlContent: string;
223
- readonly ImagePath: string;
224
- readonly OptionalMobileImagePath: string;
225
- }
@@ -1,57 +0,0 @@
1
- /**
2
- * Bungie.Net API
3
- * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
4
- *
5
- * OpenAPI spec version: 2.21.9
6
- * Contact: support@bungie.com
7
- *
8
- * NOTE: This class is auto generated by the bungie-api-ts code generator program.
9
- * https://github.com/DestinyItemManager/bungie-api-ts
10
- * Do not edit these files manually.
11
- */
12
-
13
- import { HttpClient, get, post } from '../http.js';
14
-
15
- import {
16
- CoreSettingsConfiguration,
17
- CoreSystem,
18
- GlobalAlert
19
- } from './interfaces.js';
20
- import {
21
- ServerResponse
22
- } from '../common.js';
23
-
24
- const API_BASE = "https://www.bungie.net/Platform/";
25
-
26
- /** List of available localization cultures */
27
- export function getAvailableLocales(http: HttpClient): Promise<ServerResponse<{ [key: string]: string }>> {
28
- return get(http, `${API_BASE}GetAvailableLocales/`);
29
- }
30
-
31
- /** Get the common settings used by the Bungie.Net environment. */
32
- export function getCommonSettings(http: HttpClient): Promise<ServerResponse<CoreSettingsConfiguration>> {
33
- return get(http, `${API_BASE}Settings/`);
34
- }
35
-
36
- /**
37
- * Get the user-specific system overrides that should be respected alongside common
38
- * systems.
39
- */
40
- export function getUserSystemOverrides(http: HttpClient): Promise<ServerResponse<{ [key: string]: CoreSystem }>> {
41
- return get(http, `${API_BASE}UserSystemOverrides/`);
42
- }
43
-
44
- export interface GetGlobalAlertsParams {
45
- /** Determines whether Streaming Alerts are included in results */
46
- includestreaming?: boolean;
47
- }
48
-
49
- /**
50
- * Gets any active global alert for display in the forum banners, help pages, etc.
51
- * Usually used for DOC alerts.
52
- */
53
- export function getGlobalAlerts(http: HttpClient, params: GetGlobalAlertsParams): Promise<ServerResponse<GlobalAlert[]>> {
54
- const strParams: Record<string, string> = {};
55
- if (params.includestreaming !== undefined) { strParams.includestreaming = params.includestreaming.toString(); }
56
- return get(http, `${API_BASE}GlobalAlerts/`, strParams);
57
- }
@@ -1,17 +0,0 @@
1
- /**
2
- * Bungie.Net API
3
- * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
4
- *
5
- * OpenAPI spec version: 2.21.9
6
- * Contact: support@bungie.com
7
- *
8
- * NOTE: This class is auto generated by the bungie-api-ts code generator program.
9
- * https://github.com/DestinyItemManager/bungie-api-ts
10
- * Do not edit these files manually.
11
- */
12
-
13
- export * from '../common.js';
14
- export * from '../platform.js';
15
- export type {HttpClientConfig, HttpClient} from '../http.js';
16
- export * from './api.js';
17
- export * from './interfaces.js';
@@ -1,151 +0,0 @@
1
- /**
2
- * Bungie.Net API
3
- * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
4
- *
5
- * OpenAPI spec version: 2.21.9
6
- * Contact: support@bungie.com
7
- *
8
- * NOTE: This class is auto generated by the bungie-api-ts code generator program.
9
- * https://github.com/DestinyItemManager/bungie-api-ts
10
- * Do not edit these files manually.
11
- */
12
-
13
- import {
14
- EmailSettings
15
- } from '../user/interfaces.js';
16
-
17
- export interface CoreSettingsConfiguration {
18
- readonly environment: string;
19
- readonly systems: { [key: string]: CoreSystem };
20
- readonly ignoreReasons: CoreSetting[];
21
- readonly forumCategories: CoreSetting[];
22
- readonly groupAvatars: CoreSetting[];
23
- readonly defaultGroupTheme: CoreSetting;
24
- readonly destinyMembershipTypes: CoreSetting[];
25
- readonly recruitmentPlatformTags: CoreSetting[];
26
- readonly recruitmentMiscTags: CoreSetting[];
27
- readonly recruitmentActivities: CoreSetting[];
28
- readonly userContentLocales: CoreSetting[];
29
- readonly systemContentLocales: CoreSetting[];
30
- readonly clanBannerDecals: CoreSetting[];
31
- readonly clanBannerDecalColors: CoreSetting[];
32
- readonly clanBannerGonfalons: CoreSetting[];
33
- readonly clanBannerGonfalonColors: CoreSetting[];
34
- readonly clanBannerGonfalonDetails: CoreSetting[];
35
- readonly clanBannerGonfalonDetailColors: CoreSetting[];
36
- readonly clanBannerStandards: CoreSetting[];
37
- readonly destiny2CoreSettings: Destiny2CoreSettings;
38
- readonly emailSettings: EmailSettings;
39
- readonly fireteamActivities: CoreSetting[];
40
- }
41
-
42
- export interface CoreSystem {
43
- readonly enabled: boolean;
44
- readonly parameters: { [key: string]: string };
45
- }
46
-
47
- export interface CoreSetting {
48
- readonly identifier: string;
49
- readonly isDefault: boolean;
50
- readonly displayName: string;
51
- readonly summary: string;
52
- readonly imagePath: string;
53
- readonly childSettings: CoreSetting[];
54
- }
55
-
56
- export interface Destiny2CoreSettings {
57
- /** Mapped to DestinyPresentationNodeDefinition in the manifest. */
58
- readonly collectionRootNode: number;
59
- /** Mapped to DestinyPresentationNodeDefinition in the manifest. */
60
- readonly badgesRootNode: number;
61
- /** Mapped to DestinyPresentationNodeDefinition in the manifest. */
62
- readonly recordsRootNode: number;
63
- /** Mapped to DestinyPresentationNodeDefinition in the manifest. */
64
- readonly medalsRootNode: number;
65
- /** Mapped to DestinyPresentationNodeDefinition in the manifest. */
66
- readonly metricsRootNode: number;
67
- /** Mapped to DestinyPresentationNodeDefinition in the manifest. */
68
- readonly activeTriumphsRootNodeHash: number;
69
- /** Mapped to DestinyPresentationNodeDefinition in the manifest. */
70
- readonly activeSealsRootNodeHash: number;
71
- /** Mapped to DestinyPresentationNodeDefinition in the manifest. */
72
- readonly legacyTriumphsRootNodeHash: number;
73
- /** Mapped to DestinyPresentationNodeDefinition in the manifest. */
74
- readonly legacySealsRootNodeHash: number;
75
- /** Mapped to DestinyPresentationNodeDefinition in the manifest. */
76
- readonly medalsRootNodeHash: number;
77
- /** Mapped to DestinyPresentationNodeDefinition in the manifest. */
78
- readonly exoticCatalystsRootNodeHash: number;
79
- /** Mapped to DestinyPresentationNodeDefinition in the manifest. */
80
- readonly loreRootNodeHash: number;
81
- /** Mapped to DestinyPresentationNodeDefinition in the manifest. */
82
- readonly craftingRootNodeHash: number;
83
- /** Mapped to DestinyGlobalConstantsDefinition in the manifest. */
84
- readonly globalConstantsHash: number;
85
- /** Mapped to DestinyLoadoutConstantsDefinition in the manifest. */
86
- readonly loadoutConstantsHash: number;
87
- /** Mapped to DestinyGuardianRankConstantsDefinition in the manifest. */
88
- readonly guardianRankConstantsHash: number;
89
- /** Mapped to DestinyFireteamFinderConstantsDefinition in the manifest. */
90
- readonly fireteamFinderConstantsHash: number;
91
- /** Mapped to DestinyInventoryItemConstantsDefinition in the manifest. */
92
- readonly inventoryItemConstantsHash: number;
93
- /** Mapped to DestinyItemFilterDefinition in the manifest. */
94
- readonly featuredItemsListHash: number;
95
- /** Mapped to DestinyPlugSetDefinition in the manifest. */
96
- readonly armorArchetypePlugSetHash: number;
97
- /** Mapped to DestinyEventCardDefinition in the manifest. */
98
- readonly seasonalHubEventCardHash: number;
99
- /** Mapped to DestinyPresentationNodeDefinition in the manifest. */
100
- readonly guardianRanksRootNodeHash: number;
101
- /** Mapped to DestinyProgressionDefinition in the manifest. */
102
- readonly currentRankProgressionHashes: number[];
103
- /** Mapped to DestinyInventoryItemDefinition in the manifest. */
104
- readonly insertPlugFreeProtectedPlugItemHashes: number[];
105
- /** Mapped to DestinySocketTypeDefinition in the manifest. */
106
- readonly insertPlugFreeBlockedSocketTypeHashes: number[];
107
- /** Mapped to DestinyFireteamFinderActivityGraphDefinition in the manifest. */
108
- readonly enabledFireteamFinderActivityGraphHashes: number[];
109
- readonly undiscoveredCollectibleImage: string;
110
- readonly ammoTypeHeavyIcon: string;
111
- readonly ammoTypeSpecialIcon: string;
112
- readonly ammoTypePrimaryIcon: string;
113
- /** Mapped to DestinyVendorDefinition in the manifest. */
114
- readonly currentSeasonalArtifactHash: number;
115
- /** Mapped to DestinySeasonDefinition in the manifest. */
116
- readonly currentSeasonHash?: number;
117
- /** Mapped to DestinySeasonPassDefinition in the manifest. */
118
- readonly currentSeasonPassHash?: number;
119
- /** Mapped to DestinyPresentationNodeDefinition in the manifest. */
120
- readonly seasonalChallengesPresentationNodeHash?: number;
121
- /** Mapped to DestinySeasonDefinition in the manifest. */
122
- readonly futureSeasonHashes: number[];
123
- /** Mapped to DestinySeasonDefinition in the manifest. */
124
- readonly pastSeasonHashes: number[];
125
- }
126
-
127
- export interface GlobalAlert {
128
- readonly AlertKey: string;
129
- readonly AlertHtml: string;
130
- readonly AlertTimestamp: string;
131
- readonly AlertLink: string;
132
- readonly AlertLevel: GlobalAlertLevel;
133
- readonly AlertType: GlobalAlertType;
134
- readonly StreamInfo: StreamInfo;
135
- }
136
-
137
- export const enum GlobalAlertLevel {
138
- Unknown = 0,
139
- Blue = 1,
140
- Yellow = 2,
141
- Red = 3
142
- }
143
-
144
- export const enum GlobalAlertType {
145
- GlobalAlert = 0,
146
- StreamingAlert = 1
147
- }
148
-
149
- export interface StreamInfo {
150
- readonly ChannelName: string;
151
- }