hubspot-api-client 16.0.4 → 16.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/Gemfile.lock +1 -1
- data/lib/hubspot/codegen/crm/objects/postal_mail/api/associations_api.rb +264 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/api/basic_api.rb +391 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/api/batch_api.rb +295 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/api/public_object_api.rb +94 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/api/search_api.rb +92 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/api_client.rb +412 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/api_error.rb +63 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/configuration.rb +296 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/associated_id.rb +244 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/association_spec.rb +278 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/association_spec_with_label.rb +287 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/batch_input_simple_public_object_batch_input.rb +232 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/batch_input_simple_public_object_id.rb +232 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/batch_input_simple_public_object_input.rb +232 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/batch_read_input_simple_public_object_id.rb +273 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/batch_response_simple_public_object.rb +328 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/batch_response_simple_public_object_with_errors.rb +348 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/collection_response_associated_id.rb +241 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/collection_response_multi_associated_object_with_label_forward_paging.rb +241 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/collection_response_simple_public_object_with_associations_forward_paging.rb +241 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/collection_response_with_total_simple_public_object_forward_paging.rb +255 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/error.rb +307 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/error_category.rb +278 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/error_detail.rb +273 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/filter.rb +299 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/filter_group.rb +232 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/forward_paging.rb +225 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/labels_between_object_pair.rb +288 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/multi_associated_object_with_label.rb +246 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/next_page.rb +239 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/paging.rb +234 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/previous_page.rb +239 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/public_merge_input.rb +244 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/public_object_search_request.rb +301 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/simple_public_object.rb +303 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/simple_public_object_batch_input.rb +246 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/simple_public_object_id.rb +230 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/simple_public_object_input.rb +232 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/simple_public_object_with_associations.rb +314 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/standard_error.rb +324 -0
- data/lib/hubspot/codegen/crm/objects/postal_mail/models/value_with_timestamp.rb +285 -0
- data/lib/hubspot/codegen/marketing/events/models/property_value.rb +13 -4
- data/lib/hubspot/discovery/crm/objects/client.rb +1 -0
- data/lib/hubspot/discovery/crm/objects/postal_mail/api/associations_api.rb +15 -0
- data/lib/hubspot/discovery/crm/objects/postal_mail/api/basic_api.rb +15 -0
- data/lib/hubspot/discovery/crm/objects/postal_mail/api/batch_api.rb +15 -0
- data/lib/hubspot/discovery/crm/objects/postal_mail/api/public_object_api.rb +15 -0
- data/lib/hubspot/discovery/crm/objects/postal_mail/api/search_api.rb +15 -0
- data/lib/hubspot/discovery/crm/objects/postal_mail/client.rb +25 -0
- data/lib/hubspot/version.rb +1 -1
- data/spec/discovery/crm/objects/postal_mail/associations_api_spec.rb +9 -0
- data/spec/discovery/crm/objects/postal_mail/basic_api_spec.rb +10 -0
- data/spec/discovery/crm/objects/postal_mail/batch_api_spec.rb +10 -0
- data/spec/discovery/crm/objects/postal_mail/public_object_api_spec.rb +7 -0
- data/spec/discovery/crm/objects/postal_mail/search_api_spec.rb +7 -0
- metadata +59 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 79bd74c64d716c37ef44d823499d823a5718cbc9b2bddbee9153ace3e92846b2
|
4
|
+
data.tar.gz: 6b2305f92d525f62f9ccca5883e87bb11d2b9971150af08fe9f508b4f4d9188f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 47b6759f025b1dc365f841974763cc3cdde18f8a62245079772073ae6eb296d0d5716081daedff991a5e9dba29060f24dfff73e7944f0d250600ccd5c5b6b3ee
|
7
|
+
data.tar.gz: e0fddcf226c4b0cbffd2e3690b167bfcbc016f8d62920ef70efaea438ff5bfc63eb6eb71091db8d8400cd8724a403d40c4e94d3ebc6a7e28f85ce583aed71f74
|
data/CHANGELOG.md
CHANGED
@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
7
7
|
|
8
|
+
## [16.1.0] - 2022-12-22
|
9
|
+
### Added
|
10
|
+
|
11
|
+
- crm.objects.postal_mail API client
|
12
|
+
|
8
13
|
## [16.0.4] - 2022-12-08
|
9
14
|
### Changed
|
10
15
|
|
data/Gemfile.lock
CHANGED
@@ -0,0 +1,264 @@
|
|
1
|
+
=begin
|
2
|
+
#Postal Mail
|
3
|
+
|
4
|
+
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
|
+
|
6
|
+
The version of the OpenAPI document: v3
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.2.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module Hubspot
|
16
|
+
module Crm
|
17
|
+
module Objects
|
18
|
+
module PostalMail
|
19
|
+
class AssociationsApi
|
20
|
+
attr_accessor :api_client
|
21
|
+
|
22
|
+
def initialize(api_client = ApiClient.default)
|
23
|
+
@api_client = api_client
|
24
|
+
end
|
25
|
+
# Delete
|
26
|
+
# deletes all associations between two records.
|
27
|
+
# @param postal_mail [Integer]
|
28
|
+
# @param to_object_type [String]
|
29
|
+
# @param to_object_id [Integer]
|
30
|
+
# @param [Hash] opts the optional parameters
|
31
|
+
# @return [nil]
|
32
|
+
def archive(postal_mail, to_object_type, to_object_id, opts = {})
|
33
|
+
archive_with_http_info(postal_mail, to_object_type, to_object_id, opts)
|
34
|
+
nil
|
35
|
+
end
|
36
|
+
|
37
|
+
# Delete
|
38
|
+
# deletes all associations between two records.
|
39
|
+
# @param postal_mail [Integer]
|
40
|
+
# @param to_object_type [String]
|
41
|
+
# @param to_object_id [Integer]
|
42
|
+
# @param [Hash] opts the optional parameters
|
43
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
44
|
+
def archive_with_http_info(postal_mail, to_object_type, to_object_id, opts = {})
|
45
|
+
if @api_client.config.debugging
|
46
|
+
@api_client.config.logger.debug 'Calling API: AssociationsApi.archive ...'
|
47
|
+
end
|
48
|
+
# verify the required parameter 'postal_mail' is set
|
49
|
+
if @api_client.config.client_side_validation && postal_mail.nil?
|
50
|
+
fail ArgumentError, "Missing the required parameter 'postal_mail' when calling AssociationsApi.archive"
|
51
|
+
end
|
52
|
+
# verify the required parameter 'to_object_type' is set
|
53
|
+
if @api_client.config.client_side_validation && to_object_type.nil?
|
54
|
+
fail ArgumentError, "Missing the required parameter 'to_object_type' when calling AssociationsApi.archive"
|
55
|
+
end
|
56
|
+
# verify the required parameter 'to_object_id' is set
|
57
|
+
if @api_client.config.client_side_validation && to_object_id.nil?
|
58
|
+
fail ArgumentError, "Missing the required parameter 'to_object_id' when calling AssociationsApi.archive"
|
59
|
+
end
|
60
|
+
# resource path
|
61
|
+
local_var_path = '/crm/v4/objects/postal_mail/{postalMail}/associations/{toObjectType}/{toObjectId}'.sub('{' + 'postalMail' + '}', CGI.escape(postal_mail.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s))
|
62
|
+
|
63
|
+
# query parameters
|
64
|
+
query_params = opts[:query_params] || {}
|
65
|
+
|
66
|
+
# header parameters
|
67
|
+
header_params = opts[:header_params] || {}
|
68
|
+
# HTTP header 'Accept' (if needed)
|
69
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
70
|
+
|
71
|
+
# form parameters
|
72
|
+
form_params = opts[:form_params] || {}
|
73
|
+
|
74
|
+
# http body (model)
|
75
|
+
post_body = opts[:debug_body]
|
76
|
+
|
77
|
+
# return_type
|
78
|
+
return_type = opts[:debug_return_type]
|
79
|
+
|
80
|
+
# auth_names
|
81
|
+
auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
|
82
|
+
|
83
|
+
new_options = opts.merge(
|
84
|
+
:operation => :"AssociationsApi.archive",
|
85
|
+
:header_params => header_params,
|
86
|
+
:query_params => query_params,
|
87
|
+
:form_params => form_params,
|
88
|
+
:body => post_body,
|
89
|
+
:auth_names => auth_names,
|
90
|
+
:return_type => return_type
|
91
|
+
)
|
92
|
+
|
93
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
94
|
+
if @api_client.config.debugging
|
95
|
+
@api_client.config.logger.debug "API called: AssociationsApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
96
|
+
end
|
97
|
+
return data, status_code, headers
|
98
|
+
end
|
99
|
+
|
100
|
+
# Create
|
101
|
+
# Set association labels between two records.
|
102
|
+
# @param postal_mail [Integer]
|
103
|
+
# @param to_object_type [String]
|
104
|
+
# @param to_object_id [Integer]
|
105
|
+
# @param association_spec [Array<AssociationSpec>]
|
106
|
+
# @param [Hash] opts the optional parameters
|
107
|
+
# @return [LabelsBetweenObjectPair]
|
108
|
+
def create(postal_mail, to_object_type, to_object_id, association_spec, opts = {})
|
109
|
+
data, _status_code, _headers = create_with_http_info(postal_mail, to_object_type, to_object_id, association_spec, opts)
|
110
|
+
data
|
111
|
+
end
|
112
|
+
|
113
|
+
# Create
|
114
|
+
# Set association labels between two records.
|
115
|
+
# @param postal_mail [Integer]
|
116
|
+
# @param to_object_type [String]
|
117
|
+
# @param to_object_id [Integer]
|
118
|
+
# @param association_spec [Array<AssociationSpec>]
|
119
|
+
# @param [Hash] opts the optional parameters
|
120
|
+
# @return [Array<(LabelsBetweenObjectPair, Integer, Hash)>] LabelsBetweenObjectPair data, response status code and response headers
|
121
|
+
def create_with_http_info(postal_mail, to_object_type, to_object_id, association_spec, opts = {})
|
122
|
+
if @api_client.config.debugging
|
123
|
+
@api_client.config.logger.debug 'Calling API: AssociationsApi.create ...'
|
124
|
+
end
|
125
|
+
# verify the required parameter 'postal_mail' is set
|
126
|
+
if @api_client.config.client_side_validation && postal_mail.nil?
|
127
|
+
fail ArgumentError, "Missing the required parameter 'postal_mail' when calling AssociationsApi.create"
|
128
|
+
end
|
129
|
+
# verify the required parameter 'to_object_type' is set
|
130
|
+
if @api_client.config.client_side_validation && to_object_type.nil?
|
131
|
+
fail ArgumentError, "Missing the required parameter 'to_object_type' when calling AssociationsApi.create"
|
132
|
+
end
|
133
|
+
# verify the required parameter 'to_object_id' is set
|
134
|
+
if @api_client.config.client_side_validation && to_object_id.nil?
|
135
|
+
fail ArgumentError, "Missing the required parameter 'to_object_id' when calling AssociationsApi.create"
|
136
|
+
end
|
137
|
+
# verify the required parameter 'association_spec' is set
|
138
|
+
if @api_client.config.client_side_validation && association_spec.nil?
|
139
|
+
fail ArgumentError, "Missing the required parameter 'association_spec' when calling AssociationsApi.create"
|
140
|
+
end
|
141
|
+
# resource path
|
142
|
+
local_var_path = '/crm/v4/objects/postal_mail/{postalMail}/associations/{toObjectType}/{toObjectId}'.sub('{' + 'postalMail' + '}', CGI.escape(postal_mail.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s))
|
143
|
+
|
144
|
+
# query parameters
|
145
|
+
query_params = opts[:query_params] || {}
|
146
|
+
|
147
|
+
# header parameters
|
148
|
+
header_params = opts[:header_params] || {}
|
149
|
+
# HTTP header 'Accept' (if needed)
|
150
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
|
151
|
+
# HTTP header 'Content-Type'
|
152
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
153
|
+
if !content_type.nil?
|
154
|
+
header_params['Content-Type'] = content_type
|
155
|
+
end
|
156
|
+
|
157
|
+
# form parameters
|
158
|
+
form_params = opts[:form_params] || {}
|
159
|
+
|
160
|
+
# http body (model)
|
161
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(association_spec)
|
162
|
+
|
163
|
+
# return_type
|
164
|
+
return_type = opts[:debug_return_type] || 'LabelsBetweenObjectPair'
|
165
|
+
|
166
|
+
# auth_names
|
167
|
+
auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
|
168
|
+
|
169
|
+
new_options = opts.merge(
|
170
|
+
:operation => :"AssociationsApi.create",
|
171
|
+
:header_params => header_params,
|
172
|
+
:query_params => query_params,
|
173
|
+
:form_params => form_params,
|
174
|
+
:body => post_body,
|
175
|
+
:auth_names => auth_names,
|
176
|
+
:return_type => return_type
|
177
|
+
)
|
178
|
+
|
179
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
180
|
+
if @api_client.config.debugging
|
181
|
+
@api_client.config.logger.debug "API called: AssociationsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
182
|
+
end
|
183
|
+
return data, status_code, headers
|
184
|
+
end
|
185
|
+
|
186
|
+
# List
|
187
|
+
# List all associations of a postal mail by object type. Limit 1000 per call.
|
188
|
+
# @param postal_mail [Integer]
|
189
|
+
# @param to_object_type [String]
|
190
|
+
# @param [Hash] opts the optional parameters
|
191
|
+
# @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
|
192
|
+
# @option opts [Integer] :limit The maximum number of results to display per page. (default to 500)
|
193
|
+
# @return [CollectionResponseMultiAssociatedObjectWithLabelForwardPaging]
|
194
|
+
def get_all(postal_mail, to_object_type, opts = {})
|
195
|
+
data, _status_code, _headers = get_all_with_http_info(postal_mail, to_object_type, opts)
|
196
|
+
data
|
197
|
+
end
|
198
|
+
|
199
|
+
# List
|
200
|
+
# List all associations of a postal mail by object type. Limit 1000 per call.
|
201
|
+
# @param postal_mail [Integer]
|
202
|
+
# @param to_object_type [String]
|
203
|
+
# @param [Hash] opts the optional parameters
|
204
|
+
# @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
|
205
|
+
# @option opts [Integer] :limit The maximum number of results to display per page. (default to 500)
|
206
|
+
# @return [Array<(CollectionResponseMultiAssociatedObjectWithLabelForwardPaging, Integer, Hash)>] CollectionResponseMultiAssociatedObjectWithLabelForwardPaging data, response status code and response headers
|
207
|
+
def get_all_with_http_info(postal_mail, to_object_type, opts = {})
|
208
|
+
if @api_client.config.debugging
|
209
|
+
@api_client.config.logger.debug 'Calling API: AssociationsApi.get_all ...'
|
210
|
+
end
|
211
|
+
# verify the required parameter 'postal_mail' is set
|
212
|
+
if @api_client.config.client_side_validation && postal_mail.nil?
|
213
|
+
fail ArgumentError, "Missing the required parameter 'postal_mail' when calling AssociationsApi.get_all"
|
214
|
+
end
|
215
|
+
# verify the required parameter 'to_object_type' is set
|
216
|
+
if @api_client.config.client_side_validation && to_object_type.nil?
|
217
|
+
fail ArgumentError, "Missing the required parameter 'to_object_type' when calling AssociationsApi.get_all"
|
218
|
+
end
|
219
|
+
# resource path
|
220
|
+
local_var_path = '/crm/v4/objects/postal_mail/{postalMail}/associations/{toObjectType}'.sub('{' + 'postalMail' + '}', CGI.escape(postal_mail.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s))
|
221
|
+
|
222
|
+
# query parameters
|
223
|
+
query_params = opts[:query_params] || {}
|
224
|
+
query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
|
225
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
226
|
+
|
227
|
+
# header parameters
|
228
|
+
header_params = opts[:header_params] || {}
|
229
|
+
# HTTP header 'Accept' (if needed)
|
230
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
|
231
|
+
|
232
|
+
# form parameters
|
233
|
+
form_params = opts[:form_params] || {}
|
234
|
+
|
235
|
+
# http body (model)
|
236
|
+
post_body = opts[:debug_body]
|
237
|
+
|
238
|
+
# return_type
|
239
|
+
return_type = opts[:debug_return_type] || 'CollectionResponseMultiAssociatedObjectWithLabelForwardPaging'
|
240
|
+
|
241
|
+
# auth_names
|
242
|
+
auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
|
243
|
+
|
244
|
+
new_options = opts.merge(
|
245
|
+
:operation => :"AssociationsApi.get_all",
|
246
|
+
:header_params => header_params,
|
247
|
+
:query_params => query_params,
|
248
|
+
:form_params => form_params,
|
249
|
+
:body => post_body,
|
250
|
+
:auth_names => auth_names,
|
251
|
+
:return_type => return_type
|
252
|
+
)
|
253
|
+
|
254
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
255
|
+
if @api_client.config.debugging
|
256
|
+
@api_client.config.logger.debug "API called: AssociationsApi#get_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
257
|
+
end
|
258
|
+
return data, status_code, headers
|
259
|
+
end
|
260
|
+
end
|
261
|
+
end
|
262
|
+
end
|
263
|
+
end
|
264
|
+
end
|