sib-api-v3-sdk 8.1.0 → 9.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +82 -33
- data/docs/Body.md +3 -11
- data/docs/Body1.md +3 -11
- data/docs/Body10.md +11 -0
- data/docs/Body11.md +8 -0
- data/docs/Body12.md +11 -0
- data/docs/Body2.md +11 -0
- data/docs/Body3.md +9 -0
- data/docs/Body4.md +9 -0
- data/docs/Body5.md +11 -0
- data/docs/Body6.md +18 -0
- data/docs/Body7.md +17 -0
- data/docs/Body8.md +13 -0
- data/docs/Body9.md +8 -0
- data/docs/CompaniesApi.md +425 -0
- data/docs/CompaniesList.md +8 -0
- data/docs/Company.md +11 -0
- data/docs/CompanyAttributes.md +7 -0
- data/docs/CompanyAttributesInner.md +12 -0
- data/docs/ContactsApi.md +8 -2
- data/docs/{ListsApi.md → ConversationsApi.md} +115 -133
- data/docs/ConversationsMessage.md +17 -0
- data/docs/ConversationsMessageFile.md +12 -0
- data/docs/ConversationsMessageFileImageInfo.md +10 -0
- data/docs/CreateContact.md +1 -1
- data/docs/CreateEmailCampaign.md +2 -0
- data/docs/CreateEmailCampaignRecipients.md +1 -0
- data/docs/CreateSubAccount.md +3 -3
- data/docs/CreateSubAccountResponse.md +8 -0
- data/docs/Deal.md +11 -0
- data/docs/DealAttributes.md +7 -0
- data/docs/DealAttributesInner.md +12 -0
- data/docs/DealsApi.md +476 -0
- data/docs/DealsList.md +8 -0
- data/docs/EmailCampaignsApi.md +6 -5
- data/docs/FileData.md +3 -6
- data/docs/FileDownloadableLink.md +8 -0
- data/docs/FileList.md +7 -0
- data/docs/FilesApi.md +318 -0
- data/docs/GetCampaignStats.md +2 -0
- data/docs/GetScheduledEmailByBatchId.md +9 -0
- data/docs/GetScheduledEmailByBatchIdBatches.md +10 -0
- data/docs/GetScheduledEmailByMessageId.md +10 -0
- data/docs/GetSsoToken.md +1 -1
- data/docs/InboundParsingApi.md +60 -0
- data/docs/InlineResponse200.md +8 -0
- data/docs/InlineResponse201.md +8 -0
- data/docs/InlineResponse2011.md +8 -0
- data/docs/MasterAccountApi.md +6 -6
- data/docs/NoteData.md +1 -0
- data/docs/NoteId.md +8 -0
- data/docs/NoteList.md +7 -0
- data/docs/NotesApi.md +312 -0
- data/docs/Pipeline.md +8 -0
- data/docs/PipelineStage.md +9 -0
- data/docs/ScheduleSmtpEmail.md +10 -0
- data/docs/SendSmtpEmail.md +3 -1
- data/docs/SubAccountDetailsResponsePlanInfoCredits.md +1 -1
- data/docs/SubAccountsResponseSubAccounts.md +4 -4
- data/docs/Task.md +0 -11
- data/docs/TaskList.md +8 -0
- data/docs/TaskReminder.md +1 -1
- data/docs/TaskTypes.md +0 -1
- data/docs/{FoldersApi.md → TasksApi.md} +95 -91
- data/docs/TransactionalEmailsApi.md +201 -2
- data/docs/UpdateContact.md +1 -1
- data/docs/UpdateEmailCampaign.md +3 -1
- data/docs/UpdateEmailCampaignRecipients.md +2 -1
- data/docs/UpdateSmtpTemplate.md +1 -1
- data/docs/UploadImageModel.md +8 -0
- data/lib/sib-api-v3-sdk/api/companies_api.rb +409 -0
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +26 -0
- data/lib/sib-api-v3-sdk/api/conversations_api.rb +504 -0
- data/lib/sib-api-v3-sdk/api/deals_api.rb +454 -0
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +13 -8
- data/lib/sib-api-v3-sdk/api/files_api.rb +313 -0
- data/lib/sib-api-v3-sdk/api/inbound_parsing_api.rb +57 -1
- data/lib/sib-api-v3-sdk/api/master_account_api.rb +9 -9
- data/lib/sib-api-v3-sdk/api/notes_api.rb +308 -0
- data/lib/sib-api-v3-sdk/api/process_api.rb +4 -0
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +4 -0
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +4 -0
- data/lib/sib-api-v3-sdk/api/tasks_api.rb +375 -0
- data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +222 -3
- data/lib/sib-api-v3-sdk/models/body.rb +16 -111
- data/lib/sib-api-v3-sdk/models/body_1.rb +16 -116
- data/lib/sib-api-v3-sdk/models/body_10.rb +225 -0
- data/lib/sib-api-v3-sdk/models/body_11.rb +190 -0
- data/lib/sib-api-v3-sdk/models/body_12.rb +215 -0
- data/lib/sib-api-v3-sdk/models/body_2.rb +223 -0
- data/lib/sib-api-v3-sdk/models/body_3.rb +200 -0
- data/lib/sib-api-v3-sdk/models/body_4.rb +195 -0
- data/lib/sib-api-v3-sdk/models/body_5.rb +223 -0
- data/lib/sib-api-v3-sdk/models/body_6.rb +320 -0
- data/lib/sib-api-v3-sdk/models/body_7.rb +281 -0
- data/lib/sib-api-v3-sdk/models/body_8.rb +245 -0
- data/lib/sib-api-v3-sdk/models/body_9.rb +190 -0
- data/lib/sib-api-v3-sdk/models/companies_list.rb +188 -0
- data/lib/sib-api-v3-sdk/models/company.rb +220 -0
- data/lib/sib-api-v3-sdk/models/company_attributes.rb +176 -0
- data/lib/sib-api-v3-sdk/models/company_attributes_inner.rb +223 -0
- data/lib/sib-api-v3-sdk/models/conversations_message.rb +324 -0
- data/lib/sib-api-v3-sdk/models/conversations_message_file.rb +239 -0
- data/lib/sib-api-v3-sdk/models/conversations_message_file_image_info.rb +236 -0
- data/lib/sib-api-v3-sdk/models/create_contact.rb +1 -1
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +24 -4
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +17 -5
- data/lib/sib-api-v3-sdk/models/create_sub_account.rb +3 -3
- data/lib/sib-api-v3-sdk/models/create_sub_account_response.rb +190 -0
- data/lib/sib-api-v3-sdk/models/deal.rb +220 -0
- data/lib/sib-api-v3-sdk/models/deal_attributes.rb +176 -0
- data/lib/sib-api-v3-sdk/models/deal_attributes_inner.rb +223 -0
- data/lib/sib-api-v3-sdk/models/deals_list.rb +188 -0
- data/lib/sib-api-v3-sdk/models/file_data.rb +22 -54
- data/lib/sib-api-v3-sdk/models/file_downloadable_link.rb +190 -0
- data/lib/sib-api-v3-sdk/models/file_list.rb +176 -0
- data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +21 -1
- data/lib/sib-api-v3-sdk/models/get_scheduled_email_by_batch_id.rb +196 -0
- data/lib/sib-api-v3-sdk/models/{contact.rb → get_scheduled_email_by_batch_id_batches.rb} +62 -74
- data/lib/sib-api-v3-sdk/models/get_scheduled_email_by_message_id.rb +254 -0
- data/lib/sib-api-v3-sdk/models/get_sso_token.rb +1 -1
- data/lib/sib-api-v3-sdk/models/inline_response_200.rb +191 -0
- data/lib/sib-api-v3-sdk/models/inline_response_201.rb +191 -0
- data/lib/sib-api-v3-sdk/models/inline_response_201_1.rb +191 -0
- data/lib/sib-api-v3-sdk/models/note_data.rb +16 -4
- data/lib/sib-api-v3-sdk/models/note_id.rb +186 -0
- data/lib/sib-api-v3-sdk/models/note_list.rb +176 -0
- data/lib/sib-api-v3-sdk/models/pipeline.rb +188 -0
- data/lib/sib-api-v3-sdk/models/pipeline_stage.rb +196 -0
- data/lib/sib-api-v3-sdk/models/schedule_smtp_email.rb +206 -0
- data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +24 -4
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits.rb +2 -2
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits_emails.rb +1 -1
- data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features.rb +1 -1
- data/lib/sib-api-v3-sdk/models/sub_accounts_response_sub_accounts.rb +4 -4
- data/lib/sib-api-v3-sdk/models/task.rb +4 -119
- data/lib/sib-api-v3-sdk/models/task_list.rb +188 -0
- data/lib/sib-api-v3-sdk/models/task_reminder.rb +1 -1
- data/lib/sib-api-v3-sdk/models/task_types.rb +1 -11
- data/lib/sib-api-v3-sdk/models/update_contact.rb +1 -1
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +25 -5
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +18 -6
- data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +1 -1
- data/lib/sib-api-v3-sdk/models/upload_image_model.rb +190 -0
- data/lib/sib-api-v3-sdk/version.rb +1 -1
- data/lib/sib-api-v3-sdk.rb +44 -5
- data/spec/api/companies_api_spec.rb +119 -0
- data/spec/api/contacts_api_spec.rb +2 -0
- data/spec/api/{crm_api_spec.rb → conversations_api_spec.rb} +54 -94
- data/spec/api/{lists_api_spec.rb → deals_api_spec.rb} +51 -68
- data/spec/api/email_campaigns_api_spec.rb +1 -1
- data/spec/api/files_api_spec.rb +99 -0
- data/spec/api/inbound_parsing_api_spec.rb +12 -0
- data/spec/api/master_account_api_spec.rb +4 -4
- data/spec/api/notes_api_spec.rb +97 -0
- data/spec/api/{folders_api_spec.rb → tasks_api_spec.rb} +47 -41
- data/spec/api/transactional_emails_api_spec.rb +44 -0
- data/spec/models/body_10_spec.rb +59 -0
- data/spec/models/body_11_spec.rb +41 -0
- data/spec/models/body_12_spec.rb +59 -0
- data/spec/models/body_1_spec.rb +2 -50
- data/spec/models/body_2_spec.rb +59 -0
- data/spec/models/body_3_spec.rb +47 -0
- data/spec/models/body_4_spec.rb +47 -0
- data/spec/models/body_5_spec.rb +59 -0
- data/spec/models/body_6_spec.rb +101 -0
- data/spec/models/{contact_spec.rb → body_7_spec.rb} +26 -14
- data/spec/{api/attributes_api_spec.rb → models/body_8_spec.rb} +22 -34
- data/spec/models/body_9_spec.rb +41 -0
- data/spec/models/body_spec.rb +2 -50
- data/spec/models/companies_list_spec.rb +41 -0
- data/spec/models/company_attributes_inner_spec.rb +65 -0
- data/spec/models/company_attributes_spec.rb +35 -0
- data/spec/models/company_spec.rb +59 -0
- data/spec/models/conversations_message_file_image_info_spec.rb +53 -0
- data/spec/models/conversations_message_file_spec.rb +65 -0
- data/spec/models/conversations_message_spec.rb +99 -0
- data/spec/models/create_email_campaign_recipients_spec.rb +6 -0
- data/spec/models/create_email_campaign_spec.rb +12 -0
- data/spec/models/create_sub_account_response_spec.rb +41 -0
- data/spec/models/deal_attributes_inner_spec.rb +65 -0
- data/spec/models/deal_attributes_spec.rb +35 -0
- data/spec/models/deal_spec.rb +59 -0
- data/spec/models/deals_list_spec.rb +41 -0
- data/spec/models/file_data_spec.rb +3 -21
- data/spec/models/file_downloadable_link_spec.rb +41 -0
- data/spec/models/file_list_spec.rb +35 -0
- data/spec/models/get_campaign_stats_spec.rb +12 -0
- data/spec/models/get_scheduled_email_by_batch_id_batches_spec.rb +57 -0
- data/spec/models/get_scheduled_email_by_batch_id_spec.rb +47 -0
- data/spec/models/get_scheduled_email_by_message_id_spec.rb +57 -0
- data/spec/models/inline_response_200_spec.rb +41 -0
- data/spec/models/inline_response_201_1_spec.rb +41 -0
- data/spec/models/inline_response_201_spec.rb +41 -0
- data/spec/models/note_data_spec.rb +6 -0
- data/spec/models/note_id_spec.rb +41 -0
- data/spec/models/note_list_spec.rb +35 -0
- data/spec/models/pipeline_spec.rb +41 -0
- data/spec/models/pipeline_stage_spec.rb +47 -0
- data/spec/models/schedule_smtp_email_spec.rb +53 -0
- data/spec/models/send_smtp_email_spec.rb +12 -0
- data/spec/models/task_list_spec.rb +41 -0
- data/spec/models/task_spec.rb +0 -66
- data/spec/models/task_types_spec.rb +0 -6
- data/spec/models/update_email_campaign_recipients_spec.rb +6 -0
- data/spec/models/update_email_campaign_spec.rb +12 -0
- data/spec/models/upload_image_model_spec.rb +41 -0
- metadata +179 -23
- data/docs/AttributesApi.md +0 -246
- data/docs/CRMApi.md +0 -762
- data/docs/Contact.md +0 -15
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +0 -274
- data/lib/sib-api-v3-sdk/api/crm_api.rb +0 -716
- data/lib/sib-api-v3-sdk/api/folders_api.rb +0 -383
- data/lib/sib-api-v3-sdk/api/lists_api.rb +0 -562
data/docs/AttributesApi.md
DELETED
@@ -1,246 +0,0 @@
|
|
1
|
-
# SibApiV3Sdk::AttributesApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://api.sendinblue.com/v3*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**create_attribute**](AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
|
8
|
-
[**delete_attribute**](AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
|
9
|
-
[**get_attributes**](AttributesApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
|
10
|
-
[**update_attribute**](AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
|
11
|
-
|
12
|
-
|
13
|
-
# **create_attribute**
|
14
|
-
> create_attribute(attribute_category, attribute_name, create_attribute)
|
15
|
-
|
16
|
-
Create contact attribute
|
17
|
-
|
18
|
-
### Example
|
19
|
-
```ruby
|
20
|
-
# load the gem
|
21
|
-
require 'sib-api-v3-sdk'
|
22
|
-
# setup authorization
|
23
|
-
SibApiV3Sdk.configure do |config|
|
24
|
-
# Configure API key authorization: api-key
|
25
|
-
config.api_key['api-key'] = 'YOUR API KEY'
|
26
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
27
|
-
#config.api_key_prefix['api-key'] = 'Bearer'
|
28
|
-
|
29
|
-
# Configure API key authorization: partner-key
|
30
|
-
config.api_key['partner-key'] = 'YOUR API KEY'
|
31
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
32
|
-
#config.api_key_prefix['partner-key'] = 'Bearer'
|
33
|
-
end
|
34
|
-
|
35
|
-
api_instance = SibApiV3Sdk::AttributesApi.new
|
36
|
-
|
37
|
-
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
38
|
-
|
39
|
-
attribute_name = 'attribute_name_example' # String | Name of the attribute
|
40
|
-
|
41
|
-
create_attribute = SibApiV3Sdk::CreateAttribute.new # CreateAttribute | Values to create an attribute
|
42
|
-
|
43
|
-
|
44
|
-
begin
|
45
|
-
#Create contact attribute
|
46
|
-
api_instance.create_attribute(attribute_category, attribute_name, create_attribute)
|
47
|
-
rescue SibApiV3Sdk::ApiError => e
|
48
|
-
puts "Exception when calling AttributesApi->create_attribute: #{e}"
|
49
|
-
end
|
50
|
-
```
|
51
|
-
|
52
|
-
### Parameters
|
53
|
-
|
54
|
-
Name | Type | Description | Notes
|
55
|
-
------------- | ------------- | ------------- | -------------
|
56
|
-
**attribute_category** | **String**| Category of the attribute |
|
57
|
-
**attribute_name** | **String**| Name of the attribute |
|
58
|
-
**create_attribute** | [**CreateAttribute**](CreateAttribute.md)| Values to create an attribute |
|
59
|
-
|
60
|
-
### Return type
|
61
|
-
|
62
|
-
nil (empty response body)
|
63
|
-
|
64
|
-
### Authorization
|
65
|
-
|
66
|
-
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
67
|
-
|
68
|
-
### HTTP request headers
|
69
|
-
|
70
|
-
- **Content-Type**: application/json
|
71
|
-
- **Accept**: application/json
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
# **delete_attribute**
|
76
|
-
> delete_attribute(attribute_category, attribute_name)
|
77
|
-
|
78
|
-
Delete an attribute
|
79
|
-
|
80
|
-
### Example
|
81
|
-
```ruby
|
82
|
-
# load the gem
|
83
|
-
require 'sib-api-v3-sdk'
|
84
|
-
# setup authorization
|
85
|
-
SibApiV3Sdk.configure do |config|
|
86
|
-
# Configure API key authorization: api-key
|
87
|
-
config.api_key['api-key'] = 'YOUR API KEY'
|
88
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
89
|
-
#config.api_key_prefix['api-key'] = 'Bearer'
|
90
|
-
|
91
|
-
# Configure API key authorization: partner-key
|
92
|
-
config.api_key['partner-key'] = 'YOUR API KEY'
|
93
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
94
|
-
#config.api_key_prefix['partner-key'] = 'Bearer'
|
95
|
-
end
|
96
|
-
|
97
|
-
api_instance = SibApiV3Sdk::AttributesApi.new
|
98
|
-
|
99
|
-
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
100
|
-
|
101
|
-
attribute_name = 'attribute_name_example' # String | Name of the existing attribute
|
102
|
-
|
103
|
-
|
104
|
-
begin
|
105
|
-
#Delete an attribute
|
106
|
-
api_instance.delete_attribute(attribute_category, attribute_name)
|
107
|
-
rescue SibApiV3Sdk::ApiError => e
|
108
|
-
puts "Exception when calling AttributesApi->delete_attribute: #{e}"
|
109
|
-
end
|
110
|
-
```
|
111
|
-
|
112
|
-
### Parameters
|
113
|
-
|
114
|
-
Name | Type | Description | Notes
|
115
|
-
------------- | ------------- | ------------- | -------------
|
116
|
-
**attribute_category** | **String**| Category of the attribute |
|
117
|
-
**attribute_name** | **String**| Name of the existing attribute |
|
118
|
-
|
119
|
-
### Return type
|
120
|
-
|
121
|
-
nil (empty response body)
|
122
|
-
|
123
|
-
### Authorization
|
124
|
-
|
125
|
-
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
126
|
-
|
127
|
-
### HTTP request headers
|
128
|
-
|
129
|
-
- **Content-Type**: application/json
|
130
|
-
- **Accept**: application/json
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
# **get_attributes**
|
135
|
-
> GetAttributes get_attributes
|
136
|
-
|
137
|
-
List all attributes
|
138
|
-
|
139
|
-
### Example
|
140
|
-
```ruby
|
141
|
-
# load the gem
|
142
|
-
require 'sib-api-v3-sdk'
|
143
|
-
# setup authorization
|
144
|
-
SibApiV3Sdk.configure do |config|
|
145
|
-
# Configure API key authorization: api-key
|
146
|
-
config.api_key['api-key'] = 'YOUR API KEY'
|
147
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
148
|
-
#config.api_key_prefix['api-key'] = 'Bearer'
|
149
|
-
|
150
|
-
# Configure API key authorization: partner-key
|
151
|
-
config.api_key['partner-key'] = 'YOUR API KEY'
|
152
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
153
|
-
#config.api_key_prefix['partner-key'] = 'Bearer'
|
154
|
-
end
|
155
|
-
|
156
|
-
api_instance = SibApiV3Sdk::AttributesApi.new
|
157
|
-
|
158
|
-
begin
|
159
|
-
#List all attributes
|
160
|
-
result = api_instance.get_attributes
|
161
|
-
p result
|
162
|
-
rescue SibApiV3Sdk::ApiError => e
|
163
|
-
puts "Exception when calling AttributesApi->get_attributes: #{e}"
|
164
|
-
end
|
165
|
-
```
|
166
|
-
|
167
|
-
### Parameters
|
168
|
-
This endpoint does not need any parameter.
|
169
|
-
|
170
|
-
### Return type
|
171
|
-
|
172
|
-
[**GetAttributes**](GetAttributes.md)
|
173
|
-
|
174
|
-
### Authorization
|
175
|
-
|
176
|
-
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
177
|
-
|
178
|
-
### HTTP request headers
|
179
|
-
|
180
|
-
- **Content-Type**: application/json
|
181
|
-
- **Accept**: application/json
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
# **update_attribute**
|
186
|
-
> update_attribute(attribute_category, attribute_name, update_attribute)
|
187
|
-
|
188
|
-
Update contact attribute
|
189
|
-
|
190
|
-
### Example
|
191
|
-
```ruby
|
192
|
-
# load the gem
|
193
|
-
require 'sib-api-v3-sdk'
|
194
|
-
# setup authorization
|
195
|
-
SibApiV3Sdk.configure do |config|
|
196
|
-
# Configure API key authorization: api-key
|
197
|
-
config.api_key['api-key'] = 'YOUR API KEY'
|
198
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
199
|
-
#config.api_key_prefix['api-key'] = 'Bearer'
|
200
|
-
|
201
|
-
# Configure API key authorization: partner-key
|
202
|
-
config.api_key['partner-key'] = 'YOUR API KEY'
|
203
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
204
|
-
#config.api_key_prefix['partner-key'] = 'Bearer'
|
205
|
-
end
|
206
|
-
|
207
|
-
api_instance = SibApiV3Sdk::AttributesApi.new
|
208
|
-
|
209
|
-
attribute_category = 'attribute_category_example' # String | Category of the attribute
|
210
|
-
|
211
|
-
attribute_name = 'attribute_name_example' # String | Name of the existing attribute
|
212
|
-
|
213
|
-
update_attribute = SibApiV3Sdk::UpdateAttribute.new # UpdateAttribute | Values to update an attribute
|
214
|
-
|
215
|
-
|
216
|
-
begin
|
217
|
-
#Update contact attribute
|
218
|
-
api_instance.update_attribute(attribute_category, attribute_name, update_attribute)
|
219
|
-
rescue SibApiV3Sdk::ApiError => e
|
220
|
-
puts "Exception when calling AttributesApi->update_attribute: #{e}"
|
221
|
-
end
|
222
|
-
```
|
223
|
-
|
224
|
-
### Parameters
|
225
|
-
|
226
|
-
Name | Type | Description | Notes
|
227
|
-
------------- | ------------- | ------------- | -------------
|
228
|
-
**attribute_category** | **String**| Category of the attribute |
|
229
|
-
**attribute_name** | **String**| Name of the existing attribute |
|
230
|
-
**update_attribute** | [**UpdateAttribute**](UpdateAttribute.md)| Values to update an attribute |
|
231
|
-
|
232
|
-
### Return type
|
233
|
-
|
234
|
-
nil (empty response body)
|
235
|
-
|
236
|
-
### Authorization
|
237
|
-
|
238
|
-
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
239
|
-
|
240
|
-
### HTTP request headers
|
241
|
-
|
242
|
-
- **Content-Type**: application/json
|
243
|
-
- **Accept**: application/json
|
244
|
-
|
245
|
-
|
246
|
-
|