Skip to content

Commit 7df074c

Browse files
committed
update salesforce source form properties
1 parent 689efdc commit 7df074c

File tree

2 files changed

+158
-9
lines changed

2 files changed

+158
-9
lines changed

docs/SalesforceSourceFormProperties.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,14 @@ Salesforce connections read data from the Salesforce API and correspond to sourc
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**anchor_time** | **str** | Defines the time that frequency_in_minutes is “anchored” to, which Stitch will use to create the integration’s replication schedule. In Stitch, this is referred to as Anchor Scheduling. This field must contain an ISO 8601-compliant date. Note: When Stitch stores this value, it will be in UTC. You should provide this value in UTC to ensure the desired anchor time is retained. For example: You want to create a schedule that is anchored to 1:00PM EST and runs every 6 hours (360 minutes). To do this, you can set anchor_time to something like 2018-04-30T17:00:00Z and frequency_in_minutes to 360. This means jobs would run at 23:00:00, 05:00:00, 11:00:00, and so on. | [optional]
8-
**api_type** | **str** | The Salesforce API Stitch should use to extract data. Possible values are REST or BULK. | [optional]
8+
**api_type** | **str** | The Salesforce API Stitch should use to extract data. Possible values are REST or BULK. |
99
**cron_expression** | **str** | Note: Advanced Scheduling using Cron is not yet supported for this source. A value may be submitted for this property if the account is on an Enterprise plan, but Stitch will not use the expression submitted. A valid Quartz cron expression representing the replication schedule for the integration. Refer to the Advanced Scheduling documentation for more info. Note: If neither a cron_expression or frequency_in_minutes property is provided, Stitch will use the source’s default frequency_in_minutes value (60). | [optional]
10-
**frequency_in_minutes** | **str** | Defines how often, in minutes, Stitch should attempt to replicate data from Salesforce. Accepted values are: - 30 - 60 - 360 - 720 - 1440 | [optional]
10+
**frequency_in_minutes** | **str** | Defines how often, in minutes, Stitch should attempt to replicate data from Salesforce. Accepted values are: - 30 - 60 - 360 - 720 - 1440 |
11+
**is_sandbox** | **str** | If `true`, the Salesforce account being connected is a sandbox. | [optional]
12+
**quota_percent_per_run** | **str** | The maximum percentage of Salesforce API quota allowed per replication job. | [optional]
13+
**quota_percent_total** | **str** | The maximum percentage of Salesforce API quota allowed per day. | [optional]
14+
**select_fields_by_default** | **str** | If `true`, Stitch will automatically set new fields added in Salesforce to replicate. |
15+
**start_date** | **str** | The date from which Stitch should begin replicating data from Salesforce. Data from this date forward will be replicated. This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z |
1116

1217
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1318

openapi_client/models/salesforce_source_form_properties.py

Lines changed: 151 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,27 @@ class SalesforceSourceFormProperties(object):
3636
'anchor_time': 'str',
3737
'api_type': 'str',
3838
'cron_expression': 'str',
39-
'frequency_in_minutes': 'str'
39+
'frequency_in_minutes': 'str',
40+
'is_sandbox': 'str',
41+
'quota_percent_per_run': 'str',
42+
'quota_percent_total': 'str',
43+
'select_fields_by_default': 'str',
44+
'start_date': 'str'
4045
}
4146

4247
attribute_map = {
4348
'anchor_time': 'anchor_time',
4449
'api_type': 'api_type',
4550
'cron_expression': 'cron_expression',
46-
'frequency_in_minutes': 'frequency_in_minutes'
51+
'frequency_in_minutes': 'frequency_in_minutes',
52+
'is_sandbox': 'is_sandbox',
53+
'quota_percent_per_run': 'quota_percent_per_run',
54+
'quota_percent_total': 'quota_percent_total',
55+
'select_fields_by_default': 'select_fields_by_default',
56+
'start_date': 'start_date'
4757
}
4858

49-
def __init__(self, anchor_time=None, api_type=None, cron_expression=None, frequency_in_minutes=None, local_vars_configuration=None): # noqa: E501
59+
def __init__(self, anchor_time=None, api_type=None, cron_expression=None, frequency_in_minutes=None, is_sandbox=None, quota_percent_per_run=None, quota_percent_total=None, select_fields_by_default=None, start_date=None, local_vars_configuration=None): # noqa: E501
5060
"""SalesforceSourceFormProperties - a model defined in OpenAPI""" # noqa: E501
5161
if local_vars_configuration is None:
5262
local_vars_configuration = Configuration()
@@ -56,16 +66,27 @@ def __init__(self, anchor_time=None, api_type=None, cron_expression=None, freque
5666
self._api_type = None
5767
self._cron_expression = None
5868
self._frequency_in_minutes = None
69+
self._is_sandbox = None
70+
self._quota_percent_per_run = None
71+
self._quota_percent_total = None
72+
self._select_fields_by_default = None
73+
self._start_date = None
5974
self.discriminator = None
6075

6176
if anchor_time is not None:
6277
self.anchor_time = anchor_time
63-
if api_type is not None:
64-
self.api_type = api_type
78+
self.api_type = api_type
6579
if cron_expression is not None:
6680
self.cron_expression = cron_expression
67-
if frequency_in_minutes is not None:
68-
self.frequency_in_minutes = frequency_in_minutes
81+
self.frequency_in_minutes = frequency_in_minutes
82+
if is_sandbox is not None:
83+
self.is_sandbox = is_sandbox
84+
if quota_percent_per_run is not None:
85+
self.quota_percent_per_run = quota_percent_per_run
86+
if quota_percent_total is not None:
87+
self.quota_percent_total = quota_percent_total
88+
self.select_fields_by_default = select_fields_by_default
89+
self.start_date = start_date
6990

7091
@property
7192
def anchor_time(self):
@@ -110,6 +131,8 @@ def api_type(self, api_type):
110131
:param api_type: The api_type of this SalesforceSourceFormProperties. # noqa: E501
111132
:type: str
112133
"""
134+
if self.local_vars_configuration.client_side_validation and api_type is None: # noqa: E501
135+
raise ValueError("Invalid value for `api_type`, must not be `None`") # noqa: E501
113136

114137
self._api_type = api_type
115138

@@ -156,6 +179,8 @@ def frequency_in_minutes(self, frequency_in_minutes):
156179
:param frequency_in_minutes: The frequency_in_minutes of this SalesforceSourceFormProperties. # noqa: E501
157180
:type: str
158181
"""
182+
if self.local_vars_configuration.client_side_validation and frequency_in_minutes is None: # noqa: E501
183+
raise ValueError("Invalid value for `frequency_in_minutes`, must not be `None`") # noqa: E501
159184
allowed_values = ["30", "60", "360", "720", "1440"] # noqa: E501
160185
if self.local_vars_configuration.client_side_validation and frequency_in_minutes not in allowed_values: # noqa: E501
161186
raise ValueError(
@@ -165,6 +190,125 @@ def frequency_in_minutes(self, frequency_in_minutes):
165190

166191
self._frequency_in_minutes = frequency_in_minutes
167192

193+
@property
194+
def is_sandbox(self):
195+
"""Gets the is_sandbox of this SalesforceSourceFormProperties. # noqa: E501
196+
197+
If `true`, the Salesforce account being connected is a sandbox. # noqa: E501
198+
199+
:return: The is_sandbox of this SalesforceSourceFormProperties. # noqa: E501
200+
:rtype: str
201+
"""
202+
return self._is_sandbox
203+
204+
@is_sandbox.setter
205+
def is_sandbox(self, is_sandbox):
206+
"""Sets the is_sandbox of this SalesforceSourceFormProperties.
207+
208+
If `true`, the Salesforce account being connected is a sandbox. # noqa: E501
209+
210+
:param is_sandbox: The is_sandbox of this SalesforceSourceFormProperties. # noqa: E501
211+
:type: str
212+
"""
213+
214+
self._is_sandbox = is_sandbox
215+
216+
@property
217+
def quota_percent_per_run(self):
218+
"""Gets the quota_percent_per_run of this SalesforceSourceFormProperties. # noqa: E501
219+
220+
The maximum percentage of Salesforce API quota allowed per replication job. # noqa: E501
221+
222+
:return: The quota_percent_per_run of this SalesforceSourceFormProperties. # noqa: E501
223+
:rtype: str
224+
"""
225+
return self._quota_percent_per_run
226+
227+
@quota_percent_per_run.setter
228+
def quota_percent_per_run(self, quota_percent_per_run):
229+
"""Sets the quota_percent_per_run of this SalesforceSourceFormProperties.
230+
231+
The maximum percentage of Salesforce API quota allowed per replication job. # noqa: E501
232+
233+
:param quota_percent_per_run: The quota_percent_per_run of this SalesforceSourceFormProperties. # noqa: E501
234+
:type: str
235+
"""
236+
237+
self._quota_percent_per_run = quota_percent_per_run
238+
239+
@property
240+
def quota_percent_total(self):
241+
"""Gets the quota_percent_total of this SalesforceSourceFormProperties. # noqa: E501
242+
243+
The maximum percentage of Salesforce API quota allowed per day. # noqa: E501
244+
245+
:return: The quota_percent_total of this SalesforceSourceFormProperties. # noqa: E501
246+
:rtype: str
247+
"""
248+
return self._quota_percent_total
249+
250+
@quota_percent_total.setter
251+
def quota_percent_total(self, quota_percent_total):
252+
"""Sets the quota_percent_total of this SalesforceSourceFormProperties.
253+
254+
The maximum percentage of Salesforce API quota allowed per day. # noqa: E501
255+
256+
:param quota_percent_total: The quota_percent_total of this SalesforceSourceFormProperties. # noqa: E501
257+
:type: str
258+
"""
259+
260+
self._quota_percent_total = quota_percent_total
261+
262+
@property
263+
def select_fields_by_default(self):
264+
"""Gets the select_fields_by_default of this SalesforceSourceFormProperties. # noqa: E501
265+
266+
If `true`, Stitch will automatically set new fields added in Salesforce to replicate. # noqa: E501
267+
268+
:return: The select_fields_by_default of this SalesforceSourceFormProperties. # noqa: E501
269+
:rtype: str
270+
"""
271+
return self._select_fields_by_default
272+
273+
@select_fields_by_default.setter
274+
def select_fields_by_default(self, select_fields_by_default):
275+
"""Sets the select_fields_by_default of this SalesforceSourceFormProperties.
276+
277+
If `true`, Stitch will automatically set new fields added in Salesforce to replicate. # noqa: E501
278+
279+
:param select_fields_by_default: The select_fields_by_default of this SalesforceSourceFormProperties. # noqa: E501
280+
:type: str
281+
"""
282+
if self.local_vars_configuration.client_side_validation and select_fields_by_default is None: # noqa: E501
283+
raise ValueError("Invalid value for `select_fields_by_default`, must not be `None`") # noqa: E501
284+
285+
self._select_fields_by_default = select_fields_by_default
286+
287+
@property
288+
def start_date(self):
289+
"""Gets the start_date of this SalesforceSourceFormProperties. # noqa: E501
290+
291+
The date from which Stitch should begin replicating data from Salesforce. Data from this date forward will be replicated. This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z # noqa: E501
292+
293+
:return: The start_date of this SalesforceSourceFormProperties. # noqa: E501
294+
:rtype: str
295+
"""
296+
return self._start_date
297+
298+
@start_date.setter
299+
def start_date(self, start_date):
300+
"""Sets the start_date of this SalesforceSourceFormProperties.
301+
302+
The date from which Stitch should begin replicating data from Salesforce. Data from this date forward will be replicated. This field must contain an ISO 8601-compliant date, and the timestamp must be midnight. For example: 2018-01-01T00:00:00Z # noqa: E501
303+
304+
:param start_date: The start_date of this SalesforceSourceFormProperties. # noqa: E501
305+
:type: str
306+
"""
307+
if self.local_vars_configuration.client_side_validation and start_date is None: # noqa: E501
308+
raise ValueError("Invalid value for `start_date`, must not be `None`") # noqa: E501
309+
310+
self._start_date = start_date
311+
168312
def to_dict(self):
169313
"""Returns the model properties as a dict"""
170314
result = {}

0 commit comments

Comments
 (0)