Package com.launchdarkly.api.api

Class AccountMembersApi

  • public class AccountMembersApi
extends java.lang.Object

    • Constructor Detail

      • AccountMembersApi

        public AccountMembersApi()

      • AccountMembersApi

        public AccountMembersApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • deleteMemberCall

        public okhttp3.Call deleteMemberCall​(java.lang.String id,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for deleteMember
        Parameters:
        id - The member ID (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deleteMember

        public void deleteMember​(java.lang.String id)
                  throws ApiException
        Delete account member Delete a single account member by ID. Requests to delete account members will not work if SCIM is enabled for the account.
        Parameters:
        id - The member ID (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteMemberWithHttpInfo

        public ApiResponse<java.lang.Void> deleteMemberWithHttpInfo​(java.lang.String id)
                                                     throws ApiException
        Delete account member Delete a single account member by ID. Requests to delete account members will not work if SCIM is enabled for the account.
        Parameters:
        id - The member ID (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteMemberAsync

        public okhttp3.Call deleteMemberAsync​(java.lang.String id,
                                      ApiCallback<java.lang.Void> _callback)
                               throws ApiException
        Delete account member (asynchronously) Delete a single account member by ID. Requests to delete account members will not work if SCIM is enabled for the account.
        Parameters:
        id - The member ID (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getMemberCall

        public okhttp3.Call getMemberCall​(java.lang.String id,
                                  ApiCallback _callback)
                           throws ApiException
        Build call for getMember
        Parameters:
        id - The member ID (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getMember

        public Member getMember​(java.lang.String id)
                 throws ApiException
        Get account member Get a single account member by ID
        Parameters:
        id - The member ID (required)
        Returns:
        Member
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMemberWithHttpInfo

        public ApiResponse<Member> getMemberWithHttpInfo​(java.lang.String id)
                                          throws ApiException
        Get account member Get a single account member by ID
        Parameters:
        id - The member ID (required)
        Returns:
        ApiResponse<Member>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMemberAsync

        public okhttp3.Call getMemberAsync​(java.lang.String id,
                                   ApiCallback<Member> _callback)
                            throws ApiException
        Get account member (asynchronously) Get a single account member by ID
        Parameters:
        id - The member ID (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getMembersCall

        public okhttp3.Call getMembersCall​(java.lang.Long limit,
                                   java.lang.Long offset,
                                   java.lang.String filter,
                                   java.lang.String sort,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for getMembers
        Parameters:
        limit - The number of members to return in the response. Defaults to 20. (optional)
        offset - Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first ten items and then return the next `limit` items. (optional)
        filter - A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. (optional)
        sort - A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getMembers

        public Members getMembers​(java.lang.Long limit,
                          java.lang.Long offset,
                          java.lang.String filter,
                          java.lang.String sort)
                   throws ApiException
        List account members Return a list of account members. By default, this returns the first 20 members. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links are not present if the pages they refer to don't exist. For example, the `first` and `prev` links will be missing from the response on the first page. ### Filtering members LaunchDarkly supports three fields for filters: `query`, `role`, and `lastSeen`: - `query` is a string that matches against the members' emails and names. It is not case sensitive. - `role` is a `|` separated list of roles and custom roles. It filters the list to members who have any of the roles in the list. For the purposes of this filtering, `Owner` counts as `Admin`. - `lastSeen` is a JSON object in one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. For example, the filter `query:abc,role:admin|customrole` matches members with the string `abc` in their email or name, ignoring case, who also are either an an `Owner` or `Admin` or have the custom role `customrole`. ### Sorting members LaunchDarkly supports two fields for sorting: `displayName` and `lastSeen`: - `displayName` sorts by first + last name, using the member's email if no name is set. - `lastSeen` sorts by the `_lastSeen` property. LaunchDarkly considers members that have never been seen or have no data the oldest.
        Parameters:
        limit - The number of members to return in the response. Defaults to 20. (optional)
        offset - Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first ten items and then return the next `limit` items. (optional)
        filter - A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. (optional)
        sort - A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. (optional)
        Returns:
        Members
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMembersWithHttpInfo

        public ApiResponse<Members> getMembersWithHttpInfo​(java.lang.Long limit,
                                                   java.lang.Long offset,
                                                   java.lang.String filter,
                                                   java.lang.String sort)
                                            throws ApiException
        List account members Return a list of account members. By default, this returns the first 20 members. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links are not present if the pages they refer to don't exist. For example, the `first` and `prev` links will be missing from the response on the first page. ### Filtering members LaunchDarkly supports three fields for filters: `query`, `role`, and `lastSeen`: - `query` is a string that matches against the members' emails and names. It is not case sensitive. - `role` is a `|` separated list of roles and custom roles. It filters the list to members who have any of the roles in the list. For the purposes of this filtering, `Owner` counts as `Admin`. - `lastSeen` is a JSON object in one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. For example, the filter `query:abc,role:admin|customrole` matches members with the string `abc` in their email or name, ignoring case, who also are either an an `Owner` or `Admin` or have the custom role `customrole`. ### Sorting members LaunchDarkly supports two fields for sorting: `displayName` and `lastSeen`: - `displayName` sorts by first + last name, using the member's email if no name is set. - `lastSeen` sorts by the `_lastSeen` property. LaunchDarkly considers members that have never been seen or have no data the oldest.
        Parameters:
        limit - The number of members to return in the response. Defaults to 20. (optional)
        offset - Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first ten items and then return the next `limit` items. (optional)
        filter - A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. (optional)
        sort - A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. (optional)
        Returns:
        ApiResponse<Members>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMembersAsync

        public okhttp3.Call getMembersAsync​(java.lang.Long limit,
                                    java.lang.Long offset,
                                    java.lang.String filter,
                                    java.lang.String sort,
                                    ApiCallback<Members> _callback)
                             throws ApiException
        List account members (asynchronously) Return a list of account members. By default, this returns the first 20 members. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links are not present if the pages they refer to don't exist. For example, the `first` and `prev` links will be missing from the response on the first page. ### Filtering members LaunchDarkly supports three fields for filters: `query`, `role`, and `lastSeen`: - `query` is a string that matches against the members' emails and names. It is not case sensitive. - `role` is a `|` separated list of roles and custom roles. It filters the list to members who have any of the roles in the list. For the purposes of this filtering, `Owner` counts as `Admin`. - `lastSeen` is a JSON object in one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. For example, the filter `query:abc,role:admin|customrole` matches members with the string `abc` in their email or name, ignoring case, who also are either an an `Owner` or `Admin` or have the custom role `customrole`. ### Sorting members LaunchDarkly supports two fields for sorting: `displayName` and `lastSeen`: - `displayName` sorts by first + last name, using the member's email if no name is set. - `lastSeen` sorts by the `_lastSeen` property. LaunchDarkly considers members that have never been seen or have no data the oldest.
        Parameters:
        limit - The number of members to return in the response. Defaults to 20. (optional)
        offset - Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first ten items and then return the next `limit` items. (optional)
        filter - A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. (optional)
        sort - A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • patchMemberCall

        public okhttp3.Call patchMemberCall​(java.lang.String id,
                                    java.util.List<PatchOperation> patchOperation,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for patchMember
        Parameters:
        id - The member ID (required)
        patchOperation - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • patchMember

        public Member patchMember​(java.lang.String id,
                          java.util.List<PatchOperation> patchOperation)
                   throws ApiException
        Modify an account member Update a single account member. The request should be a valid JSON Patch document describing the changes to be made to the member. Requests to update account members will not work if SCIM is enabled for the account.
        Parameters:
        id - The member ID (required)
        patchOperation - (required)
        Returns:
        Member
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchMemberWithHttpInfo

        public ApiResponse<Member> patchMemberWithHttpInfo​(java.lang.String id,
                                                   java.util.List<PatchOperation> patchOperation)
                                            throws ApiException
        Modify an account member Update a single account member. The request should be a valid JSON Patch document describing the changes to be made to the member. Requests to update account members will not work if SCIM is enabled for the account.
        Parameters:
        id - The member ID (required)
        patchOperation - (required)
        Returns:
        ApiResponse<Member>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchMemberAsync

        public okhttp3.Call patchMemberAsync​(java.lang.String id,
                                     java.util.List<PatchOperation> patchOperation,
                                     ApiCallback<Member> _callback)
                              throws ApiException
        Modify an account member (asynchronously) Update a single account member. The request should be a valid JSON Patch document describing the changes to be made to the member. Requests to update account members will not work if SCIM is enabled for the account.
        Parameters:
        id - The member ID (required)
        patchOperation - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • postMembersCall

        public okhttp3.Call postMembersCall​(java.util.List<NewMemberForm> newMemberForm,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for postMembers
        Parameters:
        newMemberForm - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • postMembers

        public Members postMembers​(java.util.List<NewMemberForm> newMemberForm)
                    throws ApiException
        Invite new members > ### Full use of this API resource is only available to accounts with paid subscriptions > > The ability to bulk invite members is a paid feature. Single members may be invited if not on a paid plan. Invite one or more new members to join an account. Each member is sent an invitation. Members with \"admin\" or \"owner\" roles may create new members, as well as anyone with a \"createMember\" permission for \"member/\\*\". If a member cannot be invited, the entire request is rejected and no members are invited from that request. Each member _must_ have an `email` field and either a `role` or a `customRoles` field. If any of the fields are not populated correctly, the request is rejected with the reason specified in the \"message\" field of the response. Requests to create account members will not work if SCIM is enabled for the account. _No more than 50 members may be created per request._ A request may also fail because of conflicts with existing members. These conflicts are reported using the additional `code` and `invalid_emails` response fields with the following possible values for `code`: - **email_already_exists_in_account**: A member with this email address already exists in this account. - **email_taken_in_different_account**: A member with this email address exists in another account. - **duplicate_email**s: This request contains two or more members with the same email address. A request that fails for one of the above reasons returns an HTTP response code of 400 (Bad Request).
        Parameters:
        newMemberForm - (required)
        Returns:
        Members
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postMembersWithHttpInfo

        public ApiResponse<Members> postMembersWithHttpInfo​(java.util.List<NewMemberForm> newMemberForm)
                                             throws ApiException
        Invite new members > ### Full use of this API resource is only available to accounts with paid subscriptions > > The ability to bulk invite members is a paid feature. Single members may be invited if not on a paid plan. Invite one or more new members to join an account. Each member is sent an invitation. Members with \"admin\" or \"owner\" roles may create new members, as well as anyone with a \"createMember\" permission for \"member/\\*\". If a member cannot be invited, the entire request is rejected and no members are invited from that request. Each member _must_ have an `email` field and either a `role` or a `customRoles` field. If any of the fields are not populated correctly, the request is rejected with the reason specified in the \"message\" field of the response. Requests to create account members will not work if SCIM is enabled for the account. _No more than 50 members may be created per request._ A request may also fail because of conflicts with existing members. These conflicts are reported using the additional `code` and `invalid_emails` response fields with the following possible values for `code`: - **email_already_exists_in_account**: A member with this email address already exists in this account. - **email_taken_in_different_account**: A member with this email address exists in another account. - **duplicate_email**s: This request contains two or more members with the same email address. A request that fails for one of the above reasons returns an HTTP response code of 400 (Bad Request).
        Parameters:
        newMemberForm - (required)
        Returns:
        ApiResponse<Members>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postMembersAsync

        public okhttp3.Call postMembersAsync​(java.util.List<NewMemberForm> newMemberForm,
                                     ApiCallback<Members> _callback)
                              throws ApiException
        Invite new members (asynchronously) > ### Full use of this API resource is only available to accounts with paid subscriptions > > The ability to bulk invite members is a paid feature. Single members may be invited if not on a paid plan. Invite one or more new members to join an account. Each member is sent an invitation. Members with \"admin\" or \"owner\" roles may create new members, as well as anyone with a \"createMember\" permission for \"member/\\*\". If a member cannot be invited, the entire request is rejected and no members are invited from that request. Each member _must_ have an `email` field and either a `role` or a `customRoles` field. If any of the fields are not populated correctly, the request is rejected with the reason specified in the \"message\" field of the response. Requests to create account members will not work if SCIM is enabled for the account. _No more than 50 members may be created per request._ A request may also fail because of conflicts with existing members. These conflicts are reported using the additional `code` and `invalid_emails` response fields with the following possible values for `code`: - **email_already_exists_in_account**: A member with this email address already exists in this account. - **email_taken_in_different_account**: A member with this email address exists in another account. - **duplicate_email**s: This request contains two or more members with the same email address. A request that fails for one of the above reasons returns an HTTP response code of 400 (Bad Request).
        Parameters:
        newMemberForm - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object