Skip to content

AP-1238: Updating wrapper to version v7.2.0 for batch sending #60

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.

Sign up for GitHub

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 1 commit into from
Jan 22, 2021
Merged

AP-1238: Updating wrapper to version v7.2.0 for batch sending #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 10 additions & 10 deletions docs/ContactsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -805,7 +805,7 @@ api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration
limit = 50 # int | Number of documents per page (optional) (default to 50)
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
modified_since = '2013-10-20T19:20:30+01:00' # datetime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc)

try:
# Get all the contacts
Expand All @@ -822,7 +822,7 @@ Name | Type | Description | Notes
**limit** | **int**| Number of documents per page | [optional] [default to 50]
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
**modified_since** | **datetime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
**sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
**sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]

### Return type

Expand Down Expand Up @@ -869,7 +869,7 @@ list_id = 789 # int | Id of the list
modified_since = '2013-10-20T19:20:30+01:00' # datetime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional)
limit = 50 # int | Number of documents per page (optional) (default to 50)
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc)

try:
# Get contacts in a list
Expand All @@ -887,7 +887,7 @@ Name | Type | Description | Notes
**modified_since** | **datetime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
**limit** | **int**| Number of documents per page | [optional] [default to 50]
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
**sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
**sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]

### Return type

Expand Down Expand Up @@ -990,7 +990,7 @@ api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration
folder_id = 789 # int | Id of the folder
limit = 10 # int | Number of documents per page (optional) (default to 10)
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc)

try:
# Get lists in a folder
Expand All @@ -1007,7 +1007,7 @@ Name | Type | Description | Notes
**folder_id** | **int**| Id of the folder |
**limit** | **int**| Number of documents per page | [optional] [default to 10]
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
**sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
**sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]

### Return type

Expand Down Expand Up @@ -1052,7 +1052,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
limit = 10 # int | Number of documents per page (default to 10)
offset = 0 # int | Index of the first document of the page (default to 0)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc)

try:
# Get all folders
Expand All @@ -1068,7 +1068,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **int**| Number of documents per page | [default to 10]
**offset** | **int**| Index of the first document of the page | [default to 0]
**sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
**sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]

### Return type

Expand Down Expand Up @@ -1170,7 +1170,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
limit = 10 # int | Number of documents per page (optional) (default to 10)
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc)

try:
# Get all the lists
Expand All @@ -1186,7 +1186,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **int**| Number of documents per page | [optional] [default to 10]
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
**sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
**sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]

### Return type

Expand Down
3 changes: 2 additions & 1 deletion docs/CreateSmtpEmail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**message_id** | **str** | Message ID of the transactional email sent |
**message_id** | **str** | Message ID of the transactional email sent | [optional]
**message_ids** | **list[str]** | | [optional]

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

Expand Down
4 changes: 2 additions & 2 deletions docs/EmailCampaignsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ start_date = '2013-10-20T19:20:30+01:00' # datetime | Mandatory if endDate is us
end_date = '2013-10-20T19:20:30+01:00' # datetime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional)
limit = 500 # int | Number of documents per page (optional) (default to 500)
offset = 0 # int | Index of the first document in the page (optional) (default to 0)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc)

try:
# Return all your created email campaigns
Expand All @@ -359,7 +359,7 @@ Name | Type | Description | Notes
**end_date** | **datetime**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
**limit** | **int**| Number of documents per page | [optional] [default to 500]
**offset** | **int**| Index of the first document in the page | [optional] [default to 0]
**sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
**sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]

### Return type

Expand Down
8 changes: 4 additions & 4 deletions docs/FoldersApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ api_instance = sib_api_v3_sdk.FoldersApi(sib_api_v3_sdk.ApiClient(configuration)
folder_id = 789 # int | Id of the folder
limit = 10 # int | Number of documents per page (optional) (default to 10)
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc)

try:
# Get lists in a folder
Expand All @@ -228,7 +228,7 @@ Name | Type | Description | Notes
**folder_id** | **int**| Id of the folder |
**limit** | **int**| Number of documents per page | [optional] [default to 10]
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
**sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
**sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]

### Return type

Expand Down Expand Up @@ -273,7 +273,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
api_instance = sib_api_v3_sdk.FoldersApi(sib_api_v3_sdk.ApiClient(configuration))
limit = 10 # int | Number of documents per page (default to 10)
offset = 0 # int | Index of the first document of the page (default to 0)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc)

try:
# Get all folders
Expand All @@ -289,7 +289,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **int**| Number of documents per page | [default to 10]
**offset** | **int**| Index of the first document of the page | [default to 0]
**sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
**sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]

### Return type

Expand Down
12 changes: 6 additions & 6 deletions docs/ListsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ list_id = 789 # int | Id of the list
modified_since = '2013-10-20T19:20:30+01:00' # datetime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional)
limit = 50 # int | Number of documents per page (optional) (default to 50)
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc)

try:
# Get contacts in a list
Expand All @@ -235,7 +235,7 @@ Name | Type | Description | Notes
**modified_since** | **datetime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
**limit** | **int**| Number of documents per page | [optional] [default to 50]
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
**sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
**sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]

### Return type

Expand Down Expand Up @@ -281,7 +281,7 @@ api_instance = sib_api_v3_sdk.ListsApi(sib_api_v3_sdk.ApiClient(configuration))
folder_id = 789 # int | Id of the folder
limit = 10 # int | Number of documents per page (optional) (default to 10)
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc)

try:
# Get lists in a folder
Expand All @@ -298,7 +298,7 @@ Name | Type | Description | Notes
**folder_id** | **int**| Id of the folder |
**limit** | **int**| Number of documents per page | [optional] [default to 10]
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
**sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
**sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]

### Return type

Expand Down Expand Up @@ -400,7 +400,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
api_instance = sib_api_v3_sdk.ListsApi(sib_api_v3_sdk.ApiClient(configuration))
limit = 10 # int | Number of documents per page (optional) (default to 10)
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc)

try:
# Get all the lists
Expand All @@ -416,7 +416,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **int**| Number of documents per page | [optional] [default to 10]
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
**sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
**sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]

### Return type

Expand Down
4 changes: 2 additions & 2 deletions docs/ProcessApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
api_instance = sib_api_v3_sdk.ProcessApi(sib_api_v3_sdk.ApiClient(configuration))
limit = 10 # int | Number limitation for the result returned (optional) (default to 10)
offset = 0 # int | Beginning point in the list to retrieve from. (optional) (default to 0)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc)

try:
# Return all the processes for your account
Expand All @@ -109,7 +109,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **int**| Number limitation for the result returned | [optional] [default to 10]
**offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0]
**sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
**sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]

### Return type

Expand Down
4 changes: 2 additions & 2 deletions docs/SMSCampaignsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ start_date = '2013-10-20T19:20:30+01:00' # datetime | Mandatory if endDate is us
end_date = '2013-10-20T19:20:30+01:00' # datetime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional)
limit = 500 # int | Number limitation for the result returned (optional) (default to 500)
offset = 0 # int | Beginning point in the list to retrieve from. (optional) (default to 0)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc)

try:
# Returns the information for all your created SMS campaigns
Expand All @@ -236,7 +236,7 @@ Name | Type | Description | Notes
**end_date** | **datetime**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
**limit** | **int**| Number limitation for the result returned | [optional] [default to 500]
**offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0]
**sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
**sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]

### Return type

Expand Down
Loading