bt_test 3.0.3

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 (168) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +187 -0
  4. data/Rakefile +10 -0
  5. data/bt_test.gemspec +38 -0
  6. data/docs/CreateGoalRequest.md +18 -0
  7. data/docs/CreateProjectRequest.md +26 -0
  8. data/docs/CreateProjectsTagRequest.md +18 -0
  9. data/docs/CreateScaffoldingAbsolutelyAbstractCreativeConceptRequest.md +20 -0
  10. data/docs/CreateTeamRequest.md +20 -0
  11. data/docs/CreateWebhooksOutgoingEndpointRequest.md +22 -0
  12. data/docs/Goal.md +18 -0
  13. data/docs/GoalData.md +24 -0
  14. data/docs/GoalDataAttributes.md +24 -0
  15. data/docs/GoalDataRelationships.md +18 -0
  16. data/docs/Me.md +18 -0
  17. data/docs/MeData.md +24 -0
  18. data/docs/MeDataAttributes.md +38 -0
  19. data/docs/MeDataRelationships.md +20 -0
  20. data/docs/PlatformApi.md +2834 -0
  21. data/docs/Project.md +18 -0
  22. data/docs/ProjectData.md +24 -0
  23. data/docs/ProjectDataAttributes.md +24 -0
  24. data/docs/ProjectDataRelationships.md +26 -0
  25. data/docs/ProjectDataRelationshipsTags.md +18 -0
  26. data/docs/ProjectsTag.md +18 -0
  27. data/docs/ProjectsTagData.md +24 -0
  28. data/docs/ProjectsTagDataAttributes.md +22 -0
  29. data/docs/ProjectsTagDataRelationships.md +20 -0
  30. data/docs/ProjectsTagDataRelationshipsTeam.md +18 -0
  31. data/docs/ProjectsTagDataRelationshipsTeamData.md +20 -0
  32. data/docs/ScaffoldingAbsolutelyAbstractCreativeConcept.md +18 -0
  33. data/docs/ScaffoldingAbsolutelyAbstractCreativeConceptData.md +24 -0
  34. data/docs/ScaffoldingAbsolutelyAbstractCreativeConceptDataAttributes.md +28 -0
  35. data/docs/ScaffoldingAbsolutelyAbstractCreativeConceptDataRelationships.md +20 -0
  36. data/docs/ScaffoldingCompletelyConcreteTangibleThing.md +18 -0
  37. data/docs/ScaffoldingCompletelyConcreteTangibleThingData.md +24 -0
  38. data/docs/ScaffoldingCompletelyConcreteTangibleThingDataAttributes.md +46 -0
  39. data/docs/ScaffoldingCompletelyConcreteTangibleThingDataRelationships.md +18 -0
  40. data/docs/Team.md +18 -0
  41. data/docs/TeamData.md +24 -0
  42. data/docs/TeamDataAttributes.md +28 -0
  43. data/docs/TeamDataRelationships.md +18 -0
  44. data/docs/UpdateScaffoldingCompletelyConcreteTangibleThingRequest.md +46 -0
  45. data/docs/WebhooksOutgoingDelivery.md +18 -0
  46. data/docs/WebhooksOutgoingDeliveryAttempt.md +18 -0
  47. data/docs/WebhooksOutgoingDeliveryAttemptData.md +24 -0
  48. data/docs/WebhooksOutgoingDeliveryAttemptDataAttributes.md +34 -0
  49. data/docs/WebhooksOutgoingDeliveryAttemptDataRelationships.md +18 -0
  50. data/docs/WebhooksOutgoingDeliveryData.md +24 -0
  51. data/docs/WebhooksOutgoingDeliveryDataAttributes.md +30 -0
  52. data/docs/WebhooksOutgoingDeliveryDataRelationships.md +18 -0
  53. data/docs/WebhooksOutgoingEndpoint.md +18 -0
  54. data/docs/WebhooksOutgoingEndpointData.md +24 -0
  55. data/docs/WebhooksOutgoingEndpointDataAttributes.md +28 -0
  56. data/docs/WebhooksOutgoingEndpointDataRelationships.md +18 -0
  57. data/git_push.sh +57 -0
  58. data/lib/bt_test/api/platform_api.rb +2523 -0
  59. data/lib/bt_test/api_client.rb +392 -0
  60. data/lib/bt_test/api_error.rb +57 -0
  61. data/lib/bt_test/configuration.rb +280 -0
  62. data/lib/bt_test/models/create_goal_request.rb +220 -0
  63. data/lib/bt_test/models/create_project_request.rb +262 -0
  64. data/lib/bt_test/models/create_projects_tag_request.rb +220 -0
  65. data/lib/bt_test/models/create_scaffolding_absolutely_abstract_creative_concept_request.rb +230 -0
  66. data/lib/bt_test/models/create_team_request.rb +230 -0
  67. data/lib/bt_test/models/create_webhooks_outgoing_endpoint_request.rb +242 -0
  68. data/lib/bt_test/models/goal.rb +220 -0
  69. data/lib/bt_test/models/goal_data.rb +246 -0
  70. data/lib/bt_test/models/goal_data_attributes.rb +246 -0
  71. data/lib/bt_test/models/goal_data_relationships.rb +219 -0
  72. data/lib/bt_test/models/me.rb +220 -0
  73. data/lib/bt_test/models/me_data.rb +246 -0
  74. data/lib/bt_test/models/me_data_attributes.rb +309 -0
  75. data/lib/bt_test/models/me_data_relationships.rb +228 -0
  76. data/lib/bt_test/models/project.rb +220 -0
  77. data/lib/bt_test/models/project_data.rb +246 -0
  78. data/lib/bt_test/models/project_data_attributes.rb +246 -0
  79. data/lib/bt_test/models/project_data_relationships.rb +255 -0
  80. data/lib/bt_test/models/project_data_relationships_tags.rb +221 -0
  81. data/lib/bt_test/models/projects_tag.rb +220 -0
  82. data/lib/bt_test/models/projects_tag_data.rb +246 -0
  83. data/lib/bt_test/models/projects_tag_data_attributes.rb +237 -0
  84. data/lib/bt_test/models/projects_tag_data_relationships.rb +228 -0
  85. data/lib/bt_test/models/projects_tag_data_relationships_team.rb +219 -0
  86. data/lib/bt_test/models/projects_tag_data_relationships_team_data.rb +228 -0
  87. data/lib/bt_test/models/scaffolding_absolutely_abstract_creative_concept.rb +220 -0
  88. data/lib/bt_test/models/scaffolding_absolutely_abstract_creative_concept_data.rb +246 -0
  89. data/lib/bt_test/models/scaffolding_absolutely_abstract_creative_concept_data_attributes.rb +264 -0
  90. data/lib/bt_test/models/scaffolding_absolutely_abstract_creative_concept_data_relationships.rb +228 -0
  91. data/lib/bt_test/models/scaffolding_completely_concrete_tangible_thing.rb +220 -0
  92. data/lib/bt_test/models/scaffolding_completely_concrete_tangible_thing_data.rb +246 -0
  93. data/lib/bt_test/models/scaffolding_completely_concrete_tangible_thing_data_attributes.rb +345 -0
  94. data/lib/bt_test/models/scaffolding_completely_concrete_tangible_thing_data_relationships.rb +219 -0
  95. data/lib/bt_test/models/team.rb +220 -0
  96. data/lib/bt_test/models/team_data.rb +246 -0
  97. data/lib/bt_test/models/team_data_attributes.rb +264 -0
  98. data/lib/bt_test/models/team_data_relationships.rb +219 -0
  99. data/lib/bt_test/models/update_scaffolding_completely_concrete_tangible_thing_request.rb +366 -0
  100. data/lib/bt_test/models/webhooks_outgoing_delivery.rb +220 -0
  101. data/lib/bt_test/models/webhooks_outgoing_delivery_attempt.rb +220 -0
  102. data/lib/bt_test/models/webhooks_outgoing_delivery_attempt_data.rb +246 -0
  103. data/lib/bt_test/models/webhooks_outgoing_delivery_attempt_data_attributes.rb +291 -0
  104. data/lib/bt_test/models/webhooks_outgoing_delivery_attempt_data_relationships.rb +219 -0
  105. data/lib/bt_test/models/webhooks_outgoing_delivery_data.rb +246 -0
  106. data/lib/bt_test/models/webhooks_outgoing_delivery_data_attributes.rb +273 -0
  107. data/lib/bt_test/models/webhooks_outgoing_delivery_data_relationships.rb +219 -0
  108. data/lib/bt_test/models/webhooks_outgoing_endpoint.rb +220 -0
  109. data/lib/bt_test/models/webhooks_outgoing_endpoint_data.rb +246 -0
  110. data/lib/bt_test/models/webhooks_outgoing_endpoint_data_attributes.rb +264 -0
  111. data/lib/bt_test/models/webhooks_outgoing_endpoint_data_relationships.rb +219 -0
  112. data/lib/bt_test/version.rb +15 -0
  113. data/lib/bt_test.rb +90 -0
  114. data/spec/api/platform_api_spec.rb +493 -0
  115. data/spec/api_client_spec.rb +226 -0
  116. data/spec/configuration_spec.rb +42 -0
  117. data/spec/models/create_goal_request_spec.rb +34 -0
  118. data/spec/models/create_project_request_spec.rb +58 -0
  119. data/spec/models/create_projects_tag_request_spec.rb +34 -0
  120. data/spec/models/create_scaffolding_absolutely_abstract_creative_concept_request_spec.rb +40 -0
  121. data/spec/models/create_team_request_spec.rb +40 -0
  122. data/spec/models/create_webhooks_outgoing_endpoint_request_spec.rb +46 -0
  123. data/spec/models/goal_data_attributes_spec.rb +52 -0
  124. data/spec/models/goal_data_relationships_spec.rb +34 -0
  125. data/spec/models/goal_data_spec.rb +52 -0
  126. data/spec/models/goal_spec.rb +34 -0
  127. data/spec/models/me_data_attributes_spec.rb +94 -0
  128. data/spec/models/me_data_relationships_spec.rb +40 -0
  129. data/spec/models/me_data_spec.rb +52 -0
  130. data/spec/models/me_spec.rb +34 -0
  131. data/spec/models/project_data_attributes_spec.rb +52 -0
  132. data/spec/models/project_data_relationships_spec.rb +58 -0
  133. data/spec/models/project_data_relationships_tags_spec.rb +34 -0
  134. data/spec/models/project_data_spec.rb +52 -0
  135. data/spec/models/project_spec.rb +34 -0
  136. data/spec/models/projects_tag_data_attributes_spec.rb +46 -0
  137. data/spec/models/projects_tag_data_relationships_spec.rb +40 -0
  138. data/spec/models/projects_tag_data_relationships_team_data_spec.rb +40 -0
  139. data/spec/models/projects_tag_data_relationships_team_spec.rb +34 -0
  140. data/spec/models/projects_tag_data_spec.rb +52 -0
  141. data/spec/models/projects_tag_spec.rb +34 -0
  142. data/spec/models/scaffolding_absolutely_abstract_creative_concept_data_attributes_spec.rb +64 -0
  143. data/spec/models/scaffolding_absolutely_abstract_creative_concept_data_relationships_spec.rb +40 -0
  144. data/spec/models/scaffolding_absolutely_abstract_creative_concept_data_spec.rb +52 -0
  145. data/spec/models/scaffolding_absolutely_abstract_creative_concept_spec.rb +34 -0
  146. data/spec/models/scaffolding_completely_concrete_tangible_thing_data_attributes_spec.rb +118 -0
  147. data/spec/models/scaffolding_completely_concrete_tangible_thing_data_relationships_spec.rb +34 -0
  148. data/spec/models/scaffolding_completely_concrete_tangible_thing_data_spec.rb +52 -0
  149. data/spec/models/scaffolding_completely_concrete_tangible_thing_spec.rb +34 -0
  150. data/spec/models/team_data_attributes_spec.rb +64 -0
  151. data/spec/models/team_data_relationships_spec.rb +34 -0
  152. data/spec/models/team_data_spec.rb +52 -0
  153. data/spec/models/team_spec.rb +34 -0
  154. data/spec/models/update_scaffolding_completely_concrete_tangible_thing_request_spec.rb +118 -0
  155. data/spec/models/webhooks_outgoing_delivery_attempt_data_attributes_spec.rb +82 -0
  156. data/spec/models/webhooks_outgoing_delivery_attempt_data_relationships_spec.rb +34 -0
  157. data/spec/models/webhooks_outgoing_delivery_attempt_data_spec.rb +52 -0
  158. data/spec/models/webhooks_outgoing_delivery_attempt_spec.rb +34 -0
  159. data/spec/models/webhooks_outgoing_delivery_data_attributes_spec.rb +70 -0
  160. data/spec/models/webhooks_outgoing_delivery_data_relationships_spec.rb +34 -0
  161. data/spec/models/webhooks_outgoing_delivery_data_spec.rb +52 -0
  162. data/spec/models/webhooks_outgoing_delivery_spec.rb +34 -0
  163. data/spec/models/webhooks_outgoing_endpoint_data_attributes_spec.rb +64 -0
  164. data/spec/models/webhooks_outgoing_endpoint_data_relationships_spec.rb +34 -0
  165. data/spec/models/webhooks_outgoing_endpoint_data_spec.rb +52 -0
  166. data/spec/models/webhooks_outgoing_endpoint_spec.rb +34 -0
  167. data/spec/spec_helper.rb +111 -0
  168. metadata +303 -0
@@ -0,0 +1,2834 @@
1
+ # BtTest::PlatformApi
2
+
3
+ All URIs are relative to *https://btapi.eu.ngrok.io/api/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_goal**](PlatformApi.md#create_goal) | **POST** /projects/{project_id}/goals | |
8
+ | [**create_project**](PlatformApi.md#create_project) | **POST** /teams/{team_id}/projects | |
9
+ | [**create_projects_tag**](PlatformApi.md#create_projects_tag) | **POST** /teams/{team_id}/projects/tags | |
10
+ | [**create_scaffolding_absolutely_abstract_creative_concept**](PlatformApi.md#create_scaffolding_absolutely_abstract_creative_concept) | **POST** /teams/{team_id}/scaffolding/absolutely_abstract/creative_concepts | |
11
+ | [**create_scaffolding_completely_concrete_tangible_thing**](PlatformApi.md#create_scaffolding_completely_concrete_tangible_thing) | **POST** /scaffolding/absolutely_abstract/creative_concepts/{absolutely_abstract_creative_concept_id}/completely_concrete/tangible_things | |
12
+ | [**create_team**](PlatformApi.md#create_team) | **POST** /teams | |
13
+ | [**create_webhooks_outgoing_endpoint**](PlatformApi.md#create_webhooks_outgoing_endpoint) | **POST** /teams/{team_id}/webhooks/outgoing/endpoints | |
14
+ | [**delete_goal**](PlatformApi.md#delete_goal) | **DELETE** /goals/{id} | |
15
+ | [**delete_project**](PlatformApi.md#delete_project) | **DELETE** /projects/{id} | |
16
+ | [**delete_projects_tag**](PlatformApi.md#delete_projects_tag) | **DELETE** /projects/tags/{id} | |
17
+ | [**delete_scaffolding_absolutely_abstract_creative_concept**](PlatformApi.md#delete_scaffolding_absolutely_abstract_creative_concept) | **DELETE** /scaffolding/absolutely_abstract/creative_concepts/{id} | |
18
+ | [**delete_scaffolding_completely_concrete_tangible_thing**](PlatformApi.md#delete_scaffolding_completely_concrete_tangible_thing) | **DELETE** /scaffolding/completely_concrete/tangible_things/{id} | |
19
+ | [**delete_webhooks_outgoing_endpoint**](PlatformApi.md#delete_webhooks_outgoing_endpoint) | **DELETE** /webhooks/outgoing/endpoints/{id} | |
20
+ | [**get_goal**](PlatformApi.md#get_goal) | **GET** /goals/{id} | |
21
+ | [**get_me**](PlatformApi.md#get_me) | **GET** /me | |
22
+ | [**get_project**](PlatformApi.md#get_project) | **GET** /projects/{id} | |
23
+ | [**get_projects_tag**](PlatformApi.md#get_projects_tag) | **GET** /projects/tags/{id} | |
24
+ | [**get_scaffolding_absolutely_abstract_creative_concept**](PlatformApi.md#get_scaffolding_absolutely_abstract_creative_concept) | **GET** /scaffolding/absolutely_abstract/creative_concepts/{id} | |
25
+ | [**get_scaffolding_completely_concrete_tangible_thing**](PlatformApi.md#get_scaffolding_completely_concrete_tangible_thing) | **GET** /scaffolding/completely_concrete/tangible_things/{id} | |
26
+ | [**get_team**](PlatformApi.md#get_team) | **GET** /teams/{id} | |
27
+ | [**get_webhooks_outgoing_delivery**](PlatformApi.md#get_webhooks_outgoing_delivery) | **GET** /webhooks/outgoing/deliveries/{id} | |
28
+ | [**get_webhooks_outgoing_delivery_attempt**](PlatformApi.md#get_webhooks_outgoing_delivery_attempt) | **GET** /webhooks/outgoing/delivery_attempts/{id} | |
29
+ | [**get_webhooks_outgoing_endpoint**](PlatformApi.md#get_webhooks_outgoing_endpoint) | **GET** /webhooks/outgoing/endpoints/{id} | |
30
+ | [**list_goals**](PlatformApi.md#list_goals) | **GET** /projects/{project_id}/goals | |
31
+ | [**list_projects**](PlatformApi.md#list_projects) | **GET** /teams/{team_id}/projects | |
32
+ | [**list_projects_tags**](PlatformApi.md#list_projects_tags) | **GET** /teams/{team_id}/projects/tags | |
33
+ | [**list_scaffolding_absolutely_abstract_creative_concepts**](PlatformApi.md#list_scaffolding_absolutely_abstract_creative_concepts) | **GET** /teams/{team_id}/scaffolding/absolutely_abstract/creative_concepts | |
34
+ | [**list_scaffolding_completely_concrete_tangible_things**](PlatformApi.md#list_scaffolding_completely_concrete_tangible_things) | **GET** /scaffolding/absolutely_abstract/creative_concepts/{absolutely_abstract_creative_concept_id}/completely_concrete/tangible_things | |
35
+ | [**list_teams**](PlatformApi.md#list_teams) | **GET** /teams | |
36
+ | [**list_webhooks_outgoing_delivery_attempts**](PlatformApi.md#list_webhooks_outgoing_delivery_attempts) | **GET** /webhooks/outgoing/deliveries/{delivery_id}/delivery_attempts | |
37
+ | [**list_webhooks_outgoing_deliverys**](PlatformApi.md#list_webhooks_outgoing_deliverys) | **GET** /webhooks/outgoing/endpoints/{endpoint_id}/deliveries | |
38
+ | [**list_webhooks_outgoing_endpoints**](PlatformApi.md#list_webhooks_outgoing_endpoints) | **GET** /teams/{team_id}/webhooks/outgoing/endpoints | |
39
+ | [**update_goal**](PlatformApi.md#update_goal) | **PUT** /goals/{id} | |
40
+ | [**update_project**](PlatformApi.md#update_project) | **PUT** /projects/{id} | |
41
+ | [**update_projects_tag**](PlatformApi.md#update_projects_tag) | **PUT** /projects/tags/{id} | |
42
+ | [**update_scaffolding_absolutely_abstract_creative_concept**](PlatformApi.md#update_scaffolding_absolutely_abstract_creative_concept) | **PUT** /scaffolding/absolutely_abstract/creative_concepts/{id} | |
43
+ | [**update_scaffolding_completely_concrete_tangible_thing**](PlatformApi.md#update_scaffolding_completely_concrete_tangible_thing) | **PUT** /scaffolding/completely_concrete/tangible_things/{id} | |
44
+ | [**update_team**](PlatformApi.md#update_team) | **PUT** /teams/{id} | |
45
+ | [**update_webhooks_outgoing_endpoint**](PlatformApi.md#update_webhooks_outgoing_endpoint) | **PUT** /webhooks/outgoing/endpoints/{id} | |
46
+
47
+
48
+ ## create_goal
49
+
50
+ > <Goal> create_goal(project_id, opts)
51
+
52
+
53
+
54
+ Add a New Goal
55
+
56
+ ### Examples
57
+
58
+ ```ruby
59
+ require 'time'
60
+ require 'bt_test'
61
+ # setup authorization
62
+ BtTest.configure do |config|
63
+ # Configure Bearer authorization (Auth token): bearerAuth
64
+ config.access_token = 'YOUR_BEARER_TOKEN'
65
+ end
66
+
67
+ api_instance = BtTest::PlatformApi.new
68
+ project_id = 56 # Integer | Project ID
69
+ opts = {
70
+ create_goal_request: BtTest::CreateGoalRequest.new # CreateGoalRequest |
71
+ }
72
+
73
+ begin
74
+
75
+ result = api_instance.create_goal(project_id, opts)
76
+ p result
77
+ rescue BtTest::ApiError => e
78
+ puts "Error when calling PlatformApi->create_goal: #{e}"
79
+ end
80
+ ```
81
+
82
+ #### Using the create_goal_with_http_info variant
83
+
84
+ This returns an Array which contains the response data, status code and headers.
85
+
86
+ > <Array(<Goal>, Integer, Hash)> create_goal_with_http_info(project_id, opts)
87
+
88
+ ```ruby
89
+ begin
90
+
91
+ data, status_code, headers = api_instance.create_goal_with_http_info(project_id, opts)
92
+ p status_code # => 2xx
93
+ p headers # => { ... }
94
+ p data # => <Goal>
95
+ rescue BtTest::ApiError => e
96
+ puts "Error when calling PlatformApi->create_goal_with_http_info: #{e}"
97
+ end
98
+ ```
99
+
100
+ ### Parameters
101
+
102
+ | Name | Type | Description | Notes |
103
+ | ---- | ---- | ----------- | ----- |
104
+ | **project_id** | **Integer** | Project ID | |
105
+ | **create_goal_request** | [**CreateGoalRequest**](CreateGoalRequest.md) | | [optional] |
106
+
107
+ ### Return type
108
+
109
+ [**Goal**](Goal.md)
110
+
111
+ ### Authorization
112
+
113
+ [bearerAuth](../README.md#bearerAuth)
114
+
115
+ ### HTTP request headers
116
+
117
+ - **Content-Type**: application/json, multipart/form-data
118
+ - **Accept**: application/vnd.api+json
119
+
120
+
121
+ ## create_project
122
+
123
+ > <Project> create_project(team_id, opts)
124
+
125
+
126
+
127
+ Add a New Project
128
+
129
+ ### Examples
130
+
131
+ ```ruby
132
+ require 'time'
133
+ require 'bt_test'
134
+ # setup authorization
135
+ BtTest.configure do |config|
136
+ # Configure Bearer authorization (Auth token): bearerAuth
137
+ config.access_token = 'YOUR_BEARER_TOKEN'
138
+ end
139
+
140
+ api_instance = BtTest::PlatformApi.new
141
+ team_id = 56 # Integer | Team ID
142
+ opts = {
143
+ create_project_request: BtTest::CreateProjectRequest.new # CreateProjectRequest |
144
+ }
145
+
146
+ begin
147
+
148
+ result = api_instance.create_project(team_id, opts)
149
+ p result
150
+ rescue BtTest::ApiError => e
151
+ puts "Error when calling PlatformApi->create_project: #{e}"
152
+ end
153
+ ```
154
+
155
+ #### Using the create_project_with_http_info variant
156
+
157
+ This returns an Array which contains the response data, status code and headers.
158
+
159
+ > <Array(<Project>, Integer, Hash)> create_project_with_http_info(team_id, opts)
160
+
161
+ ```ruby
162
+ begin
163
+
164
+ data, status_code, headers = api_instance.create_project_with_http_info(team_id, opts)
165
+ p status_code # => 2xx
166
+ p headers # => { ... }
167
+ p data # => <Project>
168
+ rescue BtTest::ApiError => e
169
+ puts "Error when calling PlatformApi->create_project_with_http_info: #{e}"
170
+ end
171
+ ```
172
+
173
+ ### Parameters
174
+
175
+ | Name | Type | Description | Notes |
176
+ | ---- | ---- | ----------- | ----- |
177
+ | **team_id** | **Integer** | Team ID | |
178
+ | **create_project_request** | [**CreateProjectRequest**](CreateProjectRequest.md) | | [optional] |
179
+
180
+ ### Return type
181
+
182
+ [**Project**](Project.md)
183
+
184
+ ### Authorization
185
+
186
+ [bearerAuth](../README.md#bearerAuth)
187
+
188
+ ### HTTP request headers
189
+
190
+ - **Content-Type**: application/json, multipart/form-data
191
+ - **Accept**: application/vnd.api+json
192
+
193
+
194
+ ## create_projects_tag
195
+
196
+ > <ProjectsTag> create_projects_tag(team_id, opts)
197
+
198
+
199
+
200
+ Add a New Tag
201
+
202
+ ### Examples
203
+
204
+ ```ruby
205
+ require 'time'
206
+ require 'bt_test'
207
+ # setup authorization
208
+ BtTest.configure do |config|
209
+ # Configure Bearer authorization (Auth token): bearerAuth
210
+ config.access_token = 'YOUR_BEARER_TOKEN'
211
+ end
212
+
213
+ api_instance = BtTest::PlatformApi.new
214
+ team_id = 56 # Integer | Team ID
215
+ opts = {
216
+ create_projects_tag_request: BtTest::CreateProjectsTagRequest.new # CreateProjectsTagRequest |
217
+ }
218
+
219
+ begin
220
+
221
+ result = api_instance.create_projects_tag(team_id, opts)
222
+ p result
223
+ rescue BtTest::ApiError => e
224
+ puts "Error when calling PlatformApi->create_projects_tag: #{e}"
225
+ end
226
+ ```
227
+
228
+ #### Using the create_projects_tag_with_http_info variant
229
+
230
+ This returns an Array which contains the response data, status code and headers.
231
+
232
+ > <Array(<ProjectsTag>, Integer, Hash)> create_projects_tag_with_http_info(team_id, opts)
233
+
234
+ ```ruby
235
+ begin
236
+
237
+ data, status_code, headers = api_instance.create_projects_tag_with_http_info(team_id, opts)
238
+ p status_code # => 2xx
239
+ p headers # => { ... }
240
+ p data # => <ProjectsTag>
241
+ rescue BtTest::ApiError => e
242
+ puts "Error when calling PlatformApi->create_projects_tag_with_http_info: #{e}"
243
+ end
244
+ ```
245
+
246
+ ### Parameters
247
+
248
+ | Name | Type | Description | Notes |
249
+ | ---- | ---- | ----------- | ----- |
250
+ | **team_id** | **Integer** | Team ID | |
251
+ | **create_projects_tag_request** | [**CreateProjectsTagRequest**](CreateProjectsTagRequest.md) | | [optional] |
252
+
253
+ ### Return type
254
+
255
+ [**ProjectsTag**](ProjectsTag.md)
256
+
257
+ ### Authorization
258
+
259
+ [bearerAuth](../README.md#bearerAuth)
260
+
261
+ ### HTTP request headers
262
+
263
+ - **Content-Type**: application/json, multipart/form-data
264
+ - **Accept**: application/vnd.api+json
265
+
266
+
267
+ ## create_scaffolding_absolutely_abstract_creative_concept
268
+
269
+ > <ScaffoldingAbsolutelyAbstractCreativeConcept> create_scaffolding_absolutely_abstract_creative_concept(team_id, opts)
270
+
271
+
272
+
273
+ Add a New Creative Concept
274
+
275
+ ### Examples
276
+
277
+ ```ruby
278
+ require 'time'
279
+ require 'bt_test'
280
+ # setup authorization
281
+ BtTest.configure do |config|
282
+ # Configure Bearer authorization (Auth token): bearerAuth
283
+ config.access_token = 'YOUR_BEARER_TOKEN'
284
+ end
285
+
286
+ api_instance = BtTest::PlatformApi.new
287
+ team_id = 56 # Integer | Team ID
288
+ opts = {
289
+ create_scaffolding_absolutely_abstract_creative_concept_request: BtTest::CreateScaffoldingAbsolutelyAbstractCreativeConceptRequest.new # CreateScaffoldingAbsolutelyAbstractCreativeConceptRequest |
290
+ }
291
+
292
+ begin
293
+
294
+ result = api_instance.create_scaffolding_absolutely_abstract_creative_concept(team_id, opts)
295
+ p result
296
+ rescue BtTest::ApiError => e
297
+ puts "Error when calling PlatformApi->create_scaffolding_absolutely_abstract_creative_concept: #{e}"
298
+ end
299
+ ```
300
+
301
+ #### Using the create_scaffolding_absolutely_abstract_creative_concept_with_http_info variant
302
+
303
+ This returns an Array which contains the response data, status code and headers.
304
+
305
+ > <Array(<ScaffoldingAbsolutelyAbstractCreativeConcept>, Integer, Hash)> create_scaffolding_absolutely_abstract_creative_concept_with_http_info(team_id, opts)
306
+
307
+ ```ruby
308
+ begin
309
+
310
+ data, status_code, headers = api_instance.create_scaffolding_absolutely_abstract_creative_concept_with_http_info(team_id, opts)
311
+ p status_code # => 2xx
312
+ p headers # => { ... }
313
+ p data # => <ScaffoldingAbsolutelyAbstractCreativeConcept>
314
+ rescue BtTest::ApiError => e
315
+ puts "Error when calling PlatformApi->create_scaffolding_absolutely_abstract_creative_concept_with_http_info: #{e}"
316
+ end
317
+ ```
318
+
319
+ ### Parameters
320
+
321
+ | Name | Type | Description | Notes |
322
+ | ---- | ---- | ----------- | ----- |
323
+ | **team_id** | **Integer** | Team ID | |
324
+ | **create_scaffolding_absolutely_abstract_creative_concept_request** | [**CreateScaffoldingAbsolutelyAbstractCreativeConceptRequest**](CreateScaffoldingAbsolutelyAbstractCreativeConceptRequest.md) | | [optional] |
325
+
326
+ ### Return type
327
+
328
+ [**ScaffoldingAbsolutelyAbstractCreativeConcept**](ScaffoldingAbsolutelyAbstractCreativeConcept.md)
329
+
330
+ ### Authorization
331
+
332
+ [bearerAuth](../README.md#bearerAuth)
333
+
334
+ ### HTTP request headers
335
+
336
+ - **Content-Type**: application/json, multipart/form-data
337
+ - **Accept**: application/vnd.api+json
338
+
339
+
340
+ ## create_scaffolding_completely_concrete_tangible_thing
341
+
342
+ > <ScaffoldingCompletelyConcreteTangibleThing> create_scaffolding_completely_concrete_tangible_thing(absolutely_abstract_creative_concept_id, opts)
343
+
344
+
345
+
346
+ Add a New Tangible Thing
347
+
348
+ ### Examples
349
+
350
+ ```ruby
351
+ require 'time'
352
+ require 'bt_test'
353
+ # setup authorization
354
+ BtTest.configure do |config|
355
+ # Configure Bearer authorization (Auth token): bearerAuth
356
+ config.access_token = 'YOUR_BEARER_TOKEN'
357
+ end
358
+
359
+ api_instance = BtTest::PlatformApi.new
360
+ absolutely_abstract_creative_concept_id = 56 # Integer | Creative Concept ID
361
+ opts = {
362
+ update_scaffolding_completely_concrete_tangible_thing_request: BtTest::UpdateScaffoldingCompletelyConcreteTangibleThingRequest.new # UpdateScaffoldingCompletelyConcreteTangibleThingRequest |
363
+ }
364
+
365
+ begin
366
+
367
+ result = api_instance.create_scaffolding_completely_concrete_tangible_thing(absolutely_abstract_creative_concept_id, opts)
368
+ p result
369
+ rescue BtTest::ApiError => e
370
+ puts "Error when calling PlatformApi->create_scaffolding_completely_concrete_tangible_thing: #{e}"
371
+ end
372
+ ```
373
+
374
+ #### Using the create_scaffolding_completely_concrete_tangible_thing_with_http_info variant
375
+
376
+ This returns an Array which contains the response data, status code and headers.
377
+
378
+ > <Array(<ScaffoldingCompletelyConcreteTangibleThing>, Integer, Hash)> create_scaffolding_completely_concrete_tangible_thing_with_http_info(absolutely_abstract_creative_concept_id, opts)
379
+
380
+ ```ruby
381
+ begin
382
+
383
+ data, status_code, headers = api_instance.create_scaffolding_completely_concrete_tangible_thing_with_http_info(absolutely_abstract_creative_concept_id, opts)
384
+ p status_code # => 2xx
385
+ p headers # => { ... }
386
+ p data # => <ScaffoldingCompletelyConcreteTangibleThing>
387
+ rescue BtTest::ApiError => e
388
+ puts "Error when calling PlatformApi->create_scaffolding_completely_concrete_tangible_thing_with_http_info: #{e}"
389
+ end
390
+ ```
391
+
392
+ ### Parameters
393
+
394
+ | Name | Type | Description | Notes |
395
+ | ---- | ---- | ----------- | ----- |
396
+ | **absolutely_abstract_creative_concept_id** | **Integer** | Creative Concept ID | |
397
+ | **update_scaffolding_completely_concrete_tangible_thing_request** | [**UpdateScaffoldingCompletelyConcreteTangibleThingRequest**](UpdateScaffoldingCompletelyConcreteTangibleThingRequest.md) | | [optional] |
398
+
399
+ ### Return type
400
+
401
+ [**ScaffoldingCompletelyConcreteTangibleThing**](ScaffoldingCompletelyConcreteTangibleThing.md)
402
+
403
+ ### Authorization
404
+
405
+ [bearerAuth](../README.md#bearerAuth)
406
+
407
+ ### HTTP request headers
408
+
409
+ - **Content-Type**: application/json, multipart/form-data
410
+ - **Accept**: application/vnd.api+json
411
+
412
+
413
+ ## create_team
414
+
415
+ > <Team> create_team(opts)
416
+
417
+
418
+
419
+ Add a New Team
420
+
421
+ ### Examples
422
+
423
+ ```ruby
424
+ require 'time'
425
+ require 'bt_test'
426
+ # setup authorization
427
+ BtTest.configure do |config|
428
+ # Configure Bearer authorization (Auth token): bearerAuth
429
+ config.access_token = 'YOUR_BEARER_TOKEN'
430
+ end
431
+
432
+ api_instance = BtTest::PlatformApi.new
433
+ opts = {
434
+ create_team_request: BtTest::CreateTeamRequest.new # CreateTeamRequest |
435
+ }
436
+
437
+ begin
438
+
439
+ result = api_instance.create_team(opts)
440
+ p result
441
+ rescue BtTest::ApiError => e
442
+ puts "Error when calling PlatformApi->create_team: #{e}"
443
+ end
444
+ ```
445
+
446
+ #### Using the create_team_with_http_info variant
447
+
448
+ This returns an Array which contains the response data, status code and headers.
449
+
450
+ > <Array(<Team>, Integer, Hash)> create_team_with_http_info(opts)
451
+
452
+ ```ruby
453
+ begin
454
+
455
+ data, status_code, headers = api_instance.create_team_with_http_info(opts)
456
+ p status_code # => 2xx
457
+ p headers # => { ... }
458
+ p data # => <Team>
459
+ rescue BtTest::ApiError => e
460
+ puts "Error when calling PlatformApi->create_team_with_http_info: #{e}"
461
+ end
462
+ ```
463
+
464
+ ### Parameters
465
+
466
+ | Name | Type | Description | Notes |
467
+ | ---- | ---- | ----------- | ----- |
468
+ | **create_team_request** | [**CreateTeamRequest**](CreateTeamRequest.md) | | [optional] |
469
+
470
+ ### Return type
471
+
472
+ [**Team**](Team.md)
473
+
474
+ ### Authorization
475
+
476
+ [bearerAuth](../README.md#bearerAuth)
477
+
478
+ ### HTTP request headers
479
+
480
+ - **Content-Type**: application/json, multipart/form-data
481
+ - **Accept**: application/vnd.api+json
482
+
483
+
484
+ ## create_webhooks_outgoing_endpoint
485
+
486
+ > <WebhooksOutgoingEndpoint> create_webhooks_outgoing_endpoint(team_id, opts)
487
+
488
+
489
+
490
+ Add a New Endpoint
491
+
492
+ ### Examples
493
+
494
+ ```ruby
495
+ require 'time'
496
+ require 'bt_test'
497
+ # setup authorization
498
+ BtTest.configure do |config|
499
+ # Configure Bearer authorization (Auth token): bearerAuth
500
+ config.access_token = 'YOUR_BEARER_TOKEN'
501
+ end
502
+
503
+ api_instance = BtTest::PlatformApi.new
504
+ team_id = 56 # Integer | Team ID
505
+ opts = {
506
+ create_webhooks_outgoing_endpoint_request: BtTest::CreateWebhooksOutgoingEndpointRequest.new # CreateWebhooksOutgoingEndpointRequest |
507
+ }
508
+
509
+ begin
510
+
511
+ result = api_instance.create_webhooks_outgoing_endpoint(team_id, opts)
512
+ p result
513
+ rescue BtTest::ApiError => e
514
+ puts "Error when calling PlatformApi->create_webhooks_outgoing_endpoint: #{e}"
515
+ end
516
+ ```
517
+
518
+ #### Using the create_webhooks_outgoing_endpoint_with_http_info variant
519
+
520
+ This returns an Array which contains the response data, status code and headers.
521
+
522
+ > <Array(<WebhooksOutgoingEndpoint>, Integer, Hash)> create_webhooks_outgoing_endpoint_with_http_info(team_id, opts)
523
+
524
+ ```ruby
525
+ begin
526
+
527
+ data, status_code, headers = api_instance.create_webhooks_outgoing_endpoint_with_http_info(team_id, opts)
528
+ p status_code # => 2xx
529
+ p headers # => { ... }
530
+ p data # => <WebhooksOutgoingEndpoint>
531
+ rescue BtTest::ApiError => e
532
+ puts "Error when calling PlatformApi->create_webhooks_outgoing_endpoint_with_http_info: #{e}"
533
+ end
534
+ ```
535
+
536
+ ### Parameters
537
+
538
+ | Name | Type | Description | Notes |
539
+ | ---- | ---- | ----------- | ----- |
540
+ | **team_id** | **Integer** | Team ID | |
541
+ | **create_webhooks_outgoing_endpoint_request** | [**CreateWebhooksOutgoingEndpointRequest**](CreateWebhooksOutgoingEndpointRequest.md) | | [optional] |
542
+
543
+ ### Return type
544
+
545
+ [**WebhooksOutgoingEndpoint**](WebhooksOutgoingEndpoint.md)
546
+
547
+ ### Authorization
548
+
549
+ [bearerAuth](../README.md#bearerAuth)
550
+
551
+ ### HTTP request headers
552
+
553
+ - **Content-Type**: application/json, multipart/form-data
554
+ - **Accept**: application/vnd.api+json
555
+
556
+
557
+ ## delete_goal
558
+
559
+ > delete_goal(id)
560
+
561
+
562
+
563
+ Delete a Goal
564
+
565
+ ### Examples
566
+
567
+ ```ruby
568
+ require 'time'
569
+ require 'bt_test'
570
+ # setup authorization
571
+ BtTest.configure do |config|
572
+ # Configure Bearer authorization (Auth token): bearerAuth
573
+ config.access_token = 'YOUR_BEARER_TOKEN'
574
+ end
575
+
576
+ api_instance = BtTest::PlatformApi.new
577
+ id = 56 # Integer | Goal ID
578
+
579
+ begin
580
+
581
+ api_instance.delete_goal(id)
582
+ rescue BtTest::ApiError => e
583
+ puts "Error when calling PlatformApi->delete_goal: #{e}"
584
+ end
585
+ ```
586
+
587
+ #### Using the delete_goal_with_http_info variant
588
+
589
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
590
+
591
+ > <Array(nil, Integer, Hash)> delete_goal_with_http_info(id)
592
+
593
+ ```ruby
594
+ begin
595
+
596
+ data, status_code, headers = api_instance.delete_goal_with_http_info(id)
597
+ p status_code # => 2xx
598
+ p headers # => { ... }
599
+ p data # => nil
600
+ rescue BtTest::ApiError => e
601
+ puts "Error when calling PlatformApi->delete_goal_with_http_info: #{e}"
602
+ end
603
+ ```
604
+
605
+ ### Parameters
606
+
607
+ | Name | Type | Description | Notes |
608
+ | ---- | ---- | ----------- | ----- |
609
+ | **id** | **Integer** | Goal ID | |
610
+
611
+ ### Return type
612
+
613
+ nil (empty response body)
614
+
615
+ ### Authorization
616
+
617
+ [bearerAuth](../README.md#bearerAuth)
618
+
619
+ ### HTTP request headers
620
+
621
+ - **Content-Type**: Not defined
622
+ - **Accept**: Not defined
623
+
624
+
625
+ ## delete_project
626
+
627
+ > delete_project(id)
628
+
629
+
630
+
631
+ Delete a Project
632
+
633
+ ### Examples
634
+
635
+ ```ruby
636
+ require 'time'
637
+ require 'bt_test'
638
+ # setup authorization
639
+ BtTest.configure do |config|
640
+ # Configure Bearer authorization (Auth token): bearerAuth
641
+ config.access_token = 'YOUR_BEARER_TOKEN'
642
+ end
643
+
644
+ api_instance = BtTest::PlatformApi.new
645
+ id = 56 # Integer | Project ID
646
+
647
+ begin
648
+
649
+ api_instance.delete_project(id)
650
+ rescue BtTest::ApiError => e
651
+ puts "Error when calling PlatformApi->delete_project: #{e}"
652
+ end
653
+ ```
654
+
655
+ #### Using the delete_project_with_http_info variant
656
+
657
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
658
+
659
+ > <Array(nil, Integer, Hash)> delete_project_with_http_info(id)
660
+
661
+ ```ruby
662
+ begin
663
+
664
+ data, status_code, headers = api_instance.delete_project_with_http_info(id)
665
+ p status_code # => 2xx
666
+ p headers # => { ... }
667
+ p data # => nil
668
+ rescue BtTest::ApiError => e
669
+ puts "Error when calling PlatformApi->delete_project_with_http_info: #{e}"
670
+ end
671
+ ```
672
+
673
+ ### Parameters
674
+
675
+ | Name | Type | Description | Notes |
676
+ | ---- | ---- | ----------- | ----- |
677
+ | **id** | **Integer** | Project ID | |
678
+
679
+ ### Return type
680
+
681
+ nil (empty response body)
682
+
683
+ ### Authorization
684
+
685
+ [bearerAuth](../README.md#bearerAuth)
686
+
687
+ ### HTTP request headers
688
+
689
+ - **Content-Type**: Not defined
690
+ - **Accept**: Not defined
691
+
692
+
693
+ ## delete_projects_tag
694
+
695
+ > delete_projects_tag(id)
696
+
697
+
698
+
699
+ Delete a Tag
700
+
701
+ ### Examples
702
+
703
+ ```ruby
704
+ require 'time'
705
+ require 'bt_test'
706
+ # setup authorization
707
+ BtTest.configure do |config|
708
+ # Configure Bearer authorization (Auth token): bearerAuth
709
+ config.access_token = 'YOUR_BEARER_TOKEN'
710
+ end
711
+
712
+ api_instance = BtTest::PlatformApi.new
713
+ id = 56 # Integer | Tag ID
714
+
715
+ begin
716
+
717
+ api_instance.delete_projects_tag(id)
718
+ rescue BtTest::ApiError => e
719
+ puts "Error when calling PlatformApi->delete_projects_tag: #{e}"
720
+ end
721
+ ```
722
+
723
+ #### Using the delete_projects_tag_with_http_info variant
724
+
725
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
726
+
727
+ > <Array(nil, Integer, Hash)> delete_projects_tag_with_http_info(id)
728
+
729
+ ```ruby
730
+ begin
731
+
732
+ data, status_code, headers = api_instance.delete_projects_tag_with_http_info(id)
733
+ p status_code # => 2xx
734
+ p headers # => { ... }
735
+ p data # => nil
736
+ rescue BtTest::ApiError => e
737
+ puts "Error when calling PlatformApi->delete_projects_tag_with_http_info: #{e}"
738
+ end
739
+ ```
740
+
741
+ ### Parameters
742
+
743
+ | Name | Type | Description | Notes |
744
+ | ---- | ---- | ----------- | ----- |
745
+ | **id** | **Integer** | Tag ID | |
746
+
747
+ ### Return type
748
+
749
+ nil (empty response body)
750
+
751
+ ### Authorization
752
+
753
+ [bearerAuth](../README.md#bearerAuth)
754
+
755
+ ### HTTP request headers
756
+
757
+ - **Content-Type**: Not defined
758
+ - **Accept**: Not defined
759
+
760
+
761
+ ## delete_scaffolding_absolutely_abstract_creative_concept
762
+
763
+ > delete_scaffolding_absolutely_abstract_creative_concept(id)
764
+
765
+
766
+
767
+ Delete a Creative Concept
768
+
769
+ ### Examples
770
+
771
+ ```ruby
772
+ require 'time'
773
+ require 'bt_test'
774
+ # setup authorization
775
+ BtTest.configure do |config|
776
+ # Configure Bearer authorization (Auth token): bearerAuth
777
+ config.access_token = 'YOUR_BEARER_TOKEN'
778
+ end
779
+
780
+ api_instance = BtTest::PlatformApi.new
781
+ id = 56 # Integer | Creative Concept ID
782
+
783
+ begin
784
+
785
+ api_instance.delete_scaffolding_absolutely_abstract_creative_concept(id)
786
+ rescue BtTest::ApiError => e
787
+ puts "Error when calling PlatformApi->delete_scaffolding_absolutely_abstract_creative_concept: #{e}"
788
+ end
789
+ ```
790
+
791
+ #### Using the delete_scaffolding_absolutely_abstract_creative_concept_with_http_info variant
792
+
793
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
794
+
795
+ > <Array(nil, Integer, Hash)> delete_scaffolding_absolutely_abstract_creative_concept_with_http_info(id)
796
+
797
+ ```ruby
798
+ begin
799
+
800
+ data, status_code, headers = api_instance.delete_scaffolding_absolutely_abstract_creative_concept_with_http_info(id)
801
+ p status_code # => 2xx
802
+ p headers # => { ... }
803
+ p data # => nil
804
+ rescue BtTest::ApiError => e
805
+ puts "Error when calling PlatformApi->delete_scaffolding_absolutely_abstract_creative_concept_with_http_info: #{e}"
806
+ end
807
+ ```
808
+
809
+ ### Parameters
810
+
811
+ | Name | Type | Description | Notes |
812
+ | ---- | ---- | ----------- | ----- |
813
+ | **id** | **Integer** | Creative Concept ID | |
814
+
815
+ ### Return type
816
+
817
+ nil (empty response body)
818
+
819
+ ### Authorization
820
+
821
+ [bearerAuth](../README.md#bearerAuth)
822
+
823
+ ### HTTP request headers
824
+
825
+ - **Content-Type**: Not defined
826
+ - **Accept**: Not defined
827
+
828
+
829
+ ## delete_scaffolding_completely_concrete_tangible_thing
830
+
831
+ > delete_scaffolding_completely_concrete_tangible_thing(id)
832
+
833
+
834
+
835
+ Delete a Tangible Thing
836
+
837
+ ### Examples
838
+
839
+ ```ruby
840
+ require 'time'
841
+ require 'bt_test'
842
+ # setup authorization
843
+ BtTest.configure do |config|
844
+ # Configure Bearer authorization (Auth token): bearerAuth
845
+ config.access_token = 'YOUR_BEARER_TOKEN'
846
+ end
847
+
848
+ api_instance = BtTest::PlatformApi.new
849
+ id = 56 # Integer | Tangible Thing ID
850
+
851
+ begin
852
+
853
+ api_instance.delete_scaffolding_completely_concrete_tangible_thing(id)
854
+ rescue BtTest::ApiError => e
855
+ puts "Error when calling PlatformApi->delete_scaffolding_completely_concrete_tangible_thing: #{e}"
856
+ end
857
+ ```
858
+
859
+ #### Using the delete_scaffolding_completely_concrete_tangible_thing_with_http_info variant
860
+
861
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
862
+
863
+ > <Array(nil, Integer, Hash)> delete_scaffolding_completely_concrete_tangible_thing_with_http_info(id)
864
+
865
+ ```ruby
866
+ begin
867
+
868
+ data, status_code, headers = api_instance.delete_scaffolding_completely_concrete_tangible_thing_with_http_info(id)
869
+ p status_code # => 2xx
870
+ p headers # => { ... }
871
+ p data # => nil
872
+ rescue BtTest::ApiError => e
873
+ puts "Error when calling PlatformApi->delete_scaffolding_completely_concrete_tangible_thing_with_http_info: #{e}"
874
+ end
875
+ ```
876
+
877
+ ### Parameters
878
+
879
+ | Name | Type | Description | Notes |
880
+ | ---- | ---- | ----------- | ----- |
881
+ | **id** | **Integer** | Tangible Thing ID | |
882
+
883
+ ### Return type
884
+
885
+ nil (empty response body)
886
+
887
+ ### Authorization
888
+
889
+ [bearerAuth](../README.md#bearerAuth)
890
+
891
+ ### HTTP request headers
892
+
893
+ - **Content-Type**: Not defined
894
+ - **Accept**: Not defined
895
+
896
+
897
+ ## delete_webhooks_outgoing_endpoint
898
+
899
+ > delete_webhooks_outgoing_endpoint(id)
900
+
901
+
902
+
903
+ Delete a Endpoint
904
+
905
+ ### Examples
906
+
907
+ ```ruby
908
+ require 'time'
909
+ require 'bt_test'
910
+ # setup authorization
911
+ BtTest.configure do |config|
912
+ # Configure Bearer authorization (Auth token): bearerAuth
913
+ config.access_token = 'YOUR_BEARER_TOKEN'
914
+ end
915
+
916
+ api_instance = BtTest::PlatformApi.new
917
+ id = 56 # Integer | Endpoint ID
918
+
919
+ begin
920
+
921
+ api_instance.delete_webhooks_outgoing_endpoint(id)
922
+ rescue BtTest::ApiError => e
923
+ puts "Error when calling PlatformApi->delete_webhooks_outgoing_endpoint: #{e}"
924
+ end
925
+ ```
926
+
927
+ #### Using the delete_webhooks_outgoing_endpoint_with_http_info variant
928
+
929
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
930
+
931
+ > <Array(nil, Integer, Hash)> delete_webhooks_outgoing_endpoint_with_http_info(id)
932
+
933
+ ```ruby
934
+ begin
935
+
936
+ data, status_code, headers = api_instance.delete_webhooks_outgoing_endpoint_with_http_info(id)
937
+ p status_code # => 2xx
938
+ p headers # => { ... }
939
+ p data # => nil
940
+ rescue BtTest::ApiError => e
941
+ puts "Error when calling PlatformApi->delete_webhooks_outgoing_endpoint_with_http_info: #{e}"
942
+ end
943
+ ```
944
+
945
+ ### Parameters
946
+
947
+ | Name | Type | Description | Notes |
948
+ | ---- | ---- | ----------- | ----- |
949
+ | **id** | **Integer** | Endpoint ID | |
950
+
951
+ ### Return type
952
+
953
+ nil (empty response body)
954
+
955
+ ### Authorization
956
+
957
+ [bearerAuth](../README.md#bearerAuth)
958
+
959
+ ### HTTP request headers
960
+
961
+ - **Content-Type**: Not defined
962
+ - **Accept**: Not defined
963
+
964
+
965
+ ## get_goal
966
+
967
+ > <Goal> get_goal(id)
968
+
969
+
970
+
971
+ Retrieve a Goal
972
+
973
+ ### Examples
974
+
975
+ ```ruby
976
+ require 'time'
977
+ require 'bt_test'
978
+ # setup authorization
979
+ BtTest.configure do |config|
980
+ # Configure Bearer authorization (Auth token): bearerAuth
981
+ config.access_token = 'YOUR_BEARER_TOKEN'
982
+ end
983
+
984
+ api_instance = BtTest::PlatformApi.new
985
+ id = 56 # Integer | Goal ID
986
+
987
+ begin
988
+
989
+ result = api_instance.get_goal(id)
990
+ p result
991
+ rescue BtTest::ApiError => e
992
+ puts "Error when calling PlatformApi->get_goal: #{e}"
993
+ end
994
+ ```
995
+
996
+ #### Using the get_goal_with_http_info variant
997
+
998
+ This returns an Array which contains the response data, status code and headers.
999
+
1000
+ > <Array(<Goal>, Integer, Hash)> get_goal_with_http_info(id)
1001
+
1002
+ ```ruby
1003
+ begin
1004
+
1005
+ data, status_code, headers = api_instance.get_goal_with_http_info(id)
1006
+ p status_code # => 2xx
1007
+ p headers # => { ... }
1008
+ p data # => <Goal>
1009
+ rescue BtTest::ApiError => e
1010
+ puts "Error when calling PlatformApi->get_goal_with_http_info: #{e}"
1011
+ end
1012
+ ```
1013
+
1014
+ ### Parameters
1015
+
1016
+ | Name | Type | Description | Notes |
1017
+ | ---- | ---- | ----------- | ----- |
1018
+ | **id** | **Integer** | Goal ID | |
1019
+
1020
+ ### Return type
1021
+
1022
+ [**Goal**](Goal.md)
1023
+
1024
+ ### Authorization
1025
+
1026
+ [bearerAuth](../README.md#bearerAuth)
1027
+
1028
+ ### HTTP request headers
1029
+
1030
+ - **Content-Type**: Not defined
1031
+ - **Accept**: application/vnd.api+json
1032
+
1033
+
1034
+ ## get_me
1035
+
1036
+ > <Me> get_me
1037
+
1038
+
1039
+
1040
+ Retrieve info about the current user
1041
+
1042
+ ### Examples
1043
+
1044
+ ```ruby
1045
+ require 'time'
1046
+ require 'bt_test'
1047
+ # setup authorization
1048
+ BtTest.configure do |config|
1049
+ # Configure Bearer authorization (Auth token): bearerAuth
1050
+ config.access_token = 'YOUR_BEARER_TOKEN'
1051
+ end
1052
+
1053
+ api_instance = BtTest::PlatformApi.new
1054
+
1055
+ begin
1056
+
1057
+ result = api_instance.get_me
1058
+ p result
1059
+ rescue BtTest::ApiError => e
1060
+ puts "Error when calling PlatformApi->get_me: #{e}"
1061
+ end
1062
+ ```
1063
+
1064
+ #### Using the get_me_with_http_info variant
1065
+
1066
+ This returns an Array which contains the response data, status code and headers.
1067
+
1068
+ > <Array(<Me>, Integer, Hash)> get_me_with_http_info
1069
+
1070
+ ```ruby
1071
+ begin
1072
+
1073
+ data, status_code, headers = api_instance.get_me_with_http_info
1074
+ p status_code # => 2xx
1075
+ p headers # => { ... }
1076
+ p data # => <Me>
1077
+ rescue BtTest::ApiError => e
1078
+ puts "Error when calling PlatformApi->get_me_with_http_info: #{e}"
1079
+ end
1080
+ ```
1081
+
1082
+ ### Parameters
1083
+
1084
+ This endpoint does not need any parameter.
1085
+
1086
+ ### Return type
1087
+
1088
+ [**Me**](Me.md)
1089
+
1090
+ ### Authorization
1091
+
1092
+ [bearerAuth](../README.md#bearerAuth)
1093
+
1094
+ ### HTTP request headers
1095
+
1096
+ - **Content-Type**: Not defined
1097
+ - **Accept**: application/vnd.api+json
1098
+
1099
+
1100
+ ## get_project
1101
+
1102
+ > <Project> get_project(id)
1103
+
1104
+
1105
+
1106
+ Retrieve a Project
1107
+
1108
+ ### Examples
1109
+
1110
+ ```ruby
1111
+ require 'time'
1112
+ require 'bt_test'
1113
+ # setup authorization
1114
+ BtTest.configure do |config|
1115
+ # Configure Bearer authorization (Auth token): bearerAuth
1116
+ config.access_token = 'YOUR_BEARER_TOKEN'
1117
+ end
1118
+
1119
+ api_instance = BtTest::PlatformApi.new
1120
+ id = 56 # Integer | Project ID
1121
+
1122
+ begin
1123
+
1124
+ result = api_instance.get_project(id)
1125
+ p result
1126
+ rescue BtTest::ApiError => e
1127
+ puts "Error when calling PlatformApi->get_project: #{e}"
1128
+ end
1129
+ ```
1130
+
1131
+ #### Using the get_project_with_http_info variant
1132
+
1133
+ This returns an Array which contains the response data, status code and headers.
1134
+
1135
+ > <Array(<Project>, Integer, Hash)> get_project_with_http_info(id)
1136
+
1137
+ ```ruby
1138
+ begin
1139
+
1140
+ data, status_code, headers = api_instance.get_project_with_http_info(id)
1141
+ p status_code # => 2xx
1142
+ p headers # => { ... }
1143
+ p data # => <Project>
1144
+ rescue BtTest::ApiError => e
1145
+ puts "Error when calling PlatformApi->get_project_with_http_info: #{e}"
1146
+ end
1147
+ ```
1148
+
1149
+ ### Parameters
1150
+
1151
+ | Name | Type | Description | Notes |
1152
+ | ---- | ---- | ----------- | ----- |
1153
+ | **id** | **Integer** | Project ID | |
1154
+
1155
+ ### Return type
1156
+
1157
+ [**Project**](Project.md)
1158
+
1159
+ ### Authorization
1160
+
1161
+ [bearerAuth](../README.md#bearerAuth)
1162
+
1163
+ ### HTTP request headers
1164
+
1165
+ - **Content-Type**: Not defined
1166
+ - **Accept**: application/vnd.api+json
1167
+
1168
+
1169
+ ## get_projects_tag
1170
+
1171
+ > <ProjectsTag> get_projects_tag(id)
1172
+
1173
+
1174
+
1175
+ Retrieve a Tag
1176
+
1177
+ ### Examples
1178
+
1179
+ ```ruby
1180
+ require 'time'
1181
+ require 'bt_test'
1182
+ # setup authorization
1183
+ BtTest.configure do |config|
1184
+ # Configure Bearer authorization (Auth token): bearerAuth
1185
+ config.access_token = 'YOUR_BEARER_TOKEN'
1186
+ end
1187
+
1188
+ api_instance = BtTest::PlatformApi.new
1189
+ id = 56 # Integer | Tag ID
1190
+
1191
+ begin
1192
+
1193
+ result = api_instance.get_projects_tag(id)
1194
+ p result
1195
+ rescue BtTest::ApiError => e
1196
+ puts "Error when calling PlatformApi->get_projects_tag: #{e}"
1197
+ end
1198
+ ```
1199
+
1200
+ #### Using the get_projects_tag_with_http_info variant
1201
+
1202
+ This returns an Array which contains the response data, status code and headers.
1203
+
1204
+ > <Array(<ProjectsTag>, Integer, Hash)> get_projects_tag_with_http_info(id)
1205
+
1206
+ ```ruby
1207
+ begin
1208
+
1209
+ data, status_code, headers = api_instance.get_projects_tag_with_http_info(id)
1210
+ p status_code # => 2xx
1211
+ p headers # => { ... }
1212
+ p data # => <ProjectsTag>
1213
+ rescue BtTest::ApiError => e
1214
+ puts "Error when calling PlatformApi->get_projects_tag_with_http_info: #{e}"
1215
+ end
1216
+ ```
1217
+
1218
+ ### Parameters
1219
+
1220
+ | Name | Type | Description | Notes |
1221
+ | ---- | ---- | ----------- | ----- |
1222
+ | **id** | **Integer** | Tag ID | |
1223
+
1224
+ ### Return type
1225
+
1226
+ [**ProjectsTag**](ProjectsTag.md)
1227
+
1228
+ ### Authorization
1229
+
1230
+ [bearerAuth](../README.md#bearerAuth)
1231
+
1232
+ ### HTTP request headers
1233
+
1234
+ - **Content-Type**: Not defined
1235
+ - **Accept**: application/vnd.api+json
1236
+
1237
+
1238
+ ## get_scaffolding_absolutely_abstract_creative_concept
1239
+
1240
+ > <ScaffoldingAbsolutelyAbstractCreativeConcept> get_scaffolding_absolutely_abstract_creative_concept(id)
1241
+
1242
+
1243
+
1244
+ Retrieve a Creative Concept
1245
+
1246
+ ### Examples
1247
+
1248
+ ```ruby
1249
+ require 'time'
1250
+ require 'bt_test'
1251
+ # setup authorization
1252
+ BtTest.configure do |config|
1253
+ # Configure Bearer authorization (Auth token): bearerAuth
1254
+ config.access_token = 'YOUR_BEARER_TOKEN'
1255
+ end
1256
+
1257
+ api_instance = BtTest::PlatformApi.new
1258
+ id = 56 # Integer | Creative Concept ID
1259
+
1260
+ begin
1261
+
1262
+ result = api_instance.get_scaffolding_absolutely_abstract_creative_concept(id)
1263
+ p result
1264
+ rescue BtTest::ApiError => e
1265
+ puts "Error when calling PlatformApi->get_scaffolding_absolutely_abstract_creative_concept: #{e}"
1266
+ end
1267
+ ```
1268
+
1269
+ #### Using the get_scaffolding_absolutely_abstract_creative_concept_with_http_info variant
1270
+
1271
+ This returns an Array which contains the response data, status code and headers.
1272
+
1273
+ > <Array(<ScaffoldingAbsolutelyAbstractCreativeConcept>, Integer, Hash)> get_scaffolding_absolutely_abstract_creative_concept_with_http_info(id)
1274
+
1275
+ ```ruby
1276
+ begin
1277
+
1278
+ data, status_code, headers = api_instance.get_scaffolding_absolutely_abstract_creative_concept_with_http_info(id)
1279
+ p status_code # => 2xx
1280
+ p headers # => { ... }
1281
+ p data # => <ScaffoldingAbsolutelyAbstractCreativeConcept>
1282
+ rescue BtTest::ApiError => e
1283
+ puts "Error when calling PlatformApi->get_scaffolding_absolutely_abstract_creative_concept_with_http_info: #{e}"
1284
+ end
1285
+ ```
1286
+
1287
+ ### Parameters
1288
+
1289
+ | Name | Type | Description | Notes |
1290
+ | ---- | ---- | ----------- | ----- |
1291
+ | **id** | **Integer** | Creative Concept ID | |
1292
+
1293
+ ### Return type
1294
+
1295
+ [**ScaffoldingAbsolutelyAbstractCreativeConcept**](ScaffoldingAbsolutelyAbstractCreativeConcept.md)
1296
+
1297
+ ### Authorization
1298
+
1299
+ [bearerAuth](../README.md#bearerAuth)
1300
+
1301
+ ### HTTP request headers
1302
+
1303
+ - **Content-Type**: Not defined
1304
+ - **Accept**: application/vnd.api+json
1305
+
1306
+
1307
+ ## get_scaffolding_completely_concrete_tangible_thing
1308
+
1309
+ > <ScaffoldingCompletelyConcreteTangibleThing> get_scaffolding_completely_concrete_tangible_thing(id)
1310
+
1311
+
1312
+
1313
+ Retrieve a Tangible Thing
1314
+
1315
+ ### Examples
1316
+
1317
+ ```ruby
1318
+ require 'time'
1319
+ require 'bt_test'
1320
+ # setup authorization
1321
+ BtTest.configure do |config|
1322
+ # Configure Bearer authorization (Auth token): bearerAuth
1323
+ config.access_token = 'YOUR_BEARER_TOKEN'
1324
+ end
1325
+
1326
+ api_instance = BtTest::PlatformApi.new
1327
+ id = 56 # Integer | Tangible Thing ID
1328
+
1329
+ begin
1330
+
1331
+ result = api_instance.get_scaffolding_completely_concrete_tangible_thing(id)
1332
+ p result
1333
+ rescue BtTest::ApiError => e
1334
+ puts "Error when calling PlatformApi->get_scaffolding_completely_concrete_tangible_thing: #{e}"
1335
+ end
1336
+ ```
1337
+
1338
+ #### Using the get_scaffolding_completely_concrete_tangible_thing_with_http_info variant
1339
+
1340
+ This returns an Array which contains the response data, status code and headers.
1341
+
1342
+ > <Array(<ScaffoldingCompletelyConcreteTangibleThing>, Integer, Hash)> get_scaffolding_completely_concrete_tangible_thing_with_http_info(id)
1343
+
1344
+ ```ruby
1345
+ begin
1346
+
1347
+ data, status_code, headers = api_instance.get_scaffolding_completely_concrete_tangible_thing_with_http_info(id)
1348
+ p status_code # => 2xx
1349
+ p headers # => { ... }
1350
+ p data # => <ScaffoldingCompletelyConcreteTangibleThing>
1351
+ rescue BtTest::ApiError => e
1352
+ puts "Error when calling PlatformApi->get_scaffolding_completely_concrete_tangible_thing_with_http_info: #{e}"
1353
+ end
1354
+ ```
1355
+
1356
+ ### Parameters
1357
+
1358
+ | Name | Type | Description | Notes |
1359
+ | ---- | ---- | ----------- | ----- |
1360
+ | **id** | **Integer** | Tangible Thing ID | |
1361
+
1362
+ ### Return type
1363
+
1364
+ [**ScaffoldingCompletelyConcreteTangibleThing**](ScaffoldingCompletelyConcreteTangibleThing.md)
1365
+
1366
+ ### Authorization
1367
+
1368
+ [bearerAuth](../README.md#bearerAuth)
1369
+
1370
+ ### HTTP request headers
1371
+
1372
+ - **Content-Type**: Not defined
1373
+ - **Accept**: application/vnd.api+json
1374
+
1375
+
1376
+ ## get_team
1377
+
1378
+ > <Team> get_team(id)
1379
+
1380
+
1381
+
1382
+ Retrieve a Team
1383
+
1384
+ ### Examples
1385
+
1386
+ ```ruby
1387
+ require 'time'
1388
+ require 'bt_test'
1389
+ # setup authorization
1390
+ BtTest.configure do |config|
1391
+ # Configure Bearer authorization (Auth token): bearerAuth
1392
+ config.access_token = 'YOUR_BEARER_TOKEN'
1393
+ end
1394
+
1395
+ api_instance = BtTest::PlatformApi.new
1396
+ id = 56 # Integer | Team ID
1397
+
1398
+ begin
1399
+
1400
+ result = api_instance.get_team(id)
1401
+ p result
1402
+ rescue BtTest::ApiError => e
1403
+ puts "Error when calling PlatformApi->get_team: #{e}"
1404
+ end
1405
+ ```
1406
+
1407
+ #### Using the get_team_with_http_info variant
1408
+
1409
+ This returns an Array which contains the response data, status code and headers.
1410
+
1411
+ > <Array(<Team>, Integer, Hash)> get_team_with_http_info(id)
1412
+
1413
+ ```ruby
1414
+ begin
1415
+
1416
+ data, status_code, headers = api_instance.get_team_with_http_info(id)
1417
+ p status_code # => 2xx
1418
+ p headers # => { ... }
1419
+ p data # => <Team>
1420
+ rescue BtTest::ApiError => e
1421
+ puts "Error when calling PlatformApi->get_team_with_http_info: #{e}"
1422
+ end
1423
+ ```
1424
+
1425
+ ### Parameters
1426
+
1427
+ | Name | Type | Description | Notes |
1428
+ | ---- | ---- | ----------- | ----- |
1429
+ | **id** | **Integer** | Team ID | |
1430
+
1431
+ ### Return type
1432
+
1433
+ [**Team**](Team.md)
1434
+
1435
+ ### Authorization
1436
+
1437
+ [bearerAuth](../README.md#bearerAuth)
1438
+
1439
+ ### HTTP request headers
1440
+
1441
+ - **Content-Type**: Not defined
1442
+ - **Accept**: application/vnd.api+json
1443
+
1444
+
1445
+ ## get_webhooks_outgoing_delivery
1446
+
1447
+ > <WebhooksOutgoingDelivery> get_webhooks_outgoing_delivery(id)
1448
+
1449
+
1450
+
1451
+ Retrieve a Delivery
1452
+
1453
+ ### Examples
1454
+
1455
+ ```ruby
1456
+ require 'time'
1457
+ require 'bt_test'
1458
+ # setup authorization
1459
+ BtTest.configure do |config|
1460
+ # Configure Bearer authorization (Auth token): bearerAuth
1461
+ config.access_token = 'YOUR_BEARER_TOKEN'
1462
+ end
1463
+
1464
+ api_instance = BtTest::PlatformApi.new
1465
+ id = 56 # Integer | Delivery ID
1466
+
1467
+ begin
1468
+
1469
+ result = api_instance.get_webhooks_outgoing_delivery(id)
1470
+ p result
1471
+ rescue BtTest::ApiError => e
1472
+ puts "Error when calling PlatformApi->get_webhooks_outgoing_delivery: #{e}"
1473
+ end
1474
+ ```
1475
+
1476
+ #### Using the get_webhooks_outgoing_delivery_with_http_info variant
1477
+
1478
+ This returns an Array which contains the response data, status code and headers.
1479
+
1480
+ > <Array(<WebhooksOutgoingDelivery>, Integer, Hash)> get_webhooks_outgoing_delivery_with_http_info(id)
1481
+
1482
+ ```ruby
1483
+ begin
1484
+
1485
+ data, status_code, headers = api_instance.get_webhooks_outgoing_delivery_with_http_info(id)
1486
+ p status_code # => 2xx
1487
+ p headers # => { ... }
1488
+ p data # => <WebhooksOutgoingDelivery>
1489
+ rescue BtTest::ApiError => e
1490
+ puts "Error when calling PlatformApi->get_webhooks_outgoing_delivery_with_http_info: #{e}"
1491
+ end
1492
+ ```
1493
+
1494
+ ### Parameters
1495
+
1496
+ | Name | Type | Description | Notes |
1497
+ | ---- | ---- | ----------- | ----- |
1498
+ | **id** | **Integer** | Delivery ID | |
1499
+
1500
+ ### Return type
1501
+
1502
+ [**WebhooksOutgoingDelivery**](WebhooksOutgoingDelivery.md)
1503
+
1504
+ ### Authorization
1505
+
1506
+ [bearerAuth](../README.md#bearerAuth)
1507
+
1508
+ ### HTTP request headers
1509
+
1510
+ - **Content-Type**: Not defined
1511
+ - **Accept**: application/vnd.api+json
1512
+
1513
+
1514
+ ## get_webhooks_outgoing_delivery_attempt
1515
+
1516
+ > <WebhooksOutgoingDeliveryAttempt> get_webhooks_outgoing_delivery_attempt(id)
1517
+
1518
+
1519
+
1520
+ Retrieve a Delivery Attempt
1521
+
1522
+ ### Examples
1523
+
1524
+ ```ruby
1525
+ require 'time'
1526
+ require 'bt_test'
1527
+ # setup authorization
1528
+ BtTest.configure do |config|
1529
+ # Configure Bearer authorization (Auth token): bearerAuth
1530
+ config.access_token = 'YOUR_BEARER_TOKEN'
1531
+ end
1532
+
1533
+ api_instance = BtTest::PlatformApi.new
1534
+ id = 56 # Integer | Delivery Attempt ID
1535
+
1536
+ begin
1537
+
1538
+ result = api_instance.get_webhooks_outgoing_delivery_attempt(id)
1539
+ p result
1540
+ rescue BtTest::ApiError => e
1541
+ puts "Error when calling PlatformApi->get_webhooks_outgoing_delivery_attempt: #{e}"
1542
+ end
1543
+ ```
1544
+
1545
+ #### Using the get_webhooks_outgoing_delivery_attempt_with_http_info variant
1546
+
1547
+ This returns an Array which contains the response data, status code and headers.
1548
+
1549
+ > <Array(<WebhooksOutgoingDeliveryAttempt>, Integer, Hash)> get_webhooks_outgoing_delivery_attempt_with_http_info(id)
1550
+
1551
+ ```ruby
1552
+ begin
1553
+
1554
+ data, status_code, headers = api_instance.get_webhooks_outgoing_delivery_attempt_with_http_info(id)
1555
+ p status_code # => 2xx
1556
+ p headers # => { ... }
1557
+ p data # => <WebhooksOutgoingDeliveryAttempt>
1558
+ rescue BtTest::ApiError => e
1559
+ puts "Error when calling PlatformApi->get_webhooks_outgoing_delivery_attempt_with_http_info: #{e}"
1560
+ end
1561
+ ```
1562
+
1563
+ ### Parameters
1564
+
1565
+ | Name | Type | Description | Notes |
1566
+ | ---- | ---- | ----------- | ----- |
1567
+ | **id** | **Integer** | Delivery Attempt ID | |
1568
+
1569
+ ### Return type
1570
+
1571
+ [**WebhooksOutgoingDeliveryAttempt**](WebhooksOutgoingDeliveryAttempt.md)
1572
+
1573
+ ### Authorization
1574
+
1575
+ [bearerAuth](../README.md#bearerAuth)
1576
+
1577
+ ### HTTP request headers
1578
+
1579
+ - **Content-Type**: Not defined
1580
+ - **Accept**: application/vnd.api+json
1581
+
1582
+
1583
+ ## get_webhooks_outgoing_endpoint
1584
+
1585
+ > <WebhooksOutgoingEndpoint> get_webhooks_outgoing_endpoint(id)
1586
+
1587
+
1588
+
1589
+ Retrieve a Endpoint
1590
+
1591
+ ### Examples
1592
+
1593
+ ```ruby
1594
+ require 'time'
1595
+ require 'bt_test'
1596
+ # setup authorization
1597
+ BtTest.configure do |config|
1598
+ # Configure Bearer authorization (Auth token): bearerAuth
1599
+ config.access_token = 'YOUR_BEARER_TOKEN'
1600
+ end
1601
+
1602
+ api_instance = BtTest::PlatformApi.new
1603
+ id = 56 # Integer | Endpoint ID
1604
+
1605
+ begin
1606
+
1607
+ result = api_instance.get_webhooks_outgoing_endpoint(id)
1608
+ p result
1609
+ rescue BtTest::ApiError => e
1610
+ puts "Error when calling PlatformApi->get_webhooks_outgoing_endpoint: #{e}"
1611
+ end
1612
+ ```
1613
+
1614
+ #### Using the get_webhooks_outgoing_endpoint_with_http_info variant
1615
+
1616
+ This returns an Array which contains the response data, status code and headers.
1617
+
1618
+ > <Array(<WebhooksOutgoingEndpoint>, Integer, Hash)> get_webhooks_outgoing_endpoint_with_http_info(id)
1619
+
1620
+ ```ruby
1621
+ begin
1622
+
1623
+ data, status_code, headers = api_instance.get_webhooks_outgoing_endpoint_with_http_info(id)
1624
+ p status_code # => 2xx
1625
+ p headers # => { ... }
1626
+ p data # => <WebhooksOutgoingEndpoint>
1627
+ rescue BtTest::ApiError => e
1628
+ puts "Error when calling PlatformApi->get_webhooks_outgoing_endpoint_with_http_info: #{e}"
1629
+ end
1630
+ ```
1631
+
1632
+ ### Parameters
1633
+
1634
+ | Name | Type | Description | Notes |
1635
+ | ---- | ---- | ----------- | ----- |
1636
+ | **id** | **Integer** | Endpoint ID | |
1637
+
1638
+ ### Return type
1639
+
1640
+ [**WebhooksOutgoingEndpoint**](WebhooksOutgoingEndpoint.md)
1641
+
1642
+ ### Authorization
1643
+
1644
+ [bearerAuth](../README.md#bearerAuth)
1645
+
1646
+ ### HTTP request headers
1647
+
1648
+ - **Content-Type**: Not defined
1649
+ - **Accept**: application/vnd.api+json
1650
+
1651
+
1652
+ ## list_goals
1653
+
1654
+ > <Array<Goal>> list_goals(project_id, opts)
1655
+
1656
+
1657
+
1658
+ List Goals
1659
+
1660
+ ### Examples
1661
+
1662
+ ```ruby
1663
+ require 'time'
1664
+ require 'bt_test'
1665
+ # setup authorization
1666
+ BtTest.configure do |config|
1667
+ # Configure Bearer authorization (Auth token): bearerAuth
1668
+ config.access_token = 'YOUR_BEARER_TOKEN'
1669
+ end
1670
+
1671
+ api_instance = BtTest::PlatformApi.new
1672
+ project_id = 56 # Integer | Project ID
1673
+ opts = {
1674
+ page: 56, # Integer | Page of results to fetch.
1675
+ per_page: 56 # Integer | Number of results to return per page.
1676
+ }
1677
+
1678
+ begin
1679
+
1680
+ result = api_instance.list_goals(project_id, opts)
1681
+ p result
1682
+ rescue BtTest::ApiError => e
1683
+ puts "Error when calling PlatformApi->list_goals: #{e}"
1684
+ end
1685
+ ```
1686
+
1687
+ #### Using the list_goals_with_http_info variant
1688
+
1689
+ This returns an Array which contains the response data, status code and headers.
1690
+
1691
+ > <Array(<Array<Goal>>, Integer, Hash)> list_goals_with_http_info(project_id, opts)
1692
+
1693
+ ```ruby
1694
+ begin
1695
+
1696
+ data, status_code, headers = api_instance.list_goals_with_http_info(project_id, opts)
1697
+ p status_code # => 2xx
1698
+ p headers # => { ... }
1699
+ p data # => <Array<Goal>>
1700
+ rescue BtTest::ApiError => e
1701
+ puts "Error when calling PlatformApi->list_goals_with_http_info: #{e}"
1702
+ end
1703
+ ```
1704
+
1705
+ ### Parameters
1706
+
1707
+ | Name | Type | Description | Notes |
1708
+ | ---- | ---- | ----------- | ----- |
1709
+ | **project_id** | **Integer** | Project ID | |
1710
+ | **page** | **Integer** | Page of results to fetch. | [optional][default to 1] |
1711
+ | **per_page** | **Integer** | Number of results to return per page. | [optional][default to 100] |
1712
+
1713
+ ### Return type
1714
+
1715
+ [**Array&lt;Goal&gt;**](Goal.md)
1716
+
1717
+ ### Authorization
1718
+
1719
+ [bearerAuth](../README.md#bearerAuth)
1720
+
1721
+ ### HTTP request headers
1722
+
1723
+ - **Content-Type**: Not defined
1724
+ - **Accept**: application/vnd.api+json
1725
+
1726
+
1727
+ ## list_projects
1728
+
1729
+ > <Array<Project>> list_projects(team_id, opts)
1730
+
1731
+
1732
+
1733
+ List Projects
1734
+
1735
+ ### Examples
1736
+
1737
+ ```ruby
1738
+ require 'time'
1739
+ require 'bt_test'
1740
+ # setup authorization
1741
+ BtTest.configure do |config|
1742
+ # Configure Bearer authorization (Auth token): bearerAuth
1743
+ config.access_token = 'YOUR_BEARER_TOKEN'
1744
+ end
1745
+
1746
+ api_instance = BtTest::PlatformApi.new
1747
+ team_id = 56 # Integer | Team ID
1748
+ opts = {
1749
+ page: 56, # Integer | Page of results to fetch.
1750
+ per_page: 56 # Integer | Number of results to return per page.
1751
+ }
1752
+
1753
+ begin
1754
+
1755
+ result = api_instance.list_projects(team_id, opts)
1756
+ p result
1757
+ rescue BtTest::ApiError => e
1758
+ puts "Error when calling PlatformApi->list_projects: #{e}"
1759
+ end
1760
+ ```
1761
+
1762
+ #### Using the list_projects_with_http_info variant
1763
+
1764
+ This returns an Array which contains the response data, status code and headers.
1765
+
1766
+ > <Array(<Array<Project>>, Integer, Hash)> list_projects_with_http_info(team_id, opts)
1767
+
1768
+ ```ruby
1769
+ begin
1770
+
1771
+ data, status_code, headers = api_instance.list_projects_with_http_info(team_id, opts)
1772
+ p status_code # => 2xx
1773
+ p headers # => { ... }
1774
+ p data # => <Array<Project>>
1775
+ rescue BtTest::ApiError => e
1776
+ puts "Error when calling PlatformApi->list_projects_with_http_info: #{e}"
1777
+ end
1778
+ ```
1779
+
1780
+ ### Parameters
1781
+
1782
+ | Name | Type | Description | Notes |
1783
+ | ---- | ---- | ----------- | ----- |
1784
+ | **team_id** | **Integer** | Team ID | |
1785
+ | **page** | **Integer** | Page of results to fetch. | [optional][default to 1] |
1786
+ | **per_page** | **Integer** | Number of results to return per page. | [optional][default to 100] |
1787
+
1788
+ ### Return type
1789
+
1790
+ [**Array&lt;Project&gt;**](Project.md)
1791
+
1792
+ ### Authorization
1793
+
1794
+ [bearerAuth](../README.md#bearerAuth)
1795
+
1796
+ ### HTTP request headers
1797
+
1798
+ - **Content-Type**: Not defined
1799
+ - **Accept**: application/vnd.api+json
1800
+
1801
+
1802
+ ## list_projects_tags
1803
+
1804
+ > <Array<ProjectsTag>> list_projects_tags(team_id, opts)
1805
+
1806
+
1807
+
1808
+ List Tags
1809
+
1810
+ ### Examples
1811
+
1812
+ ```ruby
1813
+ require 'time'
1814
+ require 'bt_test'
1815
+ # setup authorization
1816
+ BtTest.configure do |config|
1817
+ # Configure Bearer authorization (Auth token): bearerAuth
1818
+ config.access_token = 'YOUR_BEARER_TOKEN'
1819
+ end
1820
+
1821
+ api_instance = BtTest::PlatformApi.new
1822
+ team_id = 56 # Integer | Team ID
1823
+ opts = {
1824
+ page: 56, # Integer | Page of results to fetch.
1825
+ per_page: 56 # Integer | Number of results to return per page.
1826
+ }
1827
+
1828
+ begin
1829
+
1830
+ result = api_instance.list_projects_tags(team_id, opts)
1831
+ p result
1832
+ rescue BtTest::ApiError => e
1833
+ puts "Error when calling PlatformApi->list_projects_tags: #{e}"
1834
+ end
1835
+ ```
1836
+
1837
+ #### Using the list_projects_tags_with_http_info variant
1838
+
1839
+ This returns an Array which contains the response data, status code and headers.
1840
+
1841
+ > <Array(<Array<ProjectsTag>>, Integer, Hash)> list_projects_tags_with_http_info(team_id, opts)
1842
+
1843
+ ```ruby
1844
+ begin
1845
+
1846
+ data, status_code, headers = api_instance.list_projects_tags_with_http_info(team_id, opts)
1847
+ p status_code # => 2xx
1848
+ p headers # => { ... }
1849
+ p data # => <Array<ProjectsTag>>
1850
+ rescue BtTest::ApiError => e
1851
+ puts "Error when calling PlatformApi->list_projects_tags_with_http_info: #{e}"
1852
+ end
1853
+ ```
1854
+
1855
+ ### Parameters
1856
+
1857
+ | Name | Type | Description | Notes |
1858
+ | ---- | ---- | ----------- | ----- |
1859
+ | **team_id** | **Integer** | Team ID | |
1860
+ | **page** | **Integer** | Page of results to fetch. | [optional][default to 1] |
1861
+ | **per_page** | **Integer** | Number of results to return per page. | [optional][default to 100] |
1862
+
1863
+ ### Return type
1864
+
1865
+ [**Array&lt;ProjectsTag&gt;**](ProjectsTag.md)
1866
+
1867
+ ### Authorization
1868
+
1869
+ [bearerAuth](../README.md#bearerAuth)
1870
+
1871
+ ### HTTP request headers
1872
+
1873
+ - **Content-Type**: Not defined
1874
+ - **Accept**: application/vnd.api+json
1875
+
1876
+
1877
+ ## list_scaffolding_absolutely_abstract_creative_concepts
1878
+
1879
+ > <Array<ScaffoldingAbsolutelyAbstractCreativeConcept>> list_scaffolding_absolutely_abstract_creative_concepts(team_id, opts)
1880
+
1881
+
1882
+
1883
+ List Creative Concepts
1884
+
1885
+ ### Examples
1886
+
1887
+ ```ruby
1888
+ require 'time'
1889
+ require 'bt_test'
1890
+ # setup authorization
1891
+ BtTest.configure do |config|
1892
+ # Configure Bearer authorization (Auth token): bearerAuth
1893
+ config.access_token = 'YOUR_BEARER_TOKEN'
1894
+ end
1895
+
1896
+ api_instance = BtTest::PlatformApi.new
1897
+ team_id = 56 # Integer | Team ID
1898
+ opts = {
1899
+ page: 56, # Integer | Page of results to fetch.
1900
+ per_page: 56 # Integer | Number of results to return per page.
1901
+ }
1902
+
1903
+ begin
1904
+
1905
+ result = api_instance.list_scaffolding_absolutely_abstract_creative_concepts(team_id, opts)
1906
+ p result
1907
+ rescue BtTest::ApiError => e
1908
+ puts "Error when calling PlatformApi->list_scaffolding_absolutely_abstract_creative_concepts: #{e}"
1909
+ end
1910
+ ```
1911
+
1912
+ #### Using the list_scaffolding_absolutely_abstract_creative_concepts_with_http_info variant
1913
+
1914
+ This returns an Array which contains the response data, status code and headers.
1915
+
1916
+ > <Array(<Array<ScaffoldingAbsolutelyAbstractCreativeConcept>>, Integer, Hash)> list_scaffolding_absolutely_abstract_creative_concepts_with_http_info(team_id, opts)
1917
+
1918
+ ```ruby
1919
+ begin
1920
+
1921
+ data, status_code, headers = api_instance.list_scaffolding_absolutely_abstract_creative_concepts_with_http_info(team_id, opts)
1922
+ p status_code # => 2xx
1923
+ p headers # => { ... }
1924
+ p data # => <Array<ScaffoldingAbsolutelyAbstractCreativeConcept>>
1925
+ rescue BtTest::ApiError => e
1926
+ puts "Error when calling PlatformApi->list_scaffolding_absolutely_abstract_creative_concepts_with_http_info: #{e}"
1927
+ end
1928
+ ```
1929
+
1930
+ ### Parameters
1931
+
1932
+ | Name | Type | Description | Notes |
1933
+ | ---- | ---- | ----------- | ----- |
1934
+ | **team_id** | **Integer** | Team ID | |
1935
+ | **page** | **Integer** | Page of results to fetch. | [optional][default to 1] |
1936
+ | **per_page** | **Integer** | Number of results to return per page. | [optional][default to 100] |
1937
+
1938
+ ### Return type
1939
+
1940
+ [**Array&lt;ScaffoldingAbsolutelyAbstractCreativeConcept&gt;**](ScaffoldingAbsolutelyAbstractCreativeConcept.md)
1941
+
1942
+ ### Authorization
1943
+
1944
+ [bearerAuth](../README.md#bearerAuth)
1945
+
1946
+ ### HTTP request headers
1947
+
1948
+ - **Content-Type**: Not defined
1949
+ - **Accept**: application/vnd.api+json
1950
+
1951
+
1952
+ ## list_scaffolding_completely_concrete_tangible_things
1953
+
1954
+ > <Array<ScaffoldingCompletelyConcreteTangibleThing>> list_scaffolding_completely_concrete_tangible_things(absolutely_abstract_creative_concept_id, opts)
1955
+
1956
+
1957
+
1958
+ List Tangible Things
1959
+
1960
+ ### Examples
1961
+
1962
+ ```ruby
1963
+ require 'time'
1964
+ require 'bt_test'
1965
+ # setup authorization
1966
+ BtTest.configure do |config|
1967
+ # Configure Bearer authorization (Auth token): bearerAuth
1968
+ config.access_token = 'YOUR_BEARER_TOKEN'
1969
+ end
1970
+
1971
+ api_instance = BtTest::PlatformApi.new
1972
+ absolutely_abstract_creative_concept_id = 56 # Integer | Creative Concept ID
1973
+ opts = {
1974
+ page: 56, # Integer | Page of results to fetch.
1975
+ per_page: 56 # Integer | Number of results to return per page.
1976
+ }
1977
+
1978
+ begin
1979
+
1980
+ result = api_instance.list_scaffolding_completely_concrete_tangible_things(absolutely_abstract_creative_concept_id, opts)
1981
+ p result
1982
+ rescue BtTest::ApiError => e
1983
+ puts "Error when calling PlatformApi->list_scaffolding_completely_concrete_tangible_things: #{e}"
1984
+ end
1985
+ ```
1986
+
1987
+ #### Using the list_scaffolding_completely_concrete_tangible_things_with_http_info variant
1988
+
1989
+ This returns an Array which contains the response data, status code and headers.
1990
+
1991
+ > <Array(<Array<ScaffoldingCompletelyConcreteTangibleThing>>, Integer, Hash)> list_scaffolding_completely_concrete_tangible_things_with_http_info(absolutely_abstract_creative_concept_id, opts)
1992
+
1993
+ ```ruby
1994
+ begin
1995
+
1996
+ data, status_code, headers = api_instance.list_scaffolding_completely_concrete_tangible_things_with_http_info(absolutely_abstract_creative_concept_id, opts)
1997
+ p status_code # => 2xx
1998
+ p headers # => { ... }
1999
+ p data # => <Array<ScaffoldingCompletelyConcreteTangibleThing>>
2000
+ rescue BtTest::ApiError => e
2001
+ puts "Error when calling PlatformApi->list_scaffolding_completely_concrete_tangible_things_with_http_info: #{e}"
2002
+ end
2003
+ ```
2004
+
2005
+ ### Parameters
2006
+
2007
+ | Name | Type | Description | Notes |
2008
+ | ---- | ---- | ----------- | ----- |
2009
+ | **absolutely_abstract_creative_concept_id** | **Integer** | Creative Concept ID | |
2010
+ | **page** | **Integer** | Page of results to fetch. | [optional][default to 1] |
2011
+ | **per_page** | **Integer** | Number of results to return per page. | [optional][default to 100] |
2012
+
2013
+ ### Return type
2014
+
2015
+ [**Array&lt;ScaffoldingCompletelyConcreteTangibleThing&gt;**](ScaffoldingCompletelyConcreteTangibleThing.md)
2016
+
2017
+ ### Authorization
2018
+
2019
+ [bearerAuth](../README.md#bearerAuth)
2020
+
2021
+ ### HTTP request headers
2022
+
2023
+ - **Content-Type**: Not defined
2024
+ - **Accept**: application/vnd.api+json
2025
+
2026
+
2027
+ ## list_teams
2028
+
2029
+ > <Array<Team>> list_teams(opts)
2030
+
2031
+
2032
+
2033
+ List Teams
2034
+
2035
+ ### Examples
2036
+
2037
+ ```ruby
2038
+ require 'time'
2039
+ require 'bt_test'
2040
+ # setup authorization
2041
+ BtTest.configure do |config|
2042
+ # Configure Bearer authorization (Auth token): bearerAuth
2043
+ config.access_token = 'YOUR_BEARER_TOKEN'
2044
+ end
2045
+
2046
+ api_instance = BtTest::PlatformApi.new
2047
+ opts = {
2048
+ page: 56, # Integer | Page of results to fetch.
2049
+ per_page: 56 # Integer | Number of results to return per page.
2050
+ }
2051
+
2052
+ begin
2053
+
2054
+ result = api_instance.list_teams(opts)
2055
+ p result
2056
+ rescue BtTest::ApiError => e
2057
+ puts "Error when calling PlatformApi->list_teams: #{e}"
2058
+ end
2059
+ ```
2060
+
2061
+ #### Using the list_teams_with_http_info variant
2062
+
2063
+ This returns an Array which contains the response data, status code and headers.
2064
+
2065
+ > <Array(<Array<Team>>, Integer, Hash)> list_teams_with_http_info(opts)
2066
+
2067
+ ```ruby
2068
+ begin
2069
+
2070
+ data, status_code, headers = api_instance.list_teams_with_http_info(opts)
2071
+ p status_code # => 2xx
2072
+ p headers # => { ... }
2073
+ p data # => <Array<Team>>
2074
+ rescue BtTest::ApiError => e
2075
+ puts "Error when calling PlatformApi->list_teams_with_http_info: #{e}"
2076
+ end
2077
+ ```
2078
+
2079
+ ### Parameters
2080
+
2081
+ | Name | Type | Description | Notes |
2082
+ | ---- | ---- | ----------- | ----- |
2083
+ | **page** | **Integer** | Page of results to fetch. | [optional][default to 1] |
2084
+ | **per_page** | **Integer** | Number of results to return per page. | [optional][default to 100] |
2085
+
2086
+ ### Return type
2087
+
2088
+ [**Array&lt;Team&gt;**](Team.md)
2089
+
2090
+ ### Authorization
2091
+
2092
+ [bearerAuth](../README.md#bearerAuth)
2093
+
2094
+ ### HTTP request headers
2095
+
2096
+ - **Content-Type**: Not defined
2097
+ - **Accept**: application/vnd.api+json
2098
+
2099
+
2100
+ ## list_webhooks_outgoing_delivery_attempts
2101
+
2102
+ > <Array<WebhooksOutgoingDeliveryAttempt>> list_webhooks_outgoing_delivery_attempts(delivery_id, opts)
2103
+
2104
+
2105
+
2106
+ List Delivery Attempts
2107
+
2108
+ ### Examples
2109
+
2110
+ ```ruby
2111
+ require 'time'
2112
+ require 'bt_test'
2113
+ # setup authorization
2114
+ BtTest.configure do |config|
2115
+ # Configure Bearer authorization (Auth token): bearerAuth
2116
+ config.access_token = 'YOUR_BEARER_TOKEN'
2117
+ end
2118
+
2119
+ api_instance = BtTest::PlatformApi.new
2120
+ delivery_id = 56 # Integer | Delivery ID
2121
+ opts = {
2122
+ page: 56, # Integer | Page of results to fetch.
2123
+ per_page: 56 # Integer | Number of results to return per page.
2124
+ }
2125
+
2126
+ begin
2127
+
2128
+ result = api_instance.list_webhooks_outgoing_delivery_attempts(delivery_id, opts)
2129
+ p result
2130
+ rescue BtTest::ApiError => e
2131
+ puts "Error when calling PlatformApi->list_webhooks_outgoing_delivery_attempts: #{e}"
2132
+ end
2133
+ ```
2134
+
2135
+ #### Using the list_webhooks_outgoing_delivery_attempts_with_http_info variant
2136
+
2137
+ This returns an Array which contains the response data, status code and headers.
2138
+
2139
+ > <Array(<Array<WebhooksOutgoingDeliveryAttempt>>, Integer, Hash)> list_webhooks_outgoing_delivery_attempts_with_http_info(delivery_id, opts)
2140
+
2141
+ ```ruby
2142
+ begin
2143
+
2144
+ data, status_code, headers = api_instance.list_webhooks_outgoing_delivery_attempts_with_http_info(delivery_id, opts)
2145
+ p status_code # => 2xx
2146
+ p headers # => { ... }
2147
+ p data # => <Array<WebhooksOutgoingDeliveryAttempt>>
2148
+ rescue BtTest::ApiError => e
2149
+ puts "Error when calling PlatformApi->list_webhooks_outgoing_delivery_attempts_with_http_info: #{e}"
2150
+ end
2151
+ ```
2152
+
2153
+ ### Parameters
2154
+
2155
+ | Name | Type | Description | Notes |
2156
+ | ---- | ---- | ----------- | ----- |
2157
+ | **delivery_id** | **Integer** | Delivery ID | |
2158
+ | **page** | **Integer** | Page of results to fetch. | [optional][default to 1] |
2159
+ | **per_page** | **Integer** | Number of results to return per page. | [optional][default to 100] |
2160
+
2161
+ ### Return type
2162
+
2163
+ [**Array&lt;WebhooksOutgoingDeliveryAttempt&gt;**](WebhooksOutgoingDeliveryAttempt.md)
2164
+
2165
+ ### Authorization
2166
+
2167
+ [bearerAuth](../README.md#bearerAuth)
2168
+
2169
+ ### HTTP request headers
2170
+
2171
+ - **Content-Type**: Not defined
2172
+ - **Accept**: application/vnd.api+json
2173
+
2174
+
2175
+ ## list_webhooks_outgoing_deliverys
2176
+
2177
+ > <Array<WebhooksOutgoingDelivery>> list_webhooks_outgoing_deliverys(endpoint_id, opts)
2178
+
2179
+
2180
+
2181
+ List Deliveries
2182
+
2183
+ ### Examples
2184
+
2185
+ ```ruby
2186
+ require 'time'
2187
+ require 'bt_test'
2188
+ # setup authorization
2189
+ BtTest.configure do |config|
2190
+ # Configure Bearer authorization (Auth token): bearerAuth
2191
+ config.access_token = 'YOUR_BEARER_TOKEN'
2192
+ end
2193
+
2194
+ api_instance = BtTest::PlatformApi.new
2195
+ endpoint_id = 56 # Integer | Endpoint ID
2196
+ opts = {
2197
+ page: 56, # Integer | Page of results to fetch.
2198
+ per_page: 56 # Integer | Number of results to return per page.
2199
+ }
2200
+
2201
+ begin
2202
+
2203
+ result = api_instance.list_webhooks_outgoing_deliverys(endpoint_id, opts)
2204
+ p result
2205
+ rescue BtTest::ApiError => e
2206
+ puts "Error when calling PlatformApi->list_webhooks_outgoing_deliverys: #{e}"
2207
+ end
2208
+ ```
2209
+
2210
+ #### Using the list_webhooks_outgoing_deliverys_with_http_info variant
2211
+
2212
+ This returns an Array which contains the response data, status code and headers.
2213
+
2214
+ > <Array(<Array<WebhooksOutgoingDelivery>>, Integer, Hash)> list_webhooks_outgoing_deliverys_with_http_info(endpoint_id, opts)
2215
+
2216
+ ```ruby
2217
+ begin
2218
+
2219
+ data, status_code, headers = api_instance.list_webhooks_outgoing_deliverys_with_http_info(endpoint_id, opts)
2220
+ p status_code # => 2xx
2221
+ p headers # => { ... }
2222
+ p data # => <Array<WebhooksOutgoingDelivery>>
2223
+ rescue BtTest::ApiError => e
2224
+ puts "Error when calling PlatformApi->list_webhooks_outgoing_deliverys_with_http_info: #{e}"
2225
+ end
2226
+ ```
2227
+
2228
+ ### Parameters
2229
+
2230
+ | Name | Type | Description | Notes |
2231
+ | ---- | ---- | ----------- | ----- |
2232
+ | **endpoint_id** | **Integer** | Endpoint ID | |
2233
+ | **page** | **Integer** | Page of results to fetch. | [optional][default to 1] |
2234
+ | **per_page** | **Integer** | Number of results to return per page. | [optional][default to 100] |
2235
+
2236
+ ### Return type
2237
+
2238
+ [**Array&lt;WebhooksOutgoingDelivery&gt;**](WebhooksOutgoingDelivery.md)
2239
+
2240
+ ### Authorization
2241
+
2242
+ [bearerAuth](../README.md#bearerAuth)
2243
+
2244
+ ### HTTP request headers
2245
+
2246
+ - **Content-Type**: Not defined
2247
+ - **Accept**: application/vnd.api+json
2248
+
2249
+
2250
+ ## list_webhooks_outgoing_endpoints
2251
+
2252
+ > <Array<WebhooksOutgoingEndpoint>> list_webhooks_outgoing_endpoints(team_id, opts)
2253
+
2254
+
2255
+
2256
+ List Endpoints
2257
+
2258
+ ### Examples
2259
+
2260
+ ```ruby
2261
+ require 'time'
2262
+ require 'bt_test'
2263
+ # setup authorization
2264
+ BtTest.configure do |config|
2265
+ # Configure Bearer authorization (Auth token): bearerAuth
2266
+ config.access_token = 'YOUR_BEARER_TOKEN'
2267
+ end
2268
+
2269
+ api_instance = BtTest::PlatformApi.new
2270
+ team_id = 56 # Integer | Team ID
2271
+ opts = {
2272
+ page: 56, # Integer | Page of results to fetch.
2273
+ per_page: 56 # Integer | Number of results to return per page.
2274
+ }
2275
+
2276
+ begin
2277
+
2278
+ result = api_instance.list_webhooks_outgoing_endpoints(team_id, opts)
2279
+ p result
2280
+ rescue BtTest::ApiError => e
2281
+ puts "Error when calling PlatformApi->list_webhooks_outgoing_endpoints: #{e}"
2282
+ end
2283
+ ```
2284
+
2285
+ #### Using the list_webhooks_outgoing_endpoints_with_http_info variant
2286
+
2287
+ This returns an Array which contains the response data, status code and headers.
2288
+
2289
+ > <Array(<Array<WebhooksOutgoingEndpoint>>, Integer, Hash)> list_webhooks_outgoing_endpoints_with_http_info(team_id, opts)
2290
+
2291
+ ```ruby
2292
+ begin
2293
+
2294
+ data, status_code, headers = api_instance.list_webhooks_outgoing_endpoints_with_http_info(team_id, opts)
2295
+ p status_code # => 2xx
2296
+ p headers # => { ... }
2297
+ p data # => <Array<WebhooksOutgoingEndpoint>>
2298
+ rescue BtTest::ApiError => e
2299
+ puts "Error when calling PlatformApi->list_webhooks_outgoing_endpoints_with_http_info: #{e}"
2300
+ end
2301
+ ```
2302
+
2303
+ ### Parameters
2304
+
2305
+ | Name | Type | Description | Notes |
2306
+ | ---- | ---- | ----------- | ----- |
2307
+ | **team_id** | **Integer** | Team ID | |
2308
+ | **page** | **Integer** | Page of results to fetch. | [optional][default to 1] |
2309
+ | **per_page** | **Integer** | Number of results to return per page. | [optional][default to 100] |
2310
+
2311
+ ### Return type
2312
+
2313
+ [**Array&lt;WebhooksOutgoingEndpoint&gt;**](WebhooksOutgoingEndpoint.md)
2314
+
2315
+ ### Authorization
2316
+
2317
+ [bearerAuth](../README.md#bearerAuth)
2318
+
2319
+ ### HTTP request headers
2320
+
2321
+ - **Content-Type**: Not defined
2322
+ - **Accept**: application/vnd.api+json
2323
+
2324
+
2325
+ ## update_goal
2326
+
2327
+ > <Goal> update_goal(id, opts)
2328
+
2329
+
2330
+
2331
+ Update a Goal
2332
+
2333
+ ### Examples
2334
+
2335
+ ```ruby
2336
+ require 'time'
2337
+ require 'bt_test'
2338
+ # setup authorization
2339
+ BtTest.configure do |config|
2340
+ # Configure Bearer authorization (Auth token): bearerAuth
2341
+ config.access_token = 'YOUR_BEARER_TOKEN'
2342
+ end
2343
+
2344
+ api_instance = BtTest::PlatformApi.new
2345
+ id = 56 # Integer | Goal ID
2346
+ opts = {
2347
+ create_goal_request: BtTest::CreateGoalRequest.new # CreateGoalRequest |
2348
+ }
2349
+
2350
+ begin
2351
+
2352
+ result = api_instance.update_goal(id, opts)
2353
+ p result
2354
+ rescue BtTest::ApiError => e
2355
+ puts "Error when calling PlatformApi->update_goal: #{e}"
2356
+ end
2357
+ ```
2358
+
2359
+ #### Using the update_goal_with_http_info variant
2360
+
2361
+ This returns an Array which contains the response data, status code and headers.
2362
+
2363
+ > <Array(<Goal>, Integer, Hash)> update_goal_with_http_info(id, opts)
2364
+
2365
+ ```ruby
2366
+ begin
2367
+
2368
+ data, status_code, headers = api_instance.update_goal_with_http_info(id, opts)
2369
+ p status_code # => 2xx
2370
+ p headers # => { ... }
2371
+ p data # => <Goal>
2372
+ rescue BtTest::ApiError => e
2373
+ puts "Error when calling PlatformApi->update_goal_with_http_info: #{e}"
2374
+ end
2375
+ ```
2376
+
2377
+ ### Parameters
2378
+
2379
+ | Name | Type | Description | Notes |
2380
+ | ---- | ---- | ----------- | ----- |
2381
+ | **id** | **Integer** | Goal ID | |
2382
+ | **create_goal_request** | [**CreateGoalRequest**](CreateGoalRequest.md) | | [optional] |
2383
+
2384
+ ### Return type
2385
+
2386
+ [**Goal**](Goal.md)
2387
+
2388
+ ### Authorization
2389
+
2390
+ [bearerAuth](../README.md#bearerAuth)
2391
+
2392
+ ### HTTP request headers
2393
+
2394
+ - **Content-Type**: application/json, multipart/form-data
2395
+ - **Accept**: application/vnd.api+json
2396
+
2397
+
2398
+ ## update_project
2399
+
2400
+ > <Project> update_project(id, opts)
2401
+
2402
+
2403
+
2404
+ Update a Project
2405
+
2406
+ ### Examples
2407
+
2408
+ ```ruby
2409
+ require 'time'
2410
+ require 'bt_test'
2411
+ # setup authorization
2412
+ BtTest.configure do |config|
2413
+ # Configure Bearer authorization (Auth token): bearerAuth
2414
+ config.access_token = 'YOUR_BEARER_TOKEN'
2415
+ end
2416
+
2417
+ api_instance = BtTest::PlatformApi.new
2418
+ id = 56 # Integer | Project ID
2419
+ opts = {
2420
+ create_project_request: BtTest::CreateProjectRequest.new # CreateProjectRequest |
2421
+ }
2422
+
2423
+ begin
2424
+
2425
+ result = api_instance.update_project(id, opts)
2426
+ p result
2427
+ rescue BtTest::ApiError => e
2428
+ puts "Error when calling PlatformApi->update_project: #{e}"
2429
+ end
2430
+ ```
2431
+
2432
+ #### Using the update_project_with_http_info variant
2433
+
2434
+ This returns an Array which contains the response data, status code and headers.
2435
+
2436
+ > <Array(<Project>, Integer, Hash)> update_project_with_http_info(id, opts)
2437
+
2438
+ ```ruby
2439
+ begin
2440
+
2441
+ data, status_code, headers = api_instance.update_project_with_http_info(id, opts)
2442
+ p status_code # => 2xx
2443
+ p headers # => { ... }
2444
+ p data # => <Project>
2445
+ rescue BtTest::ApiError => e
2446
+ puts "Error when calling PlatformApi->update_project_with_http_info: #{e}"
2447
+ end
2448
+ ```
2449
+
2450
+ ### Parameters
2451
+
2452
+ | Name | Type | Description | Notes |
2453
+ | ---- | ---- | ----------- | ----- |
2454
+ | **id** | **Integer** | Project ID | |
2455
+ | **create_project_request** | [**CreateProjectRequest**](CreateProjectRequest.md) | | [optional] |
2456
+
2457
+ ### Return type
2458
+
2459
+ [**Project**](Project.md)
2460
+
2461
+ ### Authorization
2462
+
2463
+ [bearerAuth](../README.md#bearerAuth)
2464
+
2465
+ ### HTTP request headers
2466
+
2467
+ - **Content-Type**: application/json, multipart/form-data
2468
+ - **Accept**: application/vnd.api+json
2469
+
2470
+
2471
+ ## update_projects_tag
2472
+
2473
+ > <ProjectsTag> update_projects_tag(id, opts)
2474
+
2475
+
2476
+
2477
+ Update a Tag
2478
+
2479
+ ### Examples
2480
+
2481
+ ```ruby
2482
+ require 'time'
2483
+ require 'bt_test'
2484
+ # setup authorization
2485
+ BtTest.configure do |config|
2486
+ # Configure Bearer authorization (Auth token): bearerAuth
2487
+ config.access_token = 'YOUR_BEARER_TOKEN'
2488
+ end
2489
+
2490
+ api_instance = BtTest::PlatformApi.new
2491
+ id = 56 # Integer | Tag ID
2492
+ opts = {
2493
+ create_projects_tag_request: BtTest::CreateProjectsTagRequest.new # CreateProjectsTagRequest |
2494
+ }
2495
+
2496
+ begin
2497
+
2498
+ result = api_instance.update_projects_tag(id, opts)
2499
+ p result
2500
+ rescue BtTest::ApiError => e
2501
+ puts "Error when calling PlatformApi->update_projects_tag: #{e}"
2502
+ end
2503
+ ```
2504
+
2505
+ #### Using the update_projects_tag_with_http_info variant
2506
+
2507
+ This returns an Array which contains the response data, status code and headers.
2508
+
2509
+ > <Array(<ProjectsTag>, Integer, Hash)> update_projects_tag_with_http_info(id, opts)
2510
+
2511
+ ```ruby
2512
+ begin
2513
+
2514
+ data, status_code, headers = api_instance.update_projects_tag_with_http_info(id, opts)
2515
+ p status_code # => 2xx
2516
+ p headers # => { ... }
2517
+ p data # => <ProjectsTag>
2518
+ rescue BtTest::ApiError => e
2519
+ puts "Error when calling PlatformApi->update_projects_tag_with_http_info: #{e}"
2520
+ end
2521
+ ```
2522
+
2523
+ ### Parameters
2524
+
2525
+ | Name | Type | Description | Notes |
2526
+ | ---- | ---- | ----------- | ----- |
2527
+ | **id** | **Integer** | Tag ID | |
2528
+ | **create_projects_tag_request** | [**CreateProjectsTagRequest**](CreateProjectsTagRequest.md) | | [optional] |
2529
+
2530
+ ### Return type
2531
+
2532
+ [**ProjectsTag**](ProjectsTag.md)
2533
+
2534
+ ### Authorization
2535
+
2536
+ [bearerAuth](../README.md#bearerAuth)
2537
+
2538
+ ### HTTP request headers
2539
+
2540
+ - **Content-Type**: application/json, multipart/form-data
2541
+ - **Accept**: application/vnd.api+json
2542
+
2543
+
2544
+ ## update_scaffolding_absolutely_abstract_creative_concept
2545
+
2546
+ > <ScaffoldingAbsolutelyAbstractCreativeConcept> update_scaffolding_absolutely_abstract_creative_concept(id, opts)
2547
+
2548
+
2549
+
2550
+ Update a Creative Concept
2551
+
2552
+ ### Examples
2553
+
2554
+ ```ruby
2555
+ require 'time'
2556
+ require 'bt_test'
2557
+ # setup authorization
2558
+ BtTest.configure do |config|
2559
+ # Configure Bearer authorization (Auth token): bearerAuth
2560
+ config.access_token = 'YOUR_BEARER_TOKEN'
2561
+ end
2562
+
2563
+ api_instance = BtTest::PlatformApi.new
2564
+ id = 56 # Integer | Creative Concept ID
2565
+ opts = {
2566
+ create_scaffolding_absolutely_abstract_creative_concept_request: BtTest::CreateScaffoldingAbsolutelyAbstractCreativeConceptRequest.new # CreateScaffoldingAbsolutelyAbstractCreativeConceptRequest |
2567
+ }
2568
+
2569
+ begin
2570
+
2571
+ result = api_instance.update_scaffolding_absolutely_abstract_creative_concept(id, opts)
2572
+ p result
2573
+ rescue BtTest::ApiError => e
2574
+ puts "Error when calling PlatformApi->update_scaffolding_absolutely_abstract_creative_concept: #{e}"
2575
+ end
2576
+ ```
2577
+
2578
+ #### Using the update_scaffolding_absolutely_abstract_creative_concept_with_http_info variant
2579
+
2580
+ This returns an Array which contains the response data, status code and headers.
2581
+
2582
+ > <Array(<ScaffoldingAbsolutelyAbstractCreativeConcept>, Integer, Hash)> update_scaffolding_absolutely_abstract_creative_concept_with_http_info(id, opts)
2583
+
2584
+ ```ruby
2585
+ begin
2586
+
2587
+ data, status_code, headers = api_instance.update_scaffolding_absolutely_abstract_creative_concept_with_http_info(id, opts)
2588
+ p status_code # => 2xx
2589
+ p headers # => { ... }
2590
+ p data # => <ScaffoldingAbsolutelyAbstractCreativeConcept>
2591
+ rescue BtTest::ApiError => e
2592
+ puts "Error when calling PlatformApi->update_scaffolding_absolutely_abstract_creative_concept_with_http_info: #{e}"
2593
+ end
2594
+ ```
2595
+
2596
+ ### Parameters
2597
+
2598
+ | Name | Type | Description | Notes |
2599
+ | ---- | ---- | ----------- | ----- |
2600
+ | **id** | **Integer** | Creative Concept ID | |
2601
+ | **create_scaffolding_absolutely_abstract_creative_concept_request** | [**CreateScaffoldingAbsolutelyAbstractCreativeConceptRequest**](CreateScaffoldingAbsolutelyAbstractCreativeConceptRequest.md) | | [optional] |
2602
+
2603
+ ### Return type
2604
+
2605
+ [**ScaffoldingAbsolutelyAbstractCreativeConcept**](ScaffoldingAbsolutelyAbstractCreativeConcept.md)
2606
+
2607
+ ### Authorization
2608
+
2609
+ [bearerAuth](../README.md#bearerAuth)
2610
+
2611
+ ### HTTP request headers
2612
+
2613
+ - **Content-Type**: application/json, multipart/form-data
2614
+ - **Accept**: application/vnd.api+json
2615
+
2616
+
2617
+ ## update_scaffolding_completely_concrete_tangible_thing
2618
+
2619
+ > <ScaffoldingCompletelyConcreteTangibleThing> update_scaffolding_completely_concrete_tangible_thing(id, opts)
2620
+
2621
+
2622
+
2623
+ Update a Tangible Thing
2624
+
2625
+ ### Examples
2626
+
2627
+ ```ruby
2628
+ require 'time'
2629
+ require 'bt_test'
2630
+ # setup authorization
2631
+ BtTest.configure do |config|
2632
+ # Configure Bearer authorization (Auth token): bearerAuth
2633
+ config.access_token = 'YOUR_BEARER_TOKEN'
2634
+ end
2635
+
2636
+ api_instance = BtTest::PlatformApi.new
2637
+ id = 56 # Integer | Tangible Thing ID
2638
+ opts = {
2639
+ update_scaffolding_completely_concrete_tangible_thing_request: BtTest::UpdateScaffoldingCompletelyConcreteTangibleThingRequest.new # UpdateScaffoldingCompletelyConcreteTangibleThingRequest |
2640
+ }
2641
+
2642
+ begin
2643
+
2644
+ result = api_instance.update_scaffolding_completely_concrete_tangible_thing(id, opts)
2645
+ p result
2646
+ rescue BtTest::ApiError => e
2647
+ puts "Error when calling PlatformApi->update_scaffolding_completely_concrete_tangible_thing: #{e}"
2648
+ end
2649
+ ```
2650
+
2651
+ #### Using the update_scaffolding_completely_concrete_tangible_thing_with_http_info variant
2652
+
2653
+ This returns an Array which contains the response data, status code and headers.
2654
+
2655
+ > <Array(<ScaffoldingCompletelyConcreteTangibleThing>, Integer, Hash)> update_scaffolding_completely_concrete_tangible_thing_with_http_info(id, opts)
2656
+
2657
+ ```ruby
2658
+ begin
2659
+
2660
+ data, status_code, headers = api_instance.update_scaffolding_completely_concrete_tangible_thing_with_http_info(id, opts)
2661
+ p status_code # => 2xx
2662
+ p headers # => { ... }
2663
+ p data # => <ScaffoldingCompletelyConcreteTangibleThing>
2664
+ rescue BtTest::ApiError => e
2665
+ puts "Error when calling PlatformApi->update_scaffolding_completely_concrete_tangible_thing_with_http_info: #{e}"
2666
+ end
2667
+ ```
2668
+
2669
+ ### Parameters
2670
+
2671
+ | Name | Type | Description | Notes |
2672
+ | ---- | ---- | ----------- | ----- |
2673
+ | **id** | **Integer** | Tangible Thing ID | |
2674
+ | **update_scaffolding_completely_concrete_tangible_thing_request** | [**UpdateScaffoldingCompletelyConcreteTangibleThingRequest**](UpdateScaffoldingCompletelyConcreteTangibleThingRequest.md) | | [optional] |
2675
+
2676
+ ### Return type
2677
+
2678
+ [**ScaffoldingCompletelyConcreteTangibleThing**](ScaffoldingCompletelyConcreteTangibleThing.md)
2679
+
2680
+ ### Authorization
2681
+
2682
+ [bearerAuth](../README.md#bearerAuth)
2683
+
2684
+ ### HTTP request headers
2685
+
2686
+ - **Content-Type**: application/json, multipart/form-data
2687
+ - **Accept**: application/vnd.api+json
2688
+
2689
+
2690
+ ## update_team
2691
+
2692
+ > <Team> update_team(id, opts)
2693
+
2694
+
2695
+
2696
+ Update a Team
2697
+
2698
+ ### Examples
2699
+
2700
+ ```ruby
2701
+ require 'time'
2702
+ require 'bt_test'
2703
+ # setup authorization
2704
+ BtTest.configure do |config|
2705
+ # Configure Bearer authorization (Auth token): bearerAuth
2706
+ config.access_token = 'YOUR_BEARER_TOKEN'
2707
+ end
2708
+
2709
+ api_instance = BtTest::PlatformApi.new
2710
+ id = 56 # Integer | Team ID
2711
+ opts = {
2712
+ create_team_request: BtTest::CreateTeamRequest.new # CreateTeamRequest |
2713
+ }
2714
+
2715
+ begin
2716
+
2717
+ result = api_instance.update_team(id, opts)
2718
+ p result
2719
+ rescue BtTest::ApiError => e
2720
+ puts "Error when calling PlatformApi->update_team: #{e}"
2721
+ end
2722
+ ```
2723
+
2724
+ #### Using the update_team_with_http_info variant
2725
+
2726
+ This returns an Array which contains the response data, status code and headers.
2727
+
2728
+ > <Array(<Team>, Integer, Hash)> update_team_with_http_info(id, opts)
2729
+
2730
+ ```ruby
2731
+ begin
2732
+
2733
+ data, status_code, headers = api_instance.update_team_with_http_info(id, opts)
2734
+ p status_code # => 2xx
2735
+ p headers # => { ... }
2736
+ p data # => <Team>
2737
+ rescue BtTest::ApiError => e
2738
+ puts "Error when calling PlatformApi->update_team_with_http_info: #{e}"
2739
+ end
2740
+ ```
2741
+
2742
+ ### Parameters
2743
+
2744
+ | Name | Type | Description | Notes |
2745
+ | ---- | ---- | ----------- | ----- |
2746
+ | **id** | **Integer** | Team ID | |
2747
+ | **create_team_request** | [**CreateTeamRequest**](CreateTeamRequest.md) | | [optional] |
2748
+
2749
+ ### Return type
2750
+
2751
+ [**Team**](Team.md)
2752
+
2753
+ ### Authorization
2754
+
2755
+ [bearerAuth](../README.md#bearerAuth)
2756
+
2757
+ ### HTTP request headers
2758
+
2759
+ - **Content-Type**: application/json, multipart/form-data
2760
+ - **Accept**: application/vnd.api+json
2761
+
2762
+
2763
+ ## update_webhooks_outgoing_endpoint
2764
+
2765
+ > <WebhooksOutgoingEndpoint> update_webhooks_outgoing_endpoint(id, opts)
2766
+
2767
+
2768
+
2769
+ Update a Endpoint
2770
+
2771
+ ### Examples
2772
+
2773
+ ```ruby
2774
+ require 'time'
2775
+ require 'bt_test'
2776
+ # setup authorization
2777
+ BtTest.configure do |config|
2778
+ # Configure Bearer authorization (Auth token): bearerAuth
2779
+ config.access_token = 'YOUR_BEARER_TOKEN'
2780
+ end
2781
+
2782
+ api_instance = BtTest::PlatformApi.new
2783
+ id = 56 # Integer | Endpoint ID
2784
+ opts = {
2785
+ create_webhooks_outgoing_endpoint_request: BtTest::CreateWebhooksOutgoingEndpointRequest.new # CreateWebhooksOutgoingEndpointRequest |
2786
+ }
2787
+
2788
+ begin
2789
+
2790
+ result = api_instance.update_webhooks_outgoing_endpoint(id, opts)
2791
+ p result
2792
+ rescue BtTest::ApiError => e
2793
+ puts "Error when calling PlatformApi->update_webhooks_outgoing_endpoint: #{e}"
2794
+ end
2795
+ ```
2796
+
2797
+ #### Using the update_webhooks_outgoing_endpoint_with_http_info variant
2798
+
2799
+ This returns an Array which contains the response data, status code and headers.
2800
+
2801
+ > <Array(<WebhooksOutgoingEndpoint>, Integer, Hash)> update_webhooks_outgoing_endpoint_with_http_info(id, opts)
2802
+
2803
+ ```ruby
2804
+ begin
2805
+
2806
+ data, status_code, headers = api_instance.update_webhooks_outgoing_endpoint_with_http_info(id, opts)
2807
+ p status_code # => 2xx
2808
+ p headers # => { ... }
2809
+ p data # => <WebhooksOutgoingEndpoint>
2810
+ rescue BtTest::ApiError => e
2811
+ puts "Error when calling PlatformApi->update_webhooks_outgoing_endpoint_with_http_info: #{e}"
2812
+ end
2813
+ ```
2814
+
2815
+ ### Parameters
2816
+
2817
+ | Name | Type | Description | Notes |
2818
+ | ---- | ---- | ----------- | ----- |
2819
+ | **id** | **Integer** | Endpoint ID | |
2820
+ | **create_webhooks_outgoing_endpoint_request** | [**CreateWebhooksOutgoingEndpointRequest**](CreateWebhooksOutgoingEndpointRequest.md) | | [optional] |
2821
+
2822
+ ### Return type
2823
+
2824
+ [**WebhooksOutgoingEndpoint**](WebhooksOutgoingEndpoint.md)
2825
+
2826
+ ### Authorization
2827
+
2828
+ [bearerAuth](../README.md#bearerAuth)
2829
+
2830
+ ### HTTP request headers
2831
+
2832
+ - **Content-Type**: application/json, multipart/form-data
2833
+ - **Accept**: application/vnd.api+json
2834
+