v1.3.0

Author: zeplin-dev

src/apis/organizations-api.ts

@@ -531,11 +531,11 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
         /**
          * List all organizations that user is a member of
          * @summary Get organizations
-         * @param {Set<'owner' | 'admin' | 'editor' | 'member'>} [role] Filter by role  **Note:** Please prefer multiple parameter instances over comma-separated values.  Example: &#x60;?role&#x3D;owner&amp;role&#x3D;admin&#x60; 
+         * @param {Set<'owner' | 'admin' | 'editor' | 'member' | 'alien'>} [role] Filter by role  ☝️Note that the Developer role maps to &#x60;member&#x60; and the Reviewer role maps to &#x60;alien&#x60; in the API.  **Note:** Please prefer multiple parameter instances over comma-separated values.  Example: &#x60;?role&#x3D;owner&amp;role&#x3D;admin&#x60; 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getOrganizations: async (role?: Set<'owner' | 'admin' | 'editor' | 'member'>, options: any = {}): Promise<RequestArgs> => {
+        getOrganizations: async (role?: Set<'owner' | 'admin' | 'editor' | 'member' | 'alien'>, options: any = {}): Promise<RequestArgs> => {
             const localVarPath = `/v1/organizations`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -833,11 +833,11 @@ export const OrganizationsApiFp = function(configuration?: Configuration) {
         /**
          * List all organizations that user is a member of
          * @summary Get organizations
-         * @param {Set<'owner' | 'admin' | 'editor' | 'member'>} [role] Filter by role  **Note:** Please prefer multiple parameter instances over comma-separated values.  Example: &#x60;?role&#x3D;owner&amp;role&#x3D;admin&#x60; 
+         * @param {Set<'owner' | 'admin' | 'editor' | 'member' | 'alien'>} [role] Filter by role  ☝️Note that the Developer role maps to &#x60;member&#x60; and the Reviewer role maps to &#x60;alien&#x60; in the API.  **Note:** Please prefer multiple parameter instances over comma-separated values.  Example: &#x60;?role&#x3D;owner&amp;role&#x3D;admin&#x60; 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getOrganizations(role?: Set<'owner' | 'admin' | 'editor' | 'member'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
+        async getOrganizations(role?: Set<'owner' | 'admin' | 'editor' | 'member' | 'alien'>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganizations(role, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -998,11 +998,11 @@ export interface OrganizationsApiGetOrganizationStyleguidesSearchParams {
  */
 export interface OrganizationsApiGetOrganizationsSearchParams {
     /**
-     * Filter by role  **Note:** Please prefer multiple parameter instances over comma-separated values.  Example: &#x60;?role&#x3D;owner&amp;role&#x3D;admin&#x60; 
-     * @type {Set<'owner' | 'admin' | 'editor' | 'member'>}
+     * Filter by role  ☝️Note that the Developer role maps to &#x60;member&#x60; and the Reviewer role maps to &#x60;alien&#x60; in the API.  **Note:** Please prefer multiple parameter instances over comma-separated values.  Example: &#x60;?role&#x3D;owner&amp;role&#x3D;admin&#x60; 
+     * @type {Set<'owner' | 'admin' | 'editor' | 'member' | 'alien'>}
      * @memberof OrganizationsApiGetOrganizationsSearchParams
      */
-    readonly role?: Set<'owner' | 'admin' | 'editor' | 'member'>;
+    readonly role?: Set<'owner' | 'admin' | 'editor' | 'member' | 'alien'>;
 }
 
 

src/models/organization-member-invite-body.ts

@@ -51,7 +51,7 @@ export interface OrganizationMemberInviteBody {
      */
     tags?: Set<string>;
     /**
-     * The role of the user in the organization
+     * The role of the user in the organization  ☝️Note that the Developer role maps to `member` and the Reviewer role maps to `alien` in the API. 
      * @type {string}
      * @memberof OrganizationMemberInviteBody
      */

src/models/organization-member-update-body.ts

@@ -43,7 +43,7 @@ export interface OrganizationMemberUpdateBody {
      */
     tags?: Set<string>;
     /**
-     * The role of the user in the organization
+     * The role of the user in the organization  ☝️Note that the Developer role maps to `member` and the Reviewer role maps to `alien` in the API. 
      * @type {string}
      * @memberof OrganizationMemberUpdateBody
      */

src/models/organization-member.ts

@@ -58,7 +58,7 @@ export interface OrganizationMember {
      */
     tags: Array<string>;
     /**
-     * The role of the user in the organization
+     * The role of the user in the organization  ☝️Note that the Developer role maps to `member` and the Reviewer role maps to `alien` in the API. 
      * @type {string}
      * @memberof OrganizationMember
      */

src/models/user.ts

@@ -37,7 +37,7 @@ export const transformJSONToUser = function (value: any): User {
 }
 
 /**
- * Basic info about Zeplin users.  Note: The email alias (the `email` field) is a Zeplin-only alias, which can be used with the Emailing API to send emails to Zeplin users.  In order a Zeplin app send an email to a Zeplin user:  - Zeplin app should have been approved by Zeplin to use the Emailing API  - The user should authorize the app so that it can send emails to the user through the Zeplin alias.  If you\'re interested in using the Emailing API, reach us at [email protected]. 
+ * Basic info about Zeplin users.  Zeplin API does not expose any personal information to third-party clients. For this reason, the `email` field is a Zeplin-only alias by default.  You can get the original email addresses of members of your workspace by using a personal access token created with admin rights. Third-party (OAuth) applications are not allowed to access this information.  ☝️*Only organization admins (or higher) can retrieve the original email addresses using an admin token.* 
  * @export
  * @interface User
  */