# coding=utf-8
class _Goals:

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

    def add_followers(self, goal_gid, params=None, **options):
        """Add a collaborator to a goal
        :param str goal_gid: (required) Globally unique identifier for the goal.
        :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 = "/goals/{goal_gid}/addFollowers".replace("{goal_gid}", goal_gid)
        return self.client.post(path, params, **options)

    def create_goal(self, params=None, **options):
        """Create a goal
        :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 = "/goals"
        return self.client.post(path, params, **options)

    def create_goal_metric(self, goal_gid, params=None, **options):
        """Create a goal metric
        :param str goal_gid: (required) Globally unique identifier for the goal.
        :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 = "/goals/{goal_gid}/setMetric".replace("{goal_gid}", goal_gid)
        return self.client.post(path, params, **options)

    def delete_goal(self, goal_gid, params=None, **options):
        """Delete a goal
        :param str goal_gid: (required) Globally unique identifier for the goal.
        :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 = "/goals/{goal_gid}".replace("{goal_gid}", goal_gid)
        return self.client.delete(path, params, **options)

    def get_goal(self, goal_gid, params=None, **options):
        """Get a goal
        :param str goal_gid: (required) Globally unique identifier for the goal.
        :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 = "/goals/{goal_gid}".replace("{goal_gid}", goal_gid)
        return self.client.get(path, params, **options)

    def get_goals(self, params=None, **options):
        """Get goals
        :param Object params: Parameters for the request
            - portfolio {str}:  Globally unique identifier for supporting portfolio.
            - project {str}:  Globally unique identifier for supporting project.
            - task {str}:  Globally unique identifier for supporting task.
            - is_workspace_level {bool}:  Filter to goals with is_workspace_level set to query value. Must be used with the workspace parameter.
            - team {str}:  Globally unique identifier for the team.
            - workspace {str}:  Globally unique identifier for the workspace.
            - time_periods {list[str]}:  Globally unique identifiers for the time periods.
        :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 = "/goals"
        return self.client.get_collection(path, params, **options)

    def get_parent_goals_for_goal(self, goal_gid, params=None, **options):
        """Get parent goals from a goal
        :param str goal_gid: (required) Globally unique identifier for the goal.
        :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 = "/goals/{goal_gid}/parentGoals".replace("{goal_gid}", goal_gid)
        return self.client.get_collection(path, params, **options)

    def remove_followers(self, goal_gid, params=None, **options):
        """Remove a collaborator from a goal
        :param str goal_gid: (required) Globally unique identifier for the goal.
        :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 = "/goals/{goal_gid}/removeFollowers".replace("{goal_gid}", goal_gid)
        return self.client.post(path, params, **options)

    def update_goal(self, goal_gid, params=None, **options):
        """Update a goal
        :param str goal_gid: (required) Globally unique identifier for the goal.
        :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 = "/goals/{goal_gid}".replace("{goal_gid}", goal_gid)
        return self.client.put(path, params, **options)

    def update_goal_metric(self, goal_gid, params=None, **options):
        """Update a goal metric
        :param str goal_gid: (required) Globally unique identifier for the goal.
        :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 = "/goals/{goal_gid}/setMetricCurrentValue".replace("{goal_gid}", goal_gid)
        return self.client.post(path, params, **options)
