Skip to content

Adds the highlights field to the projects response #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Nov 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.15.2] - 2021-11-08

### Added

- Adds highlights to project responses

## [1.15.1] - 2021-11-04

### Added
Expand Down
2 changes: 1 addition & 1 deletion patch_api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

from __future__ import absolute_import

__version__ = "1.15.1"
__version__ = "1.15.2"

# import ApiClient
from patch_api.api_client import ApiClient
Expand Down
2 changes: 1 addition & 1 deletion patch_api/api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ def __init__(
self.default_headers[header_name] = header_value
self.cookie = cookie
# Set default User-Agent.
self.user_agent = "patch-python/1.15.1"
self.user_agent = "patch-python/1.15.2"

def __del__(self):
if self._pool:
Expand Down
2 changes: 1 addition & 1 deletion patch_api/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ def to_debug_report(self):
"OS: {env}\n"
"Python Version: {pyversion}\n"
"Version of the API: v1\n"
"SDK Package Version: 1.15.1".format(
"SDK Package Version: 1.15.2".format(
env=sys.platform, pyversion=sys.version
)
)
Expand Down
1 change: 1 addition & 0 deletions patch_api/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
from patch_api.models.estimate import Estimate
from patch_api.models.estimate_list_response import EstimateListResponse
from patch_api.models.estimate_response import EstimateResponse
from patch_api.models.highlight import Highlight
from patch_api.models.meta_index_object import MetaIndexObject
from patch_api.models.order import Order
from patch_api.models.order_list_response import OrderListResponse
Expand Down
190 changes: 190 additions & 0 deletions patch_api/models/highlight.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
# coding: utf-8

"""
Patch API V1

The core API used to integrate with Patch's service # noqa: E501

The version of the OpenAPI document: v1
Contact: developers@usepatch.com
Generated by: https://openapi-generator.tech
"""


import pprint
import re # noqa: F401

import six

from patch_api.configuration import Configuration


class Highlight(object):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech

Do not edit the class manually.
"""

"""
Attributes:
openapi_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
openapi_types = {"slug": "str", "title": "str", "icon_url": "str"}

attribute_map = {"slug": "slug", "title": "title", "icon_url": "icon_url"}

def __init__(
self, slug=None, title=None, icon_url=None, local_vars_configuration=None
): # noqa: E501
"""Highlight - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
self.local_vars_configuration = local_vars_configuration

self._slug = None
self._title = None
self._icon_url = None
self.discriminator = None

self.slug = slug
self.title = title
self.icon_url = icon_url

@property
def slug(self):
"""Gets the slug of this Highlight. # noqa: E501

A unique identifier for each highlight. # noqa: E501

:return: The slug of this Highlight. # noqa: E501
:rtype: str
"""
return self._slug

@slug.setter
def slug(self, slug):
"""Sets the slug of this Highlight.

A unique identifier for each highlight. # noqa: E501

:param slug: The slug of this Highlight. # noqa: E501
:type: str
"""
if (
self.local_vars_configuration.client_side_validation and slug is None
): # noqa: E501
raise ValueError(
"Invalid value for `slug`, must not be `None`"
) # noqa: E501

self._slug = slug

@property
def title(self):
"""Gets the title of this Highlight. # noqa: E501

A short string that spotlights a characteristic about the project. # noqa: E501

:return: The title of this Highlight. # noqa: E501
:rtype: str
"""
return self._title

@title.setter
def title(self, title):
"""Sets the title of this Highlight.

A short string that spotlights a characteristic about the project. # noqa: E501

:param title: The title of this Highlight. # noqa: E501
:type: str
"""
if (
self.local_vars_configuration.client_side_validation and title is None
): # noqa: E501
raise ValueError(
"Invalid value for `title`, must not be `None`"
) # noqa: E501

self._title = title

@property
def icon_url(self):
"""Gets the icon_url of this Highlight. # noqa: E501

A URL for the corresponding icon. # noqa: E501

:return: The icon_url of this Highlight. # noqa: E501
:rtype: str
"""
return self._icon_url

@icon_url.setter
def icon_url(self, icon_url):
"""Sets the icon_url of this Highlight.

A URL for the corresponding icon. # noqa: E501

:param icon_url: The icon_url of this Highlight. # noqa: E501
:type: str
"""
if (
self.local_vars_configuration.client_side_validation and icon_url is None
): # noqa: E501
raise ValueError(
"Invalid value for `icon_url`, must not be `None`"
) # noqa: E501

self._icon_url = icon_url

def to_dict(self):
"""Returns the model properties as a dict"""
result = {}

for attr, _ in six.iteritems(self.openapi_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(
map(lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value)
)
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(
map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict")
else item,
value.items(),
)
)
else:
result[attr] = value

return result

def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())

def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()

def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, Highlight):
return False

return self.to_dict() == other.to_dict()

def __ne__(self, other):
"""Returns true if both objects are not equal"""
if not isinstance(other, Highlight):
return True

return self.to_dict() != other.to_dict()
34 changes: 34 additions & 0 deletions patch_api/models/project.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ class Project(object):
"sdgs": "list[Sdg]",
"tagline": "str",
"technology_type": "TechnologyType",
"highlights": "list[Highlight]",
}

attribute_map = {
Expand All @@ -75,6 +76,7 @@ class Project(object):
"sdgs": "sdgs",
"tagline": "tagline",
"technology_type": "technology_type",
"highlights": "highlights",
}

def __init__(
Expand All @@ -98,6 +100,7 @@ def __init__(
sdgs=None,
tagline=None,
technology_type=None,
highlights=None,
local_vars_configuration=None,
): # noqa: E501
"""Project - a model defined in OpenAPI""" # noqa: E501
Expand All @@ -124,6 +127,7 @@ def __init__(
self._sdgs = None
self._tagline = None
self._technology_type = None
self._highlights = None
self.discriminator = None

self.id = id
Expand All @@ -149,6 +153,7 @@ def __init__(
if tagline is not None:
self.tagline = tagline
self.technology_type = technology_type
self.highlights = highlights

@property
def id(self):
Expand Down Expand Up @@ -650,6 +655,35 @@ def technology_type(self, technology_type):

self._technology_type = technology_type

@property
def highlights(self):
"""Gets the highlights of this Project. # noqa: E501

An array of objects containing the highlight's slug and title. A highlight's title is a short string that spotlights a characteristic about the project. # noqa: E501

:return: The highlights of this Project. # noqa: E501
:rtype: list[Highlight]
"""
return self._highlights

@highlights.setter
def highlights(self, highlights):
"""Sets the highlights of this Project.

An array of objects containing the highlight's slug and title. A highlight's title is a short string that spotlights a characteristic about the project. # noqa: E501

:param highlights: The highlights of this Project. # noqa: E501
:type: list[Highlight]
"""
if (
self.local_vars_configuration.client_side_validation and highlights is None
): # noqa: E501
raise ValueError(
"Invalid value for `highlights`, must not be `None`"
) # noqa: E501

self._highlights = highlights

def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
from setuptools import setup, find_packages # noqa: H301

NAME = "patch-api"
VERSION = "1.15.1"
VERSION = "1.15.2"
# To install the library, run the following
#
# python setup.py install
Expand Down
1 change: 1 addition & 0 deletions test/test_projects_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ def test_retrieve_project(self):
self.assertTrue(hasattr(project, "tagline"))
self.assertTrue(hasattr(project, "latitude"))
self.assertTrue(hasattr(project, "longitude"))
self.assertTrue(hasattr(project, "highlights"))

self.assertTrue(isinstance(project.mechanism, str))
self.assertTrue(isinstance(project.state, str))
Expand Down