webflow-api 3.3.0-beta → 3.3.1

package/.mock/definition/users.yml

@@ -1,594 +0,0 @@
-types:
-  UsersListRequestSort:
-    enum:
-      - value: CreatedOn
-        name: CreatedOnAscending
-        docs: Sorts users in ascending order based on their created date
-      - value: '-CreatedOn'
-        name: CreatedOnDescending
-        docs: Sorts users in descending order based on their created date
-      - value: Email
-        name: EmailAscending
-        docs: Sorts users in ascending order based on their email
-      - value: '-Email'
-        name: EmailDescending
-        docs: Sorts users in descending order based on their email
-      - value: Status
-        name: StatusAscending
-        docs: Sorts users in ascending order based on their status
-      - value: '-Status'
-        name: StatusDescending
-        docs: Sorts users in descending order based on their status
-      - value: LastLogin
-        name: LastLoginAscending
-        docs: Sorts users in ascending order based on their last login date
-      - value: '-LastLogin'
-        name: LastLoginDescending
-        docs: Sorts users in descending order based on their last login date
-      - value: UpdatedOn
-        name: UpdatedOnAscending
-        docs: Sorts users in ascending order based on their update date
-      - value: '-UpdatedOn'
-        name: UpdatedOnDescending
-        docs: Sorts users in descending order based on their update date
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
-  UserAccountAddedPayloadPayloadData:
-    docs: The data about the user account that was added
-    properties:
-      accept-privacy-policy: optional<boolean>
-      accept-communications: optional<boolean>
-      email: optional<string>
-      name: optional<string>
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
-    inline: true
-  UserAccountAddedPayloadPayload:
-    properties:
-      data:
-        type: optional<UserAccountAddedPayloadPayloadData>
-        docs: The data about the user account that was added
-      id:
-        type: optional<string>
-        docs: Unique identifier for the User
-      isEmailVerified:
-        type: optional<boolean>
-        docs: Shows whether the user has verified their email address
-      lastUpdated:
-        type: optional<datetime>
-        docs: The timestamp the user was updated
-      invitedOn:
-        type: optional<datetime>
-        docs: The timestamp the user was invited
-      createdOn:
-        type: optional<datetime>
-        docs: The timestamp the user was created
-      lastLogin:
-        type: optional<datetime>
-        docs: The timestamp the user was logged in
-      status: optional<root.UserStatus>
-      accessGroups:
-        type: optional<list<root.UserAccessGroupsItem>>
-        docs: Access groups the user belongs to
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
-    inline: true
-  UserAccountAddedPayload:
-    properties:
-      triggerType: optional<literal<"user_account_added">>
-      payload: optional<UserAccountAddedPayloadPayload>
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
-  UserAccountUpdatedPayloadPayloadData:
-    docs: The data about the user account that was added
-    properties:
-      accept-privacy-policy: optional<boolean>
-      accept-communications: optional<boolean>
-      email: optional<string>
-      name: optional<string>
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
-    inline: true
-  UserAccountUpdatedPayloadPayload:
-    properties:
-      data:
-        type: optional<UserAccountUpdatedPayloadPayloadData>
-        docs: The data about the user account that was added
-      id:
-        type: optional<string>
-        docs: Unique identifier for the User
-      isEmailVerified:
-        type: optional<boolean>
-        docs: Shows whether the user has verified their email address
-      lastUpdated:
-        type: optional<datetime>
-        docs: The timestamp the user was updated
-      invitedOn:
-        type: optional<datetime>
-        docs: The timestamp the user was invited
-      createdOn:
-        type: optional<datetime>
-        docs: The timestamp the user was created
-      lastLogin:
-        type: optional<datetime>
-        docs: The timestamp the user was logged in
-      status: optional<root.UserStatus>
-      accessGroups:
-        type: optional<list<root.UserAccessGroupsItem>>
-        docs: Access groups the user belongs to
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
-    inline: true
-  UserAccountUpdatedPayload:
-    properties:
-      triggerType: optional<literal<"user_account_updated">>
-      payload: optional<UserAccountUpdatedPayloadPayload>
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
-  UserAccountDeletedPayloadPayloadData:
-    docs: The data about the user account that was added
-    properties:
-      accept-privacy-policy: optional<boolean>
-      accept-communications: optional<boolean>
-      email: optional<string>
-      name: optional<string>
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
-    inline: true
-  UserAccountDeletedPayloadPayload:
-    properties:
-      data:
-        type: optional<UserAccountDeletedPayloadPayloadData>
-        docs: The data about the user account that was added
-      id:
-        type: optional<string>
-        docs: Unique identifier for the User
-      isEmailVerified:
-        type: optional<boolean>
-        docs: Shows whether the user has verified their email address
-      lastUpdated:
-        type: optional<datetime>
-        docs: The timestamp the user was updated
-      invitedOn:
-        type: optional<datetime>
-        docs: The timestamp the user was invited
-      createdOn:
-        type: optional<datetime>
-        docs: The timestamp the user was created
-      lastLogin:
-        type: optional<datetime>
-        docs: The timestamp the user was logged in
-      status: optional<root.UserStatus>
-      accessGroups:
-        type: optional<list<root.UserAccessGroupsItem>>
-        docs: Access groups the user belongs to
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
-    inline: true
-  UserAccountDeletedPayload:
-    properties:
-      triggerType: optional<literal<"user_account_deleted">>
-      payload: optional<UserAccountDeletedPayloadPayload>
-    source:
-      openapi: ../../../openapi/referenced-specs/v2.yml
-imports:
-  root: __package__.yml
-service:
-  auth: false
-  base-path: ''
-  endpoints:
-    list:
-      path: /sites/{site_id}/users
-      method: GET
-      auth:
-        - OAuth2:
-            - users:read
-      docs: |
-        Get a list of users for a site
-
-        Required scope | `users:read`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: List Users
-      request:
-        name: UsersListRequest
-        query-parameters:
-          offset:
-            type: optional<double>
-            docs: >-
-              Offset used for pagination if the results have more than limit
-              records
-          limit:
-            type: optional<double>
-            docs: 'Maximum number of records to be returned (max limit: 100)'
-          sort:
-            type: optional<UsersListRequestSort>
-            docs: |
-              Sort string to use when ordering users
-
-              Example(`CreatedOn`, `Email`, `Status`, `LastLogin`, `UpdatedOn`).
-
-              Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`)
-      response:
-        docs: Request was successful
-        type: root.UserList
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.ForbiddenError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          query-parameters:
-            offset: 1.1
-            limit: 1.1
-            sort: CreatedOn
-          response:
-            body:
-              count: 5
-              limit: 5
-              offset: 0
-              total: 201
-              users:
-                - id: 6287ec36a841b25637c663df
-                  isEmailVerified: false
-                  lastUpdated: '2022-05-20T13:46:12Z'
-                  invitedOn: '2016-10-24T19:41:29Z'
-                  createdOn: '2022-05-20T13:46:12Z'
-                  lastLogin: '2016-10-24T19:41:29Z'
-                  status: unverified
-                  accessGroups:
-                    - slug: vogon-construction-crew
-                      type: admin
-                - id: 6287ec36a841b25637c663f0
-                  isEmailVerified: false
-                  lastUpdated: '2022-05-19T05:32:04Z'
-                  invitedOn: '2016-10-24T19:41:29Z'
-                  createdOn: '2022-05-19T05:32:04Z'
-                  lastLogin: '2016-10-24T19:41:29Z'
-                  status: unverified
-                  accessGroups:
-                    - slug: improbability-drive-test-subjects
-                      type: admin
-                - id: 6287ec36a841b25637c663d9
-                  isEmailVerified: true
-                  lastUpdated: '2022-05-17T03:34:06Z'
-                  invitedOn: '2016-10-24T19:41:29Z'
-                  createdOn: '2022-05-17T03:34:06Z'
-                  lastLogin: '2016-10-24T19:41:29Z'
-                  status: verified
-                  accessGroups:
-                    - slug: heart-of-gold-crew
-                      type: admin
-                - id: 6287ec37a841b25637c6641b
-                  isEmailVerified: false
-                  lastUpdated: '2022-05-15T03:46:09Z'
-                  invitedOn: '2016-10-24T19:41:29Z'
-                  createdOn: '2022-05-15T03:46:09Z'
-                  lastLogin: '2016-10-24T19:41:29Z'
-                  status: unverified
-                  accessGroups:
-                    - slug: hitchhikers-guide-research-team
-                      type: admin
-                - id: 6287ec37a841b25637c66449
-                  isEmailVerified: true
-                  lastUpdated: '2022-05-15T02:55:38Z'
-                  invitedOn: '2016-10-24T19:41:29Z'
-                  createdOn: '2022-05-15T02:55:38Z'
-                  lastLogin: '2016-10-24T19:41:29Z'
-                  status: verified
-                  accessGroups:
-                    - slug: milliways-reservationists
-                      type: admin
-    get:
-      path: /sites/{site_id}/users/{user_id}
-      method: GET
-      auth:
-        - OAuth2:
-            - users:read
-      docs: |
-        Get a User by ID
-
-        Required scope | `users:read`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-        user_id:
-          type: string
-          docs: Unique identifier for a User
-      display-name: Get User
-      response:
-        docs: Request was successful
-        type: root.User
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.ForbiddenError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-            user_id: 580e63e98c9a982ac9b8b741
-          response:
-            body:
-              id: 6287ec36a841b25637c663df
-              isEmailVerified: true
-              lastUpdated: '2022-05-20T13:46:12Z'
-              invitedOn: '2022-05-20T13:46:12Z'
-              createdOn: '2022-05-20T13:46:12Z'
-              lastLogin: '2022-05-20T13:46:12Z'
-              status: verified
-              accessGroups:
-                - slug: webflowers
-                  type: admin
-              data:
-                data:
-                  name: name
-                  email: email
-                  accept-privacy: true
-                  accept-communications: true
-                  additionalProperties: additionalProperties
-    delete:
-      path: /sites/{site_id}/users/{user_id}
-      method: DELETE
-      auth:
-        - OAuth2:
-            - users:write
-      docs: |
-        Delete a User by ID
-
-        Required scope | `users:write`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-        user_id:
-          type: string
-          docs: Unique identifier for a User
-      display-name: Delete User
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.ForbiddenError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-            user_id: 580e63e98c9a982ac9b8b741
-    update:
-      path: /sites/{site_id}/users/{user_id}
-      method: PATCH
-      auth:
-        - OAuth2:
-            - users:write
-      docs: |
-        Update a User by ID 
-
-          Required scope | `users:write`
-
-        <Note class="notice">The <code>email</code> and <code>password</code>
-        fields cannot be updated using this endpoint</Note>
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-        user_id:
-          type: string
-          docs: Unique identifier for a User
-      display-name: Update User
-      request:
-        body: root.User
-        content-type: application/json
-      response:
-        docs: Request was successful
-        type: root.User
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.ForbiddenError
-        - root.NotFoundError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-            user_id: 580e63e98c9a982ac9b8b741
-          request:
-            id: 6287ec36a841b25637c663df
-            isEmailVerified: true
-            lastUpdated: '2022-05-20T13:46:12Z'
-            invitedOn: '2022-05-20T13:46:12Z'
-            createdOn: '2022-05-20T13:46:12Z'
-            lastLogin: '2022-05-20T13:46:12Z'
-            status: verified
-            accessGroups:
-              - slug: webflowers
-                type: admin
-          response:
-            body:
-              id: 6287ec36a841b25637c663df
-              isEmailVerified: true
-              lastUpdated: '2022-05-20T13:46:12Z'
-              invitedOn: '2022-05-20T13:46:12Z'
-              createdOn: '2022-05-20T13:46:12Z'
-              lastLogin: '2022-05-20T13:46:12Z'
-              status: verified
-              accessGroups:
-                - slug: webflowers
-                  type: admin
-              data:
-                data:
-                  name: name
-                  email: email
-                  accept-privacy: true
-                  accept-communications: true
-                  additionalProperties: additionalProperties
-    invite:
-      path: /sites/{site_id}/users/invite
-      method: POST
-      auth:
-        - OAuth2:
-            - users:write
-      docs: >
-        Create and invite a user with an email address. 
-
-
-        The user will be sent and invite via email, which they will need to
-        accept in order to join paid any paid access group. 
-
-
-        Required scope | `users:write`
-      source:
-        openapi: ../../../openapi/referenced-specs/v2.yml
-      path-parameters:
-        site_id:
-          type: string
-          docs: Unique identifier for a Site
-      display-name: Create and Invite a User
-      request:
-        name: UsersInviteRequest
-        body:
-          properties:
-            email:
-              type: string
-              docs: Email address of user to send invite to
-              validation:
-                format: email
-            accessGroups:
-              type: optional<list<string>>
-              docs: >
-                An array of access group slugs. Access groups are assigned to
-                the user as type `admin` and the user remains in the group until
-                removed.
-        content-type: application/json
-      response:
-        docs: Request was successful
-        type: root.User
-        status-code: 200
-      errors:
-        - root.BadRequestError
-        - root.UnauthorizedError
-        - root.ForbiddenError
-        - root.NotFoundError
-        - root.ConflictError
-        - root.TooManyRequestsError
-        - root.InternalServerError
-      examples:
-        - path-parameters:
-            site_id: 580e63e98c9a982ac9b8b741
-          request:
-            email: some.one@home.com
-            accessGroups:
-              - accessGroups
-          response:
-            body:
-              id: 6287ec36a841b25637c663df
-              isEmailVerified: true
-              lastUpdated: '2022-05-20T13:46:12Z'
-              invitedOn: '2022-05-20T13:46:12Z'
-              createdOn: '2022-05-20T13:46:12Z'
-              lastLogin: '2022-05-20T13:46:12Z'
-              status: verified
-              accessGroups:
-                - slug: webflowers
-                  type: admin
-              data:
-                data:
-                  name: name
-                  email: email
-                  accept-privacy: true
-                  accept-communications: true
-                  additionalProperties: additionalProperties
-  source:
-    openapi: ../../../openapi/referenced-specs/v2.yml
-webhooks:
-  user_account_added:
-    audiences: []
-    method: POST
-    display-name: New User Added
-    headers: {}
-    payload: UserAccountAddedPayload
-    examples:
-      - payload:
-          triggerType: user_account_added
-          payload:
-            id: 6287ec36a841b25637c663df
-            lastUpdated: '2022-05-20T13:46:12.093Z'
-            createdOn: '2022-05-20T13:46:12.093Z'
-            isEmailVerified: false
-            data:
-              accept-privacy: false
-              accept-communications: false
-              email: arthur.dent@heartofgold.ship
-              name: Arthur Dent
-            accessGroups:
-              - slug: webflowers
-                type: admin
-    docs: Information about a new user account
-  user_account_updated:
-    audiences: []
-    method: POST
-    display-name: Account Updated
-    headers: {}
-    payload: UserAccountUpdatedPayload
-    examples:
-      - payload:
-          triggerType: user_account_updated
-          payload:
-            id: 6287ec36a841b25637c663df
-            lastUpdated: '2022-05-20T13:46:12.093Z'
-            createdOn: '2022-05-20T13:46:12.093Z'
-            isEmailVerified: false
-            data:
-              accept-privacy: false
-              accept-communications: false
-              email: arthur.dent@heartofgold.ship
-              name: Arthur Dent
-            accessGroups:
-              - slug: webflowers
-                type: admin
-    docs: Information about an updated user account
-  user_account_deleted:
-    audiences: []
-    method: POST
-    display-name: Account Deleted
-    headers: {}
-    payload: UserAccountDeletedPayload
-    examples:
-      - payload:
-          triggerType: user_account_deleted
-          payload:
-            id: 6287ec36a841b25637c663df
-            lastUpdated: '2022-05-20T13:46:12.093Z'
-            createdOn: '2022-05-20T13:46:12.093Z'
-            isEmailVerified: false
-            data:
-              accept-privacy: false
-              accept-communications: false
-              email: arthur.dent@heartofgold.ship
-              name: Arthur Dent
-            accessGroups:
-              - slug: webflowers
-                type: admin
-    docs: Information about a deleted user account