sky-api-client 3.3.4__tar.gz → 3.3.6__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/PKG-INFO +63 -50
  2. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/README.md +61 -49
  3. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/setup.py +1 -1
  4. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/__init__.py +3 -0
  5. sky_api_client-3.3.6/sky_api_client/entity/action.py +13 -0
  6. sky_api_client-3.3.6/sky_api_client/entity/action_custom_field.py +10 -0
  7. sky_api_client-3.3.6/sky_api_client/entity/action_status.py +7 -0
  8. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/base.py +11 -0
  9. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/custom_field_categories.py +1 -0
  10. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client.egg-info/PKG-INFO +63 -50
  11. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client.egg-info/SOURCES.txt +3 -0
  12. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/pyproject.toml +0 -0
  13. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/setup.cfg +0 -0
  14. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/client.py +0 -0
  15. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/common/__init__.py +0 -0
  16. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/common/tasks/__init__.py +0 -0
  17. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/common/tasks/asyncio.py +0 -0
  18. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/__init__.py +0 -0
  19. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/address.py +0 -0
  20. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/code_table.py +0 -0
  21. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/constituent.py +0 -0
  22. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/constituent_address.py +0 -0
  23. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/constituent_code.py +0 -0
  24. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/constituent_custom_field.py +0 -0
  25. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/constituent_education.py +0 -0
  26. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/constituent_email_address.py +0 -0
  27. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/constituent_online_presence.py +0 -0
  28. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/constituent_phone.py +0 -0
  29. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/constituent_relationship.py +0 -0
  30. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/constituent_solicit_code.py +0 -0
  31. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/custom_field.py +0 -0
  32. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/education.py +0 -0
  33. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/email_addresses.py +0 -0
  34. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/event.py +0 -0
  35. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/event_fee.py +0 -0
  36. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/event_participant.py +0 -0
  37. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/event_participant_donation.py +0 -0
  38. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/event_participant_fee.py +0 -0
  39. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/event_participant_fee_payment.py +0 -0
  40. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/event_participant_levels.py +0 -0
  41. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/event_participation_levels.py +0 -0
  42. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/fundraising_appeal.py +0 -0
  43. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/fundraising_campaign.py +0 -0
  44. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/fundraising_fund.py +0 -0
  45. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/fundraising_package.py +0 -0
  46. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/gender.py +0 -0
  47. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/gift.py +0 -0
  48. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/gift_aid.py +0 -0
  49. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/gift_batch.py +0 -0
  50. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/gift_batch_gift.py +0 -0
  51. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/gift_custom_field_values.py +0 -0
  52. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/gift_custom_fields.py +0 -0
  53. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/gift_subtype.py +0 -0
  54. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/list.py +0 -0
  55. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/online_presence.py +0 -0
  56. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/phone.py +0 -0
  57. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/registry.py +0 -0
  58. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/relationship.py +0 -0
  59. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/solicit_code.py +0 -0
  60. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/suffix.py +0 -0
  61. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/table_entry.py +0 -0
  62. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/title.py +0 -0
  63. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/entity/webhook_subscription.py +0 -0
  64. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/exceptions/__init__.py +0 -0
  65. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client/exceptions/exception.py +0 -0
  66. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client.egg-info/dependency_links.txt +0 -0
  67. {sky_api_client-3.3.4 → sky_api_client-3.3.6}/sky_api_client.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: sky_api_client
3
- Version: 3.3.4
3
+ Version: 3.3.6
4
4
  Summary: Python client for RENXT APIs
5
5
  Home-page: https://bitbucket.org/kalyanvarma/skyapi
6
6
  Author: Rajeev K L
@@ -12,7 +12,6 @@ Description: # Sky Api Client
12
12
 
13
13
  Developed by Uddesh at [Almabase](https://almabase.com)
14
14
 
15
-
16
15
  ## Installation
17
16
 
18
17
  ```
@@ -68,63 +67,65 @@ Description: # Sky Api Client
68
67
  ```
69
68
 
70
69
  6. List all entity constituents
70
+
71
71
  ```python
72
72
  sky_api.address.list('constituent_id')
73
73
  ```
74
74
 
75
75
  ## Available Entities and Methods
76
+
76
77
  1. address
77
- - list
78
- - get
79
- - create
80
- - update
81
- - delete
82
- - types
78
+ - list
79
+ - get
80
+ - create
81
+ - update
82
+ - delete
83
+ - types
83
84
  2. code_table
84
- - list
85
- - get
86
- - create
87
- - update
88
- - delete
85
+ - list
86
+ - get
87
+ - create
88
+ - update
89
+ - delete
89
90
  3. constituent
90
- - list
91
- - get
92
- - create
93
- - update
94
- - delete
95
- - search
91
+ - list
92
+ - get
93
+ - create
94
+ - update
95
+ - delete
96
+ - search
96
97
  4. custom_field_category
97
- - list
98
+ - list
98
99
  5. custom_fields
99
- - list
100
- - create
101
- - update
102
- - delete
100
+ - list
101
+ - create
102
+ - update
103
+ - delete
103
104
  6. education
104
- - list
105
- - get
106
- - create
107
- - update
108
- - delete
105
+ - list
106
+ - get
107
+ - create
108
+ - update
109
+ - delete
109
110
  7. email_addresses
110
- - list
111
- - create
112
- - update
113
- - delete
114
- - types
111
+ - list
112
+ - create
113
+ - update
114
+ - delete
115
+ - types
115
116
  8. phone
116
- - list
117
- - get
118
- - create
119
- - update
120
- - delete
121
- - types
117
+ - list
118
+ - get
119
+ - create
120
+ - update
121
+ - delete
122
+ - types
122
123
  9. relationship
123
- - list
124
- - get
125
- - create
126
- - update
127
- - delete
124
+ - list
125
+ - get
126
+ - create
127
+ - update
128
+ - delete
128
129
  10. table_entry
129
130
  - list
130
131
  - get
@@ -157,20 +158,32 @@ Description: # Sky Api Client
157
158
  - list
158
159
  19. constituent_relationship
159
160
  - list
161
+ 20. action
162
+ - list
163
+ - create
164
+ - get
165
+ - update
166
+ - delete
167
+ - types
168
+ - list_all
169
+ 21. action_status
170
+ - list
160
171
 
161
172
  These entities can be used same as above example for `constituent`.
173
+
162
174
  ```python
163
175
  email_address_list = sky_api.email_addresses.list()
164
176
  ```
165
177
 
166
178
  > Note:- Current version doesn't have refresh token functionality.
167
179
 
168
-
169
180
  # Updating Version
170
- ```
171
- $ semversioner add-change --type patch --description "description for the change"
172
- $ ./release
173
- ```
181
+
182
+ ```
183
+ $ semversioner add-change --type patch --description "description for the change"
184
+ $ ./release
185
+ ```
186
+
174
187
  Platform: UNKNOWN
175
188
  Classifier: Programming Language :: Python :: 3
176
189
  Classifier: License :: OSI Approved :: MIT License
@@ -4,7 +4,6 @@ Python client for RENXT APIs.
4
4
 
5
5
  Developed by Uddesh at [Almabase](https://almabase.com)
6
6
 
7
-
8
7
  ## Installation
9
8
 
10
9
  ```
@@ -60,63 +59,65 @@ sky_api.constituent.delete('constituent_id')
60
59
  ```
61
60
 
62
61
  6. List all entity constituents
62
+
63
63
  ```python
64
64
  sky_api.address.list('constituent_id')
65
65
  ```
66
66
 
67
67
  ## Available Entities and Methods
68
+
68
69
  1. address
69
- - list
70
- - get
71
- - create
72
- - update
73
- - delete
74
- - types
70
+ - list
71
+ - get
72
+ - create
73
+ - update
74
+ - delete
75
+ - types
75
76
  2. code_table
76
- - list
77
- - get
78
- - create
79
- - update
80
- - delete
77
+ - list
78
+ - get
79
+ - create
80
+ - update
81
+ - delete
81
82
  3. constituent
82
- - list
83
- - get
84
- - create
85
- - update
86
- - delete
87
- - search
83
+ - list
84
+ - get
85
+ - create
86
+ - update
87
+ - delete
88
+ - search
88
89
  4. custom_field_category
89
- - list
90
+ - list
90
91
  5. custom_fields
91
- - list
92
- - create
93
- - update
94
- - delete
92
+ - list
93
+ - create
94
+ - update
95
+ - delete
95
96
  6. education
96
- - list
97
- - get
98
- - create
99
- - update
100
- - delete
97
+ - list
98
+ - get
99
+ - create
100
+ - update
101
+ - delete
101
102
  7. email_addresses
102
- - list
103
- - create
104
- - update
105
- - delete
106
- - types
103
+ - list
104
+ - create
105
+ - update
106
+ - delete
107
+ - types
107
108
  8. phone
108
- - list
109
- - get
110
- - create
111
- - update
112
- - delete
113
- - types
109
+ - list
110
+ - get
111
+ - create
112
+ - update
113
+ - delete
114
+ - types
114
115
  9. relationship
115
- - list
116
- - get
117
- - create
118
- - update
119
- - delete
116
+ - list
117
+ - get
118
+ - create
119
+ - update
120
+ - delete
120
121
  10. table_entry
121
122
  - list
122
123
  - get
@@ -149,17 +150,28 @@ sky_api.address.list('constituent_id')
149
150
  - list
150
151
  19. constituent_relationship
151
152
  - list
153
+ 20. action
154
+ - list
155
+ - create
156
+ - get
157
+ - update
158
+ - delete
159
+ - types
160
+ - list_all
161
+ 21. action_status
162
+ - list
152
163
 
153
164
  These entities can be used same as above example for `constituent`.
165
+
154
166
  ```python
155
167
  email_address_list = sky_api.email_addresses.list()
156
168
  ```
157
169
 
158
170
  > Note:- Current version doesn't have refresh token functionality.
159
171
 
160
-
161
172
  # Updating Version
162
- ```
163
- $ semversioner add-change --type patch --description "description for the change"
164
- $ ./release
165
- ```
173
+
174
+ ```
175
+ $ semversioner add-change --type patch --description "description for the change"
176
+ $ ./release
177
+ ```
@@ -5,7 +5,7 @@ with open('README.md', 'r', encoding='utf-8') as fh:
5
5
 
6
6
  setuptools.setup(
7
7
  name='sky_api_client',
8
- version='3.3.4',
8
+ version='3.3.6',
9
9
  author='Rajeev K L',
10
10
  author_email='rajeev@almabase.com',
11
11
  description='Python client for RENXT APIs',
@@ -1,5 +1,8 @@
1
1
  from sky_api_client.client import SkyApi # noqa: F401
2
2
  from sky_api_client.entity import address # noqa: F401
3
+ from sky_api_client.entity import action # noqa: F401
4
+ from sky_api_client.entity import action_status # noqa: F401
5
+ from sky_api_client.entity import action_custom_field # noqa: F401
3
6
  from sky_api_client.entity import code_table # noqa: F401
4
7
  from sky_api_client.entity import constituent # noqa: F401
5
8
  from sky_api_client.entity import custom_field # noqa: F401
@@ -0,0 +1,13 @@
1
+ from sky_api_client.entity.base import Entity
2
+ from sky_api_client.entity.registry import EntityRegistry
3
+
4
+
5
+ @EntityRegistry.register('action')
6
+ class Action(Entity):
7
+ LIST_URL = '/constituent/v1/constituents/{id}/actions'
8
+ CREATE_URL = '/constituent/v1/actions'
9
+ GET_URL = '/constituent/v1/actions/{id}'
10
+ UPDATE_URL = '/constituent/v1/actions/{id}'
11
+ DELETE_URL = '/constituent/v1/actions/{id}'
12
+ LIST_ALL_URL = '/constituent/v1/actions'
13
+ TYPES_URL = '/constituent/v1/actiontypes'
@@ -0,0 +1,10 @@
1
+ from sky_api_client.entity.base import Entity
2
+ from sky_api_client.entity.registry import EntityRegistry
3
+
4
+
5
+ @EntityRegistry.register('action_custom_field')
6
+ class ActionCustomField(Entity):
7
+ LIST_URL = '/constituent/v1/actions/{id}/customfields'
8
+ CREATE_URL = '/constituent/v1/actions/customfields'
9
+ UPDATE_URL = '/constituent/v1/actions/customfields/{id}'
10
+ DELETE_URL = '/constituent/v1/actions/customfields/{id}'
@@ -0,0 +1,7 @@
1
+ from sky_api_client.entity.base import Entity
2
+ from sky_api_client.entity.registry import EntityRegistry
3
+
4
+
5
+ @EntityRegistry.register('action_status')
6
+ class ActionStatus(Entity):
7
+ LIST_URL = '/constituent/v1/actionstatustypes'
@@ -11,6 +11,7 @@ class Entity(object):
11
11
  DELETE_URL = None
12
12
  SEARCH_URL = None
13
13
  TYPES_URL = None
14
+ LIST_ALL_URL = None
14
15
 
15
16
  def __init__(self, api: client) -> None:
16
17
  self._api = api
@@ -54,3 +55,13 @@ class Entity(object):
54
55
  if self.SEARCH_URL:
55
56
  return self._api.request(method='GET', path=self.SEARCH_URL.format(search_text=search_text))
56
57
  raise MethodNotDefined('Search')
58
+
59
+ def list_all(self, id=None, parent_id=None, params=None):
60
+ if self.LIST_ALL_URL:
61
+ if 'id' in self.LIST_URL and id is None:
62
+ raise InvalidArguments()
63
+ elif 'parent_id' in self.LIST_URL and parent_id is None:
64
+ raise InvalidArguments()
65
+ else:
66
+ return self._api.request(method='GET', path=self.LIST_ALL_URL.format(id=id), params=params)
67
+ raise MethodNotDefined('List All')
@@ -5,3 +5,4 @@ from sky_api_client.entity.registry import EntityRegistry
5
5
  @EntityRegistry.register('custom_field_category')
6
6
  class CustomFieldCategory(Entity):
7
7
  LIST_URL = '/constituent/v1/constituents/customfields/categories/details/'
8
+ CREATE_URL = '/nxt-data-integration/v1/re/customfieldcategories'
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: sky-api-client
3
- Version: 3.3.4
3
+ Version: 3.3.6
4
4
  Summary: Python client for RENXT APIs
5
5
  Home-page: https://bitbucket.org/kalyanvarma/skyapi
6
6
  Author: Rajeev K L
@@ -12,7 +12,6 @@ Description: # Sky Api Client
12
12
 
13
13
  Developed by Uddesh at [Almabase](https://almabase.com)
14
14
 
15
-
16
15
  ## Installation
17
16
 
18
17
  ```
@@ -68,63 +67,65 @@ Description: # Sky Api Client
68
67
  ```
69
68
 
70
69
  6. List all entity constituents
70
+
71
71
  ```python
72
72
  sky_api.address.list('constituent_id')
73
73
  ```
74
74
 
75
75
  ## Available Entities and Methods
76
+
76
77
  1. address
77
- - list
78
- - get
79
- - create
80
- - update
81
- - delete
82
- - types
78
+ - list
79
+ - get
80
+ - create
81
+ - update
82
+ - delete
83
+ - types
83
84
  2. code_table
84
- - list
85
- - get
86
- - create
87
- - update
88
- - delete
85
+ - list
86
+ - get
87
+ - create
88
+ - update
89
+ - delete
89
90
  3. constituent
90
- - list
91
- - get
92
- - create
93
- - update
94
- - delete
95
- - search
91
+ - list
92
+ - get
93
+ - create
94
+ - update
95
+ - delete
96
+ - search
96
97
  4. custom_field_category
97
- - list
98
+ - list
98
99
  5. custom_fields
99
- - list
100
- - create
101
- - update
102
- - delete
100
+ - list
101
+ - create
102
+ - update
103
+ - delete
103
104
  6. education
104
- - list
105
- - get
106
- - create
107
- - update
108
- - delete
105
+ - list
106
+ - get
107
+ - create
108
+ - update
109
+ - delete
109
110
  7. email_addresses
110
- - list
111
- - create
112
- - update
113
- - delete
114
- - types
111
+ - list
112
+ - create
113
+ - update
114
+ - delete
115
+ - types
115
116
  8. phone
116
- - list
117
- - get
118
- - create
119
- - update
120
- - delete
121
- - types
117
+ - list
118
+ - get
119
+ - create
120
+ - update
121
+ - delete
122
+ - types
122
123
  9. relationship
123
- - list
124
- - get
125
- - create
126
- - update
127
- - delete
124
+ - list
125
+ - get
126
+ - create
127
+ - update
128
+ - delete
128
129
  10. table_entry
129
130
  - list
130
131
  - get
@@ -157,20 +158,32 @@ Description: # Sky Api Client
157
158
  - list
158
159
  19. constituent_relationship
159
160
  - list
161
+ 20. action
162
+ - list
163
+ - create
164
+ - get
165
+ - update
166
+ - delete
167
+ - types
168
+ - list_all
169
+ 21. action_status
170
+ - list
160
171
 
161
172
  These entities can be used same as above example for `constituent`.
173
+
162
174
  ```python
163
175
  email_address_list = sky_api.email_addresses.list()
164
176
  ```
165
177
 
166
178
  > Note:- Current version doesn't have refresh token functionality.
167
179
 
168
-
169
180
  # Updating Version
170
- ```
171
- $ semversioner add-change --type patch --description "description for the change"
172
- $ ./release
173
- ```
181
+
182
+ ```
183
+ $ semversioner add-change --type patch --description "description for the change"
184
+ $ ./release
185
+ ```
186
+
174
187
  Platform: UNKNOWN
175
188
  Classifier: Programming Language :: Python :: 3
176
189
  Classifier: License :: OSI Approved :: MIT License
@@ -11,6 +11,9 @@ sky_api_client/common/__init__.py
11
11
  sky_api_client/common/tasks/__init__.py
12
12
  sky_api_client/common/tasks/asyncio.py
13
13
  sky_api_client/entity/__init__.py
14
+ sky_api_client/entity/action.py
15
+ sky_api_client/entity/action_custom_field.py
16
+ sky_api_client/entity/action_status.py
14
17
  sky_api_client/entity/address.py
15
18
  sky_api_client/entity/base.py
16
19
  sky_api_client/entity/code_table.py
File without changes