# coding=utf-8
class _CustomFields:

    def __init__(self, client=None):
        self.client = client

    def create_custom_field(self, params=None, **options):
        """Create a custom field
        :param Object params: Parameters for the request
        :param **options
            - opt_fields {list[str]}:  This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
            - opt_pretty {bool}:  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
        :return: Object
        """
        if params is None:
            params = {}
        path = "/custom_fields"
        return self.client.post(path, params, **options)

    def create_enum_option_for_custom_field(self, custom_field_gid, params=None, **options):
        """Create an enum option
        :param str custom_field_gid: (required) Globally unique identifier for the custom field.
        :param Object params: Parameters for the request
        :param **options
            - opt_fields {list[str]}:  This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
            - opt_pretty {bool}:  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
        :return: Object
        """
        if params is None:
            params = {}
        path = "/custom_fields/{custom_field_gid}/enum_options".replace("{custom_field_gid}", custom_field_gid)
        return self.client.post(path, params, **options)

    def delete_custom_field(self, custom_field_gid, params=None, **options):
        """Delete a custom field
        :param str custom_field_gid: (required) Globally unique identifier for the custom field.
        :param Object params: Parameters for the request
        :param **options
            - opt_pretty {bool}:  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
        :return: Object
        """
        if params is None:
            params = {}
        path = "/custom_fields/{custom_field_gid}".replace("{custom_field_gid}", custom_field_gid)
        return self.client.delete(path, params, **options)

    def get_custom_field(self, custom_field_gid, params=None, **options):
        """Get a custom field
        :param str custom_field_gid: (required) Globally unique identifier for the custom field.
        :param Object params: Parameters for the request
        :param **options
            - opt_fields {list[str]}:  This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
            - opt_pretty {bool}:  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
        :return: Object
        """
        if params is None:
            params = {}
        path = "/custom_fields/{custom_field_gid}".replace("{custom_field_gid}", custom_field_gid)
        return self.client.get(path, params, **options)

    def get_custom_fields_for_workspace(self, workspace_gid, params=None, **options):
        """Get a workspace's custom fields
        :param str workspace_gid: (required) Globally unique identifier for the workspace or organization.
        :param Object params: Parameters for the request
        :param **options
            - offset {str}:  Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*
            - limit {int}:  Results per page. The number of objects to return per page. The value must be between 1 and 100.
            - opt_fields {list[str]}:  This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
            - opt_pretty {bool}:  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
        :return: Object
        """
        if params is None:
            params = {}
        path = "/workspaces/{workspace_gid}/custom_fields".replace("{workspace_gid}", workspace_gid)
        return self.client.get_collection(path, params, **options)

    def insert_enum_option_for_custom_field(self, custom_field_gid, params=None, **options):
        """Reorder a custom field's enum
        :param str custom_field_gid: (required) Globally unique identifier for the custom field.
        :param Object params: Parameters for the request
        :param **options
            - opt_fields {list[str]}:  This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
            - opt_pretty {bool}:  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
        :return: Object
        """
        if params is None:
            params = {}
        path = "/custom_fields/{custom_field_gid}/enum_options/insert".replace("{custom_field_gid}", custom_field_gid)
        return self.client.post(path, params, **options)

    def update_custom_field(self, custom_field_gid, params=None, **options):
        """Update a custom field
        :param str custom_field_gid: (required) Globally unique identifier for the custom field.
        :param Object params: Parameters for the request
        :param **options
            - opt_fields {list[str]}:  This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
            - opt_pretty {bool}:  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
        :return: Object
        """
        if params is None:
            params = {}
        path = "/custom_fields/{custom_field_gid}".replace("{custom_field_gid}", custom_field_gid)
        return self.client.put(path, params, **options)

    def update_enum_option(self, enum_option_gid, params=None, **options):
        """Update an enum option
        :param str enum_option_gid: (required) Globally unique identifier for the enum option.
        :param Object params: Parameters for the request
        :param **options
            - opt_fields {list[str]}:  This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
            - opt_pretty {bool}:  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
        :return: Object
        """
        if params is None:
            params = {}
        path = "/enum_options/{enum_option_gid}".replace("{enum_option_gid}", enum_option_gid)
        return self.client.put(path, params, **options)
