aspera-cli 4.26.1 → 4.26.2

data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml

@@ -1,3 +1,8 @@
+# DO NOT EDIT THIS FILE MANUALLY
+# This file is automatically downloaded from:
+# https://raw.githubusercontent.com/laurent-martin/aspera-api-examples/refs/heads/main/openapi/IBM%20Aspera%20on%20Cloud%20API-0.2.6-enhanced.yaml
+# Use 'rake tools:openapi' to update this file
+
 openapi: 3.1.0
 info:
   title: Aspera on Cloud and Aspera Enterprise Web Apps
@@ -574,9 +579,14 @@ paths:
       parameters:
         - name: aspera_app_type
           in: query
-          description: Can be "activity" or "automation".
+          description: Can be "activity", "automation", "files" or "packages".
           schema:
             type: string
+            enum:
+              - activity
+              - automation
+              - files
+              - packages
         - name: created_at
           in: query
           schema:
@@ -605,9 +615,13 @@ paths:
             type: string
         - name: member_type
           in: query
-          description: Can be "user" or "group".
+          description: Can be "user", "group" or "workspace".
           schema:
             type: string
+            enum:
+              - user
+              - group
+              - workspace
         - name: q
           in: query
           description: Searches member.email and member.name.
@@ -718,7 +732,7 @@ paths:
       operationId: add_app_membership
       summary: Create a New App Membership
       description: |
-        Create an app membership. Requires organization admin permission.
+        Create an app membership. Requires organization admin or workspace manager permission.
       parameters:
         - name: aspera_app_type
           in: path
@@ -728,6 +742,8 @@ paths:
             enum:
               - activity
               - automation
+              - files
+              - packages
       requestBody:
         required: true
         content:
@@ -763,6 +779,179 @@ paths:
           description: Internal Server Error
       tags:
         - App Memberships
+    get:
+      operationId: get_app_memberships_by_app_type
+      summary: Get a Listing of App Memberships Filtered by App Type
+      description: |
+        Get a listing of app memberships for a specific app type. For organization admins, all app memberships for the entire organization are available to view. For all other users, only your own app memberships are returned.
+      parameters:
+        - name: aspera_app_type
+          in: path
+          required: true
+          schema:
+            type: string
+            enum:
+              - activity
+              - automation
+              - files
+              - packages
+        - name: inherited
+          in: query
+          description: |
+            Set to false if you want to filter out inherited memberships.
+          schema:
+            type: boolean
+        - name: member_id
+          in: query
+          description: Filter by member ID.
+          schema:
+            type: string
+        - name: member_type
+          in: query
+          description: Can be "user", "group" or "workspace".
+          schema:
+            type: string
+        - name: q
+          in: query
+          description: Searches member.email and member.name (and workspace/group name).
+          schema:
+            type: string
+        - name: sort
+          in: query
+          description: Specify a field for sorting results.
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/app_memberships_response'
+        '400':
+          description: Bad Request
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UnauthorizedError'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NotFoundError'
+        '500':
+          description: Internal Server Error
+      tags:
+        - App Memberships
+  /apps/{aspera_app_type}/app_memberships/{id}:
+    get:
+      operationId: get_app_membership_by_app_type_and_id
+      summary: Get Information About a Specific App Membership by App Type
+      description: |
+        Get information about a specific app membership, specified by app type and membership ID.
+      parameters:
+        - name: aspera_app_type
+          in: path
+          required: true
+          schema:
+            type: string
+            enum:
+              - activity
+              - automation
+              - files
+              - packages
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/app_memberships_response'
+        '400':
+          description: Bad Request
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UnauthorizedError'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NotFoundError'
+        '500':
+          description: Internal Server Error
+      tags:
+        - App Memberships
+    put:
+      operationId: update_app_membership
+      summary: Update a Specific App Membership
+      description: |
+        Update an app membership, specified by app type and membership ID. Requires organization admin or workspace manager permission.
+        Note: changing the member is not allowed.
+      parameters:
+        - name: aspera_app_type
+          in: path
+          required: true
+          schema:
+            type: string
+            enum:
+              - activity
+              - automation
+              - files
+              - packages
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/app_memberships_params'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/app_memberships_response'
+        '400':
+          description: Bad Request
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UnauthorizedError'
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NotFoundError'
+        '422':
+          description: Unprocessable Entity
+        '500':
+          description: Internal Server Error
+      tags:
+        - App Memberships
   /client_access_keys:
     get:
       operationId: get_client_access_keys
@@ -4848,91 +5037,413 @@ paths:
       tags:
         - Contacts
         - Contacts
-components:
-  schemas:
-    UnauthorizedError:
-      type: object
-      properties:
-        code:
-          type: string
-          description: Error code
-          example: unauthorized
-        message:
-          type: string
-          description: Error message
-          example: You are not authorized to perform the requested action
-      required:
-        - code
-        - message
-    OAuth2TokenError:
-      type: object
-      description: |
-        OAuth 2.0 error response returned by token endpoint as defined in RFC 6749 section 5.2.
-        This error format is used for all OAuth 2.0 token-related errors including authorization code exchange,
-        refresh token usage, and URL token authentication.
-      properties:
-        error:
-          type: string
-          description: OAuth 2.0 error code indicating the type of error
-          enum:
-            - invalid_request
-            - invalid_client
-            - invalid_grant
-            - unauthorized_client
-            - unsupported_grant_type
-            - invalid_scope
-            - access_denied
-          example: invalid_grant
-        error_description:
-          type: string
-          description: Human-readable error description providing additional context about the error
-          example: invalid URL token
-        state:
-          type: string
-          nullable: true
-          description: State parameter from the authorization request, if present. Used to maintain state between request and callback.
-      required:
-        - error
-        - state
-      example:
-        error: invalid_grant
-        error_description: invalid URL token
-        state: null
-    ValidationError:
-      type: object
-      description: |
-        Standard validation error response for API v1 endpoints (422 Unprocessable Entity).
-        Returned when request parameters are missing, invalid, or violate business rules.
-      properties:
-        code:
-          type: string
-          description: Error code identifying the type of validation error
-          enum:
-            - parameter_missing
-            - unpermitted_parameters
-            - invalid_parameter_value
-            - unknown_sort_field
-            - too_many_sort_fields
-          example: parameter_missing
-        message:
-          type: string
-          description: Human-readable error message
-          example: param is missing or the value is empty
-        param:
-          type: string
-          description: Name of the problematic parameter (for parameter_missing, invalid_parameter_value, unknown_sort_field)
-          example: aspera_app_type or workspace_id must be present
-        params:
-          type: array
-          description: List of unpermitted parameters (for unpermitted_parameters error)
-          items:
-            type: string
-          example: ["invalid_param1", "invalid_param2"]
-        request_id:
-          type: string
-          format: uuid
-          description: Unique identifier for the request, useful for debugging and support
-          example: 910723e1-d7ac-4d01-9b4a-5949cf870f98
+  /configuration_policies:
+    get:
+      operationId: get_configuration_policies
+      summary: List Configuration Policies
+      description: Get a listing of configuration policies for your organization.
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/configuration_policy_response'
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UnauthorizedError'
+        '500':
+          description: Internal Server Error
+      tags:
+        - Configuration Policies
+    post:
+      operationId: create_configuration_policy
+      summary: Create a Configuration Policy
+      description: Create a new configuration policy for your organization.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/configuration_policy_params'
+      responses:
+        '201':
+          description: Created
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/configuration_policy_response'
+        '400':
+          description: Bad Request
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UnauthorizedError'
+        '422':
+          description: Unprocessable Entity
+        '500':
+          description: Internal Server Error
+      tags:
+        - Configuration Policies
+  /configuration_policies/{id}:
+    delete:
+      operationId: delete_configuration_policy
+      summary: Delete a Configuration Policy
+      description: Delete a specific configuration policy by ID.
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: No Content
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UnauthorizedError'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NotFoundError'
+        '500':
+          description: Internal Server Error
+      tags:
+        - Configuration Policies
+    get:
+      operationId: get_configuration_policy
+      summary: Get a Configuration Policy
+      description: Get a specific configuration policy by ID.
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/configuration_policy_response'
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UnauthorizedError'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NotFoundError'
+        '500':
+          description: Internal Server Error
+      tags:
+        - Configuration Policies
+    put:
+      operationId: update_configuration_policy
+      summary: Update a Configuration Policy
+      description: Update a specific configuration policy by ID.
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/configuration_policy_params'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/configuration_policy_response'
+        '400':
+          description: Bad Request
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UnauthorizedError'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NotFoundError'
+        '422':
+          description: Unprocessable Entity
+        '500':
+          description: Internal Server Error
+      tags:
+        - Configuration Policies
+  /network_policies:
+    get:
+      operationId: get_network_policies
+      summary: List Network Policies
+      description: Get a listing of network policies for your organization.
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/network_policy_response'
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UnauthorizedError'
+        '500':
+          description: Internal Server Error
+      tags:
+        - Network Policies
+    post:
+      operationId: create_network_policy
+      summary: Create a Network Policy
+      description: Create a new network policy for your organization.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/network_policy_params'
+      responses:
+        '201':
+          description: Created
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/network_policy_response'
+        '400':
+          description: Bad Request
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UnauthorizedError'
+        '422':
+          description: Unprocessable Entity
+        '500':
+          description: Internal Server Error
+      tags:
+        - Network Policies
+  /network_policies/{id}:
+    delete:
+      operationId: delete_network_policy
+      summary: Delete a Network Policy
+      description: Delete a specific network policy by ID.
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: No Content
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UnauthorizedError'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NotFoundError'
+        '500':
+          description: Internal Server Error
+      tags:
+        - Network Policies
+    get:
+      operationId: get_network_policy
+      summary: Get a Network Policy
+      description: Get a specific network policy by ID.
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/network_policy_response'
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UnauthorizedError'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NotFoundError'
+        '500':
+          description: Internal Server Error
+      tags:
+        - Network Policies
+    put:
+      operationId: update_network_policy
+      summary: Update a Network Policy
+      description: Update a specific network policy by ID.
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/network_policy_params'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/network_policy_response'
+        '400':
+          description: Bad Request
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UnauthorizedError'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NotFoundError'
+        '422':
+          description: Unprocessable Entity
+        '500':
+          description: Internal Server Error
+      tags:
+        - Network Policies
+components:
+  schemas:
+    UnauthorizedError:
+      type: object
+      properties:
+        code:
+          type: string
+          description: Error code
+          example: unauthorized
+        message:
+          type: string
+          description: Error message
+          example: You are not authorized to perform the requested action
+      required:
+        - code
+        - message
+    OAuth2TokenError:
+      type: object
+      description: |
+        OAuth 2.0 error response returned by token endpoint as defined in RFC 6749 section 5.2.
+        This error format is used for all OAuth 2.0 token-related errors including authorization code exchange,
+        refresh token usage, and URL token authentication.
+      properties:
+        error:
+          type: string
+          description: OAuth 2.0 error code indicating the type of error
+          enum:
+            - invalid_request
+            - invalid_client
+            - invalid_grant
+            - unauthorized_client
+            - unsupported_grant_type
+            - invalid_scope
+            - access_denied
+          example: invalid_grant
+        error_description:
+          type: string
+          description: Human-readable error description providing additional context about the error
+          example: invalid URL token
+        state:
+          type: string
+          nullable: true
+          description: State parameter from the authorization request, if present. Used to maintain state between request and callback.
+      required:
+        - error
+        - state
+      example:
+        error: invalid_grant
+        error_description: invalid URL token
+        state: null
+    ValidationError:
+      type: object
+      description: |
+        Standard validation error response for API v1 endpoints (422 Unprocessable Entity).
+        Returned when request parameters are missing, invalid, or violate business rules.
+      properties:
+        code:
+          type: string
+          description: Error code identifying the type of validation error
+          enum:
+            - parameter_missing
+            - unpermitted_parameters
+            - invalid_parameter_value
+            - unknown_sort_field
+            - too_many_sort_fields
+          example: parameter_missing
+        message:
+          type: string
+          description: Human-readable error message
+          example: param is missing or the value is empty
+        param:
+          type: string
+          description: Name of the problematic parameter (for parameter_missing, invalid_parameter_value, unknown_sort_field)
+          example: aspera_app_type or workspace_id must be present
+        params:
+          type: array
+          description: List of unpermitted parameters (for unpermitted_parameters error)
+          items:
+            type: string
+          example: ["invalid_param1", "invalid_param2"]
+        request_id:
+          type: string
+          format: uuid
+          description: Unique identifier for the request, useful for debugging and support
+          example: 910723e1-d7ac-4d01-9b4a-5949cf870f98
       required:
         - code
         - message
@@ -5583,6 +6094,7 @@ components:
           enum:
             - user
             - group
+            - workspace
     app_memberships_response:
       type: object
       properties:
@@ -5599,6 +6111,8 @@ components:
           enum:
             - activity
             - automation
+            - files
+            - packages
         id:
           description: ID of the app membership.
           type: string
@@ -5609,7 +6123,12 @@ components:
           examples:
             - '213'
         member_type:
+          description: Type of member. Can be "user", "group" or "workspace".
           type: string
+          enum:
+            - user
+            - group
+            - workspace
     app_settings_base:
       type: object
       description: Common settings properties for all application types
@@ -8810,6 +9329,226 @@ components:
         - name
         - source_id
         - source_type
+    configuration_policy_response:
+      type: object
+      properties:
+        id:
+          description: Unique identifier of the configuration policy.
+          type: string
+          examples:
+            - '7'
+        name:
+          description: Name of the configuration policy.
+          type: string
+          examples:
+            - Server-Side Encryption At Rest w/150Mbps target rate
+        organization_id:
+          description: ID of the organization this policy belongs to.
+          type: string
+          examples:
+            - '28453'
+        activity_event_logging:
+          description: Whether activity event logging is enabled.
+          type: boolean
+          examples:
+            - true
+        aej_logging_enabled:
+          description: Whether AEJ logging is enabled.
+          type: boolean
+          examples:
+            - true
+        aggressiveness:
+          description: Transfer aggressiveness factor (0.0 to 1.0). Null means use node default.
+          type: number
+          format: float
+          nullable: true
+          examples:
+            - 0.15
+        cipher:
+          description: Encryption cipher used for transfers.
+          type: string
+          enum:
+            - aes-128
+            - aes-192
+            - aes-256
+          examples:
+            - aes-128
+        content_protection_secret:
+          description: Secret used for content protection (server-side encryption at rest). Null if not set.
+          type: string
+          nullable: true
+          examples:
+            - aspera-1
+        default_target_rate_kbps:
+          description: Default target transfer rate in kbps. Null means no limit.
+          type: integer
+          nullable: true
+          examples:
+            - 150000
+        enable_iteration_token_pagination:
+          description: Whether iteration token pagination is enabled for directory listings.
+          type: boolean
+          examples:
+            - false
+        recursive_counts:
+          description: Whether recursive file counts are enabled.
+          type: boolean
+          examples:
+            - true
+        remove_skipped:
+          description: Whether skipped files are removed from transfer results.
+          type: boolean
+          examples:
+            - false
+        created_at:
+          description: Date at which the configuration policy was created.
+          type: string
+          format: date-time
+          examples:
+            - '2018-05-03T16:07:03.000Z'
+        updated_at:
+          description: Date at which the configuration policy was last updated.
+          type: string
+          format: date-time
+          examples:
+            - '2018-05-03T16:07:03.000Z'
+    configuration_policy_params:
+      type: object
+      required:
+        - name
+      properties:
+        name:
+          description: Name of the configuration policy.
+          type: string
+          examples:
+            - Server-Side Encryption At Rest w/150Mbps target rate
+        activity_event_logging:
+          description: Whether activity event logging is enabled.
+          type: boolean
+          examples:
+            - true
+        aej_logging_enabled:
+          description: Whether AEJ logging is enabled.
+          type: boolean
+          examples:
+            - true
+        aggressiveness:
+          description: Transfer aggressiveness factor (0.0 to 1.0). Null means use node default.
+          type: number
+          format: float
+          nullable: true
+          examples:
+            - 0.15
+        cipher:
+          description: Encryption cipher used for transfers.
+          type: string
+          enum:
+            - aes-128
+            - aes-192
+            - aes-256
+          examples:
+            - aes-128
+        content_protection_secret:
+          description: Secret used for content protection (server-side encryption at rest). Null if not set.
+          type: string
+          nullable: true
+          examples:
+            - aspera-1
+        default_target_rate_kbps:
+          description: Default target transfer rate in kbps. Null means no limit.
+          type: integer
+          nullable: true
+          examples:
+            - 150000
+        enable_iteration_token_pagination:
+          description: Whether iteration token pagination is enabled for directory listings.
+          type: boolean
+          examples:
+            - false
+        recursive_counts:
+          description: Whether recursive file counts are enabled.
+          type: boolean
+          examples:
+            - true
+        remove_skipped:
+          description: Whether skipped files are removed from transfer results.
+          type: boolean
+          examples:
+            - false
+    network_policy_response:
+      type: object
+      properties:
+        id:
+          description: Unique identifier of the network policy.
+          type: string
+          examples:
+            - '35'
+        name:
+          description: Name of the network policy.
+          type: string
+          examples:
+            - Receive server initiates
+        organization_id:
+          description: ID of the organization this policy belongs to.
+          type: string
+          examples:
+            - '28453'
+        initiation_policy_type:
+          description: Defines which side initiates the transfer connection.
+          type: string
+          enum:
+            - all
+            - none
+            - listed
+          examples:
+            - all
+        access_control_type:
+          description: Defines the access control behaviour for this network policy.
+          type: string
+          enum:
+            - allow_following
+            - none
+          examples:
+            - allow_following
+        created_at:
+          description: Date at which the network policy was created.
+          type: string
+          format: date-time
+          examples:
+            - '2018-05-03T16:07:03.000Z'
+        updated_at:
+          description: Date at which the network policy was last updated.
+          type: string
+          format: date-time
+          examples:
+            - '2018-05-03T16:07:03.000Z'
+    network_policy_params:
+      type: object
+      required:
+        - name
+      properties:
+        name:
+          description: Name of the network policy.
+          type: string
+          examples:
+            - Receive server initiates
+        initiation_policy_type:
+          description: Defines which side initiates the transfer connection.
+          type: string
+          enum:
+            - all
+            - none
+            - listed
+          examples:
+            - all
+        access_control_type:
+          description: Defines the access control behaviour for this network policy.
+          type: string
+          enum:
+            - allow_following
+            - none
+          examples:
+            - allow_following
   requestBodies:
     clients_params:
       content: