vrchat 1.0.2 → 1.3.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.
@@ -1,83 +1,82 @@
1
- /**
2
- * VRChat API Documentation
3
- * ![VRChat API Banner](https://vrchatapi.github.io/assets/img/api_banner_1500x400.png) # Welcome to the VRChat API Before we begin, we would like to state this is a **COMMUNITY DRIVEN PROJECT**. This means that everything you read on here was written by the community itself and is **not** officially supported by VRChat. The documentation is provided \"AS IS\", and any action you take towards VRChat is completely your own responsibility. The documentation and additional libraries SHALL ONLY be used for applications interacting with VRChat\'s API in accordance with their [Terms of Service](https://github.com/VRChatAPI), and MUST NOT be used for modifying the client, \"avatar ripping\", or other illegal activities. Malicious usage or spamming the API may result in account termination. Certain parts of the API are also more sensitive than others, for example moderation, so please read tread extra carefully and read the warnings when present. ![Tupper Policy on API](https://i.imgur.com/yLlW7Ok.png) Finally, use of the API using applications other than the approved methods (website, VRChat application, Unity SDK) is not officially supported. VRChat provides no guarantee or support for external applications using the API. Access to API endpoints may break **at any time, without notice**. Therefore, please **do not ping** VRChat Staff in the VRChat Discord if you are having API problems, as they do not provide API support. We will make a best effort in keeping this documentation and associated language libraries up to date, but things might be outdated or missing. If you find that something is no longer valid, please contact us on Discord or [create an issue](https://github.com/vrchatapi/specification/issues) and tell us so we can fix it. # Getting Started The VRChat API can be used to programmatically retrieve or update information regarding your profile, friends, avatars, worlds and more. The API consists of two parts, \"Photon\" which is only used in-game, and the \"Web API\" which is used by both the game and the website. This documentation focuses only on the Web API. The API is designed around the REST ideology, providing semi-simple and usually predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. <div class=\"callout callout-error\"> <strong>🛑 Warning! Do not touch Photon!</strong><br> Photon is only used by the in-game client and should <b>not</b> be touched. Doing so may result in permanent account termination. </div> <div class=\"callout callout-info\"> <strong>â„šī¸ API Key and Authentication</strong><br> The API Key has always been the same and is currently <code>JlE5Jldo5Jibnk5O5hTx6XVqsJu4WJ26</code>. Read <a href=\"#tag--authentication\">Authentication</a> for how to log in. </div> # Using the API For simply exploring what the API can do it is strongly recommended to download [Insomnia](https://insomnia.rest/download), a free and open-source API client that\'s great for sending requests to the API in an orderly fashion. Insomnia allows you to send data in the format that\'s required for VRChat\'s API. It is also possible to try out the API in your browser, by first logging in at [vrchat.com/home](https://vrchat.com/home/) and then going to [vrchat.com/api/1/auth/user](https://vrchat.com/api/1/auth/user), but the information will be much harder to work with. For more permanent operation such as software development it is instead recommended to use one of the existing language SDKs. This community project maintains API libraries in several languages, which allows you to interact with the API with simple function calls rather than having to implement the HTTP protocol yourself. Most of these libraries are automatically generated from the API specification, sometimes with additional helpful wrapper code to make usage easier. This allows them to be almost automatically updated and expanded upon as soon as a new feature is introduced in the specification itself. The libraries can be found on [GitHub](https://github.com/vrchatapi) or following: * [NodeJS (JavaScript)](https://www.npmjs.com/package/vrchat) * [Dart](https://pub.dev/packages/vrchat_dart) * [Rust](https://crates.io/crates/vrchatapi) * [C#](github.com/vrchatapi/vrchatapi-csharp) * [Python](https://github.com/vrchatapi/VRChatPython) # Pagination Most endpoints enforce pagination, meaning they will only return 10 entries by default, and never more than 100.<br> Using both the limit and offset parameters allows you to easily paginate through a large number of objects. | Query Parameter | Type | Description | | ----------|--|------- | | `limit` | integer | The number of objects to return. This value often defaults to 10. Highest limit is always 100.| | `offset` | integer | A zero-based offset from the default object sorting.| If a request returns fewer objects than the `limit` parameter, there are no more items available to return. # Contribution Do you want to get involved in the documentation effort? Do you want to help improve one of the language API libraries? This project is an [OPEN Open Source Project](https://openopensource.org)! This means that individuals making significant and valuable contributions are given commit-access to the project. It also means we are very open and welcoming of new people making contributions, unlike some more guarded open-source projects. [![Discord](https://img.shields.io/static/v1?label=vrchatapi&message=discord&color=blueviolet&style=for-the-badge)](https://discord.gg/qjZE9C9fkB)
4
- *
5
- * The version of the OpenAPI document: 1.0.2
6
- * Contact: me@ruby.js.org
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- export interface ConfigurationParameters {
13
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
14
- username?: string;
15
- password?: string;
16
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
17
- basePath?: string;
18
- baseOptions?: any;
19
- formDataCtor?: new () => any;
20
- }
21
- export declare class Configuration {
22
- /**
23
- * parameter for apiKey security
24
- * @param name security name
25
- * @memberof Configuration
26
- */
27
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
28
- /**
29
- * parameter for basic security
30
- *
31
- * @type {string}
32
- * @memberof Configuration
33
- */
34
- username?: string;
35
- /**
36
- * parameter for basic security
37
- *
38
- * @type {string}
39
- * @memberof Configuration
40
- */
41
- password?: string;
42
- /**
43
- * parameter for oauth2 security
44
- * @param name security name
45
- * @param scopes oauth2 scope
46
- * @memberof Configuration
47
- */
48
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
49
- /**
50
- * override base path
51
- *
52
- * @type {string}
53
- * @memberof Configuration
54
- */
55
- basePath?: string;
56
- /**
57
- * base options for axios calls
58
- *
59
- * @type {any}
60
- * @memberof Configuration
61
- */
62
- baseOptions?: any;
63
- /**
64
- * The FormData constructor that will be used to create multipart form data
65
- * requests. You can inject this here so that execution environments that
66
- * do not support the FormData class can still run the generated client.
67
- *
68
- * @type {new () => FormData}
69
- */
70
- formDataCtor?: new () => any;
71
- constructor(param?: ConfigurationParameters);
72
- /**
73
- * Check if the given MIME is a JSON MIME.
74
- * JSON MIME examples:
75
- * application/json
76
- * application/json; charset=UTF8
77
- * APPLICATION/JSON
78
- * application/vnd.company+json
79
- * @param mime - MIME (Multipurpose Internet Mail Extensions)
80
- * @return True if the given MIME is JSON, false otherwise.
81
- */
82
- isJsonMime(mime: string): boolean;
83
- }
1
+ /**
2
+ * VRChat API Documentation
3
+ *
4
+ * The version of the OpenAPI document: 1.3.1
5
+ * Contact: me@ruby.js.org
6
+ *
7
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
8
+ * https://openapi-generator.tech
9
+ * Do not edit the class manually.
10
+ */
11
+ export interface ConfigurationParameters {
12
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
13
+ username?: string;
14
+ password?: string;
15
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
16
+ basePath?: string;
17
+ baseOptions?: any;
18
+ formDataCtor?: new () => any;
19
+ }
20
+ export declare class Configuration {
21
+ /**
22
+ * parameter for apiKey security
23
+ * @param name security name
24
+ * @memberof Configuration
25
+ */
26
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
27
+ /**
28
+ * parameter for basic security
29
+ *
30
+ * @type {string}
31
+ * @memberof Configuration
32
+ */
33
+ username?: string;
34
+ /**
35
+ * parameter for basic security
36
+ *
37
+ * @type {string}
38
+ * @memberof Configuration
39
+ */
40
+ password?: string;
41
+ /**
42
+ * parameter for oauth2 security
43
+ * @param name security name
44
+ * @param scopes oauth2 scope
45
+ * @memberof Configuration
46
+ */
47
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
48
+ /**
49
+ * override base path
50
+ *
51
+ * @type {string}
52
+ * @memberof Configuration
53
+ */
54
+ basePath?: string;
55
+ /**
56
+ * base options for axios calls
57
+ *
58
+ * @type {any}
59
+ * @memberof Configuration
60
+ */
61
+ baseOptions?: any;
62
+ /**
63
+ * The FormData constructor that will be used to create multipart form data
64
+ * requests. You can inject this here so that execution environments that
65
+ * do not support the FormData class can still run the generated client.
66
+ *
67
+ * @type {new () => FormData}
68
+ */
69
+ formDataCtor?: new () => any;
70
+ constructor(param?: ConfigurationParameters);
71
+ /**
72
+ * Check if the given MIME is a JSON MIME.
73
+ * JSON MIME examples:
74
+ * application/json
75
+ * application/json; charset=UTF8
76
+ * APPLICATION/JSON
77
+ * application/vnd.company+json
78
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
79
+ * @return True if the given MIME is JSON, false otherwise.
80
+ */
81
+ isJsonMime(mime: string): boolean;
82
+ }
@@ -1,44 +1,43 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * VRChat API Documentation
6
- * ![VRChat API Banner](https://vrchatapi.github.io/assets/img/api_banner_1500x400.png) # Welcome to the VRChat API Before we begin, we would like to state this is a **COMMUNITY DRIVEN PROJECT**. This means that everything you read on here was written by the community itself and is **not** officially supported by VRChat. The documentation is provided \"AS IS\", and any action you take towards VRChat is completely your own responsibility. The documentation and additional libraries SHALL ONLY be used for applications interacting with VRChat\'s API in accordance with their [Terms of Service](https://github.com/VRChatAPI), and MUST NOT be used for modifying the client, \"avatar ripping\", or other illegal activities. Malicious usage or spamming the API may result in account termination. Certain parts of the API are also more sensitive than others, for example moderation, so please read tread extra carefully and read the warnings when present. ![Tupper Policy on API](https://i.imgur.com/yLlW7Ok.png) Finally, use of the API using applications other than the approved methods (website, VRChat application, Unity SDK) is not officially supported. VRChat provides no guarantee or support for external applications using the API. Access to API endpoints may break **at any time, without notice**. Therefore, please **do not ping** VRChat Staff in the VRChat Discord if you are having API problems, as they do not provide API support. We will make a best effort in keeping this documentation and associated language libraries up to date, but things might be outdated or missing. If you find that something is no longer valid, please contact us on Discord or [create an issue](https://github.com/vrchatapi/specification/issues) and tell us so we can fix it. # Getting Started The VRChat API can be used to programmatically retrieve or update information regarding your profile, friends, avatars, worlds and more. The API consists of two parts, \"Photon\" which is only used in-game, and the \"Web API\" which is used by both the game and the website. This documentation focuses only on the Web API. The API is designed around the REST ideology, providing semi-simple and usually predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. <div class=\"callout callout-error\"> <strong>🛑 Warning! Do not touch Photon!</strong><br> Photon is only used by the in-game client and should <b>not</b> be touched. Doing so may result in permanent account termination. </div> <div class=\"callout callout-info\"> <strong>â„šī¸ API Key and Authentication</strong><br> The API Key has always been the same and is currently <code>JlE5Jldo5Jibnk5O5hTx6XVqsJu4WJ26</code>. Read <a href=\"#tag--authentication\">Authentication</a> for how to log in. </div> # Using the API For simply exploring what the API can do it is strongly recommended to download [Insomnia](https://insomnia.rest/download), a free and open-source API client that\'s great for sending requests to the API in an orderly fashion. Insomnia allows you to send data in the format that\'s required for VRChat\'s API. It is also possible to try out the API in your browser, by first logging in at [vrchat.com/home](https://vrchat.com/home/) and then going to [vrchat.com/api/1/auth/user](https://vrchat.com/api/1/auth/user), but the information will be much harder to work with. For more permanent operation such as software development it is instead recommended to use one of the existing language SDKs. This community project maintains API libraries in several languages, which allows you to interact with the API with simple function calls rather than having to implement the HTTP protocol yourself. Most of these libraries are automatically generated from the API specification, sometimes with additional helpful wrapper code to make usage easier. This allows them to be almost automatically updated and expanded upon as soon as a new feature is introduced in the specification itself. The libraries can be found on [GitHub](https://github.com/vrchatapi) or following: * [NodeJS (JavaScript)](https://www.npmjs.com/package/vrchat) * [Dart](https://pub.dev/packages/vrchat_dart) * [Rust](https://crates.io/crates/vrchatapi) * [C#](github.com/vrchatapi/vrchatapi-csharp) * [Python](https://github.com/vrchatapi/VRChatPython) # Pagination Most endpoints enforce pagination, meaning they will only return 10 entries by default, and never more than 100.<br> Using both the limit and offset parameters allows you to easily paginate through a large number of objects. | Query Parameter | Type | Description | | ----------|--|------- | | `limit` | integer | The number of objects to return. This value often defaults to 10. Highest limit is always 100.| | `offset` | integer | A zero-based offset from the default object sorting.| If a request returns fewer objects than the `limit` parameter, there are no more items available to return. # Contribution Do you want to get involved in the documentation effort? Do you want to help improve one of the language API libraries? This project is an [OPEN Open Source Project](https://openopensource.org)! This means that individuals making significant and valuable contributions are given commit-access to the project. It also means we are very open and welcoming of new people making contributions, unlike some more guarded open-source projects. [![Discord](https://img.shields.io/static/v1?label=vrchatapi&message=discord&color=blueviolet&style=for-the-badge)](https://discord.gg/qjZE9C9fkB)
7
- *
8
- * The version of the OpenAPI document: 1.0.2
9
- * Contact: me@ruby.js.org
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.Configuration = void 0;
17
- var Configuration = /** @class */ (function () {
18
- function Configuration(param) {
19
- if (param === void 0) { param = {}; }
20
- this.apiKey = param.apiKey;
21
- this.username = param.username;
22
- this.password = param.password;
23
- this.accessToken = param.accessToken;
24
- this.basePath = param.basePath;
25
- this.baseOptions = param.baseOptions;
26
- this.formDataCtor = param.formDataCtor;
27
- }
28
- /**
29
- * Check if the given MIME is a JSON MIME.
30
- * JSON MIME examples:
31
- * application/json
32
- * application/json; charset=UTF8
33
- * APPLICATION/JSON
34
- * application/vnd.company+json
35
- * @param mime - MIME (Multipurpose Internet Mail Extensions)
36
- * @return True if the given MIME is JSON, false otherwise.
37
- */
38
- Configuration.prototype.isJsonMime = function (mime) {
39
- var jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
40
- return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
41
- };
42
- return Configuration;
43
- }());
44
- exports.Configuration = Configuration;
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * VRChat API Documentation
6
+ *
7
+ * The version of the OpenAPI document: 1.3.1
8
+ * Contact: me@ruby.js.org
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.Configuration = void 0;
16
+ var Configuration = /** @class */ (function () {
17
+ function Configuration(param) {
18
+ if (param === void 0) { param = {}; }
19
+ this.apiKey = param.apiKey;
20
+ this.username = param.username;
21
+ this.password = param.password;
22
+ this.accessToken = param.accessToken;
23
+ this.basePath = param.basePath;
24
+ this.baseOptions = param.baseOptions;
25
+ this.formDataCtor = param.formDataCtor;
26
+ }
27
+ /**
28
+ * Check if the given MIME is a JSON MIME.
29
+ * JSON MIME examples:
30
+ * application/json
31
+ * application/json; charset=UTF8
32
+ * APPLICATION/JSON
33
+ * application/vnd.company+json
34
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
35
+ * @return True if the given MIME is JSON, false otherwise.
36
+ */
37
+ Configuration.prototype.isJsonMime = function (mime) {
38
+ var jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
39
+ return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
40
+ };
41
+ return Configuration;
42
+ }());
43
+ exports.Configuration = Configuration;
package/dist/index.d.ts CHANGED
@@ -1,13 +1,12 @@
1
- /**
2
- * VRChat API Documentation
3
- * ![VRChat API Banner](https://vrchatapi.github.io/assets/img/api_banner_1500x400.png) # Welcome to the VRChat API Before we begin, we would like to state this is a **COMMUNITY DRIVEN PROJECT**. This means that everything you read on here was written by the community itself and is **not** officially supported by VRChat. The documentation is provided \"AS IS\", and any action you take towards VRChat is completely your own responsibility. The documentation and additional libraries SHALL ONLY be used for applications interacting with VRChat\'s API in accordance with their [Terms of Service](https://github.com/VRChatAPI), and MUST NOT be used for modifying the client, \"avatar ripping\", or other illegal activities. Malicious usage or spamming the API may result in account termination. Certain parts of the API are also more sensitive than others, for example moderation, so please read tread extra carefully and read the warnings when present. ![Tupper Policy on API](https://i.imgur.com/yLlW7Ok.png) Finally, use of the API using applications other than the approved methods (website, VRChat application, Unity SDK) is not officially supported. VRChat provides no guarantee or support for external applications using the API. Access to API endpoints may break **at any time, without notice**. Therefore, please **do not ping** VRChat Staff in the VRChat Discord if you are having API problems, as they do not provide API support. We will make a best effort in keeping this documentation and associated language libraries up to date, but things might be outdated or missing. If you find that something is no longer valid, please contact us on Discord or [create an issue](https://github.com/vrchatapi/specification/issues) and tell us so we can fix it. # Getting Started The VRChat API can be used to programmatically retrieve or update information regarding your profile, friends, avatars, worlds and more. The API consists of two parts, \"Photon\" which is only used in-game, and the \"Web API\" which is used by both the game and the website. This documentation focuses only on the Web API. The API is designed around the REST ideology, providing semi-simple and usually predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. <div class=\"callout callout-error\"> <strong>🛑 Warning! Do not touch Photon!</strong><br> Photon is only used by the in-game client and should <b>not</b> be touched. Doing so may result in permanent account termination. </div> <div class=\"callout callout-info\"> <strong>â„šī¸ API Key and Authentication</strong><br> The API Key has always been the same and is currently <code>JlE5Jldo5Jibnk5O5hTx6XVqsJu4WJ26</code>. Read <a href=\"#tag--authentication\">Authentication</a> for how to log in. </div> # Using the API For simply exploring what the API can do it is strongly recommended to download [Insomnia](https://insomnia.rest/download), a free and open-source API client that\'s great for sending requests to the API in an orderly fashion. Insomnia allows you to send data in the format that\'s required for VRChat\'s API. It is also possible to try out the API in your browser, by first logging in at [vrchat.com/home](https://vrchat.com/home/) and then going to [vrchat.com/api/1/auth/user](https://vrchat.com/api/1/auth/user), but the information will be much harder to work with. For more permanent operation such as software development it is instead recommended to use one of the existing language SDKs. This community project maintains API libraries in several languages, which allows you to interact with the API with simple function calls rather than having to implement the HTTP protocol yourself. Most of these libraries are automatically generated from the API specification, sometimes with additional helpful wrapper code to make usage easier. This allows them to be almost automatically updated and expanded upon as soon as a new feature is introduced in the specification itself. The libraries can be found on [GitHub](https://github.com/vrchatapi) or following: * [NodeJS (JavaScript)](https://www.npmjs.com/package/vrchat) * [Dart](https://pub.dev/packages/vrchat_dart) * [Rust](https://crates.io/crates/vrchatapi) * [C#](github.com/vrchatapi/vrchatapi-csharp) * [Python](https://github.com/vrchatapi/VRChatPython) # Pagination Most endpoints enforce pagination, meaning they will only return 10 entries by default, and never more than 100.<br> Using both the limit and offset parameters allows you to easily paginate through a large number of objects. | Query Parameter | Type | Description | | ----------|--|------- | | `limit` | integer | The number of objects to return. This value often defaults to 10. Highest limit is always 100.| | `offset` | integer | A zero-based offset from the default object sorting.| If a request returns fewer objects than the `limit` parameter, there are no more items available to return. # Contribution Do you want to get involved in the documentation effort? Do you want to help improve one of the language API libraries? This project is an [OPEN Open Source Project](https://openopensource.org)! This means that individuals making significant and valuable contributions are given commit-access to the project. It also means we are very open and welcoming of new people making contributions, unlike some more guarded open-source projects. [![Discord](https://img.shields.io/static/v1?label=vrchatapi&message=discord&color=blueviolet&style=for-the-badge)](https://discord.gg/qjZE9C9fkB)
4
- *
5
- * The version of the OpenAPI document: 1.0.2
6
- * Contact: me@ruby.js.org
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- export * from "./api";
13
- export * from "./configuration";
1
+ /**
2
+ * VRChat API Documentation
3
+ *
4
+ * The version of the OpenAPI document: 1.3.1
5
+ * Contact: me@ruby.js.org
6
+ *
7
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
8
+ * https://openapi-generator.tech
9
+ * Do not edit the class manually.
10
+ */
11
+ export * from "./api";
12
+ export * from "./configuration";
package/dist/index.js CHANGED
@@ -1,27 +1,26 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * VRChat API Documentation
6
- * ![VRChat API Banner](https://vrchatapi.github.io/assets/img/api_banner_1500x400.png) # Welcome to the VRChat API Before we begin, we would like to state this is a **COMMUNITY DRIVEN PROJECT**. This means that everything you read on here was written by the community itself and is **not** officially supported by VRChat. The documentation is provided \"AS IS\", and any action you take towards VRChat is completely your own responsibility. The documentation and additional libraries SHALL ONLY be used for applications interacting with VRChat\'s API in accordance with their [Terms of Service](https://github.com/VRChatAPI), and MUST NOT be used for modifying the client, \"avatar ripping\", or other illegal activities. Malicious usage or spamming the API may result in account termination. Certain parts of the API are also more sensitive than others, for example moderation, so please read tread extra carefully and read the warnings when present. ![Tupper Policy on API](https://i.imgur.com/yLlW7Ok.png) Finally, use of the API using applications other than the approved methods (website, VRChat application, Unity SDK) is not officially supported. VRChat provides no guarantee or support for external applications using the API. Access to API endpoints may break **at any time, without notice**. Therefore, please **do not ping** VRChat Staff in the VRChat Discord if you are having API problems, as they do not provide API support. We will make a best effort in keeping this documentation and associated language libraries up to date, but things might be outdated or missing. If you find that something is no longer valid, please contact us on Discord or [create an issue](https://github.com/vrchatapi/specification/issues) and tell us so we can fix it. # Getting Started The VRChat API can be used to programmatically retrieve or update information regarding your profile, friends, avatars, worlds and more. The API consists of two parts, \"Photon\" which is only used in-game, and the \"Web API\" which is used by both the game and the website. This documentation focuses only on the Web API. The API is designed around the REST ideology, providing semi-simple and usually predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. <div class=\"callout callout-error\"> <strong>🛑 Warning! Do not touch Photon!</strong><br> Photon is only used by the in-game client and should <b>not</b> be touched. Doing so may result in permanent account termination. </div> <div class=\"callout callout-info\"> <strong>â„šī¸ API Key and Authentication</strong><br> The API Key has always been the same and is currently <code>JlE5Jldo5Jibnk5O5hTx6XVqsJu4WJ26</code>. Read <a href=\"#tag--authentication\">Authentication</a> for how to log in. </div> # Using the API For simply exploring what the API can do it is strongly recommended to download [Insomnia](https://insomnia.rest/download), a free and open-source API client that\'s great for sending requests to the API in an orderly fashion. Insomnia allows you to send data in the format that\'s required for VRChat\'s API. It is also possible to try out the API in your browser, by first logging in at [vrchat.com/home](https://vrchat.com/home/) and then going to [vrchat.com/api/1/auth/user](https://vrchat.com/api/1/auth/user), but the information will be much harder to work with. For more permanent operation such as software development it is instead recommended to use one of the existing language SDKs. This community project maintains API libraries in several languages, which allows you to interact with the API with simple function calls rather than having to implement the HTTP protocol yourself. Most of these libraries are automatically generated from the API specification, sometimes with additional helpful wrapper code to make usage easier. This allows them to be almost automatically updated and expanded upon as soon as a new feature is introduced in the specification itself. The libraries can be found on [GitHub](https://github.com/vrchatapi) or following: * [NodeJS (JavaScript)](https://www.npmjs.com/package/vrchat) * [Dart](https://pub.dev/packages/vrchat_dart) * [Rust](https://crates.io/crates/vrchatapi) * [C#](github.com/vrchatapi/vrchatapi-csharp) * [Python](https://github.com/vrchatapi/VRChatPython) # Pagination Most endpoints enforce pagination, meaning they will only return 10 entries by default, and never more than 100.<br> Using both the limit and offset parameters allows you to easily paginate through a large number of objects. | Query Parameter | Type | Description | | ----------|--|------- | | `limit` | integer | The number of objects to return. This value often defaults to 10. Highest limit is always 100.| | `offset` | integer | A zero-based offset from the default object sorting.| If a request returns fewer objects than the `limit` parameter, there are no more items available to return. # Contribution Do you want to get involved in the documentation effort? Do you want to help improve one of the language API libraries? This project is an [OPEN Open Source Project](https://openopensource.org)! This means that individuals making significant and valuable contributions are given commit-access to the project. It also means we are very open and welcoming of new people making contributions, unlike some more guarded open-source projects. [![Discord](https://img.shields.io/static/v1?label=vrchatapi&message=discord&color=blueviolet&style=for-the-badge)](https://discord.gg/qjZE9C9fkB)
7
- *
8
- * The version of the OpenAPI document: 1.0.2
9
- * Contact: me@ruby.js.org
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
16
- if (k2 === undefined) k2 = k;
17
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
18
- }) : (function(o, m, k, k2) {
19
- if (k2 === undefined) k2 = k;
20
- o[k2] = m[k];
21
- }));
22
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
23
- for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
24
- };
25
- Object.defineProperty(exports, "__esModule", { value: true });
26
- __exportStar(require("./api"), exports);
27
- __exportStar(require("./configuration"), exports);
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * VRChat API Documentation
6
+ *
7
+ * The version of the OpenAPI document: 1.3.1
8
+ * Contact: me@ruby.js.org
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
15
+ if (k2 === undefined) k2 = k;
16
+ Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
17
+ }) : (function(o, m, k, k2) {
18
+ if (k2 === undefined) k2 = k;
19
+ o[k2] = m[k];
20
+ }));
21
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
22
+ for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
23
+ };
24
+ Object.defineProperty(exports, "__esModule", { value: true });
25
+ __exportStar(require("./api"), exports);
26
+ __exportStar(require("./configuration"), exports);
package/example.js CHANGED
@@ -1,22 +1,22 @@
1
- const vrchat = require("vrchat");
2
- const configuration = new vrchat.Configuration({
3
- username: "username",
4
- password: "password"
5
- });
6
-
7
- const AuthenticationApi = new vrchat.AuthenticationApi(configuration);
8
- const UsersApi = new vrchat.UsersApi(configuration);
9
- const SystemApi = new vrchat.SystemApi(configuration);
10
-
11
- SystemApi.getCurrentOnlineUsers().then(resp => {
12
- console.log(`Current Online Users: ${resp.data}`);
13
-
14
- // Calling getCurrentUser on Authentication API logs you in if the user isn't already logged in.
15
- AuthenticationApi.getCurrentUser().then(resp => {
16
- console.log(`Logged in as: ${resp.data.displayName}`);
17
-
18
- UsersApi.getUser("usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469").then(resp => {
19
- console.log(resp.data.displayName); // Should print out "tupper"
20
- });
21
- });
1
+ const vrchat = require("vrchat");
2
+ const configuration = new vrchat.Configuration({
3
+ username: "username",
4
+ password: "password"
5
+ });
6
+
7
+ const AuthenticationApi = new vrchat.AuthenticationApi(configuration);
8
+ const UsersApi = new vrchat.UsersApi(configuration);
9
+ const SystemApi = new vrchat.SystemApi(configuration);
10
+
11
+ SystemApi.getCurrentOnlineUsers().then(resp => {
12
+ console.log(`Current Online Users: ${resp.data}`);
13
+
14
+ // Calling getCurrentUser on Authentication API logs you in if the user isn't already logged in.
15
+ AuthenticationApi.getCurrentUser().then(resp => {
16
+ console.log(`Logged in as: ${resp.data.displayName}`);
17
+
18
+ UsersApi.getUser("usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469").then(resp => {
19
+ console.log(resp.data.displayName); // Should print out "tupper"
20
+ });
21
+ });
22
22
  });
package/generate.sh CHANGED
@@ -1,25 +1,30 @@
1
- #!/bin/bash
2
-
3
- rm *.ts -rf
4
- openapi-generator-cli generate \
5
- -g typescript-axios \
6
- --additional-properties=npmName=vrchat \
7
- --git-user-id=vrchatapi \
8
- --git-repo-id=vrchatapi-javascript \
9
- -o . \
10
- -i https://vrchatapi.github.io/specification/openapi.yaml \
11
- --http-user-agent="vrchatapi-javascript"
12
-
13
- # Modify package.json
14
- sed -i 's/OpenAPI client for vrchat/🟡đŸ”ĩ VRChat API Library for JavaScript and TypeScript/g' ./package.json
15
- sed -i 's/Unlicense/MIT/g' ./package.json
16
-
17
- # Enable global cookies
18
- sed -i '/^import { BASE_PATH/a import axiosCookieJarSupport from "axios-cookiejar-support";axiosCookieJarSupport(globalAxios);import { CookieJar } from "tough-cookie";globalAxios.defaults.jar = new CookieJar();globalAxios.defaults.withCredentials = true;' ./api.ts
19
-
20
- sed -i '/"dependencies"/a "@types/tough-cookie": "^4.0.1",' ./package.json
21
- sed -i '/"dependencies"/a "axios-cookiejar-support": "^1.0.1",' ./package.json
22
- sed -i '/"dependencies"/a "tough-cookie": "^4.0.0",' ./package.json
23
-
24
- npm install
1
+ #!/bin/bash
2
+
3
+ rm *.ts -rf
4
+ openapi-generator-cli generate \
5
+ -g typescript-axios \
6
+ --additional-properties=npmName=vrchat \
7
+ --git-user-id=vrchatapi \
8
+ --git-repo-id=vrchatapi-javascript \
9
+ -o . \
10
+ -i https://vrchatapi.github.io/specification/openapi.yaml \
11
+ --http-user-agent="vrchatapi-javascript"
12
+
13
+ # Modify package.json
14
+ sed -i 's/OpenAPI client for vrchat/🟡đŸ”ĩ VRChat API Library for JavaScript and TypeScript/g' ./package.json
15
+ sed -i 's/Unlicense/MIT/g' ./package.json
16
+
17
+ # Enable global cookies
18
+ sed -i '/^import { BASE_PATH/a import axiosCookieJarSupport from "axios-cookiejar-support";axiosCookieJarSupport(globalAxios);import { CookieJar } from "tough-cookie";globalAxios.defaults.jar = new CookieJar();globalAxios.defaults.withCredentials = true;' ./api.ts
19
+
20
+ sed -i '/"dependencies"/a "@types/tough-cookie": "^4.0.1",' ./package.json
21
+ sed -i '/"dependencies"/a "axios-cookiejar-support": "^1.0.1",' ./package.json
22
+ sed -i '/"dependencies"/a "tough-cookie": "^4.0.0",' ./package.json
23
+
24
+ # Remove messily pasted markdown at top of every file
25
+ for i in *.ts; do
26
+ sed -i '/VRChat API Banner/d' $i
27
+ done
28
+
29
+ npm install
25
30
  npm run build
package/index.ts CHANGED
@@ -2,9 +2,8 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * VRChat API Documentation
5
- * ![VRChat API Banner](https://vrchatapi.github.io/assets/img/api_banner_1500x400.png) # Welcome to the VRChat API Before we begin, we would like to state this is a **COMMUNITY DRIVEN PROJECT**. This means that everything you read on here was written by the community itself and is **not** officially supported by VRChat. The documentation is provided \"AS IS\", and any action you take towards VRChat is completely your own responsibility. The documentation and additional libraries SHALL ONLY be used for applications interacting with VRChat\'s API in accordance with their [Terms of Service](https://github.com/VRChatAPI), and MUST NOT be used for modifying the client, \"avatar ripping\", or other illegal activities. Malicious usage or spamming the API may result in account termination. Certain parts of the API are also more sensitive than others, for example moderation, so please read tread extra carefully and read the warnings when present. ![Tupper Policy on API](https://i.imgur.com/yLlW7Ok.png) Finally, use of the API using applications other than the approved methods (website, VRChat application, Unity SDK) is not officially supported. VRChat provides no guarantee or support for external applications using the API. Access to API endpoints may break **at any time, without notice**. Therefore, please **do not ping** VRChat Staff in the VRChat Discord if you are having API problems, as they do not provide API support. We will make a best effort in keeping this documentation and associated language libraries up to date, but things might be outdated or missing. If you find that something is no longer valid, please contact us on Discord or [create an issue](https://github.com/vrchatapi/specification/issues) and tell us so we can fix it. # Getting Started The VRChat API can be used to programmatically retrieve or update information regarding your profile, friends, avatars, worlds and more. The API consists of two parts, \"Photon\" which is only used in-game, and the \"Web API\" which is used by both the game and the website. This documentation focuses only on the Web API. The API is designed around the REST ideology, providing semi-simple and usually predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. <div class=\"callout callout-error\"> <strong>🛑 Warning! Do not touch Photon!</strong><br> Photon is only used by the in-game client and should <b>not</b> be touched. Doing so may result in permanent account termination. </div> <div class=\"callout callout-info\"> <strong>â„šī¸ API Key and Authentication</strong><br> The API Key has always been the same and is currently <code>JlE5Jldo5Jibnk5O5hTx6XVqsJu4WJ26</code>. Read <a href=\"#tag--authentication\">Authentication</a> for how to log in. </div> # Using the API For simply exploring what the API can do it is strongly recommended to download [Insomnia](https://insomnia.rest/download), a free and open-source API client that\'s great for sending requests to the API in an orderly fashion. Insomnia allows you to send data in the format that\'s required for VRChat\'s API. It is also possible to try out the API in your browser, by first logging in at [vrchat.com/home](https://vrchat.com/home/) and then going to [vrchat.com/api/1/auth/user](https://vrchat.com/api/1/auth/user), but the information will be much harder to work with. For more permanent operation such as software development it is instead recommended to use one of the existing language SDKs. This community project maintains API libraries in several languages, which allows you to interact with the API with simple function calls rather than having to implement the HTTP protocol yourself. Most of these libraries are automatically generated from the API specification, sometimes with additional helpful wrapper code to make usage easier. This allows them to be almost automatically updated and expanded upon as soon as a new feature is introduced in the specification itself. The libraries can be found on [GitHub](https://github.com/vrchatapi) or following: * [NodeJS (JavaScript)](https://www.npmjs.com/package/vrchat) * [Dart](https://pub.dev/packages/vrchat_dart) * [Rust](https://crates.io/crates/vrchatapi) * [C#](github.com/vrchatapi/vrchatapi-csharp) * [Python](https://github.com/vrchatapi/VRChatPython) # Pagination Most endpoints enforce pagination, meaning they will only return 10 entries by default, and never more than 100.<br> Using both the limit and offset parameters allows you to easily paginate through a large number of objects. | Query Parameter | Type | Description | | ----------|--|------- | | `limit` | integer | The number of objects to return. This value often defaults to 10. Highest limit is always 100.| | `offset` | integer | A zero-based offset from the default object sorting.| If a request returns fewer objects than the `limit` parameter, there are no more items available to return. # Contribution Do you want to get involved in the documentation effort? Do you want to help improve one of the language API libraries? This project is an [OPEN Open Source Project](https://openopensource.org)! This means that individuals making significant and valuable contributions are given commit-access to the project. It also means we are very open and welcoming of new people making contributions, unlike some more guarded open-source projects. [![Discord](https://img.shields.io/static/v1?label=vrchatapi&message=discord&color=blueviolet&style=for-the-badge)](https://discord.gg/qjZE9C9fkB)
6
5
  *
7
- * The version of the OpenAPI document: 1.0.2
6
+ * The version of the OpenAPI document: 1.3.1
8
7
  * Contact: me@ruby.js.org
9
8
  *
10
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/openapitools.json CHANGED
@@ -1,7 +1,7 @@
1
- {
2
- "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
3
- "spaces": 2,
4
- "generator-cli": {
5
- "version": "5.2.0"
6
- }
7
- }
1
+ {
2
+ "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
3
+ "spaces": 2,
4
+ "generator-cli": {
5
+ "version": "5.2.0"
6
+ }
7
+ }