thecompaniesapi 1.0.1

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 (100) hide show
  1. checksums.yaml +7 -0
  2. data/.env.example +4 -0
  3. data/.github/workflows/release.yml +106 -0
  4. data/.github/workflows/tests.yml +93 -0
  5. data/.gitignore +146 -0
  6. data/CODE_OF_CONDUCT.md +74 -0
  7. data/Gemfile +7 -0
  8. data/Gemfile.lock +36 -0
  9. data/LICENSE.txt +21 -0
  10. data/README.md +551 -0
  11. data/Rakefile +25 -0
  12. data/bin/console +14 -0
  13. data/bin/setup +8 -0
  14. data/lib/thecompaniesapi/client.rb +643 -0
  15. data/lib/thecompaniesapi/error.rb +28 -0
  16. data/lib/thecompaniesapi/generated/models/action.rb +91 -0
  17. data/lib/thecompaniesapi/generated/models/company_v2.rb +136 -0
  18. data/lib/thecompaniesapi/generated/models/email_pattern.rb +51 -0
  19. data/lib/thecompaniesapi/generated/models/job_title.rb +81 -0
  20. data/lib/thecompaniesapi/generated/models/list.rb +141 -0
  21. data/lib/thecompaniesapi/generated/models/list_analytics.rb +46 -0
  22. data/lib/thecompaniesapi/generated/models/llmanswer.rb +66 -0
  23. data/lib/thecompaniesapi/generated/models/nominatim_city.rb +101 -0
  24. data/lib/thecompaniesapi/generated/models/nominatim_continent.rb +111 -0
  25. data/lib/thecompaniesapi/generated/models/nominatim_country.rb +121 -0
  26. data/lib/thecompaniesapi/generated/models/nominatim_county.rb +96 -0
  27. data/lib/thecompaniesapi/generated/models/nominatim_state.rb +96 -0
  28. data/lib/thecompaniesapi/generated/models/page_contents_ideated.rb +171 -0
  29. data/lib/thecompaniesapi/generated/models/page_contents_link.rb +41 -0
  30. data/lib/thecompaniesapi/generated/models/page_contents_page.rb +71 -0
  31. data/lib/thecompaniesapi/generated/models/pagination_meta.rb +76 -0
  32. data/lib/thecompaniesapi/generated/models/prompt.rb +91 -0
  33. data/lib/thecompaniesapi/generated/models/segmentation_condition.rb +56 -0
  34. data/lib/thecompaniesapi/generated/models/team.rb +101 -0
  35. data/lib/thecompaniesapi/generated/models/technology.rb +96 -0
  36. data/lib/thecompaniesapi/generated/models/user.rb +101 -0
  37. data/lib/thecompaniesapi/generated/operations_map.rb +11 -0
  38. data/lib/thecompaniesapi/generated/requests/ask_company_request.rb +60 -0
  39. data/lib/thecompaniesapi/generated/requests/count_companies_post_request.rb +50 -0
  40. data/lib/thecompaniesapi/generated/requests/create_list_request.rb +70 -0
  41. data/lib/thecompaniesapi/generated/requests/export_companies_analytics_request.rb +70 -0
  42. data/lib/thecompaniesapi/generated/requests/fetch_companies_in_list_post_request.rb +70 -0
  43. data/lib/thecompaniesapi/generated/requests/product_prompt_request.rb +65 -0
  44. data/lib/thecompaniesapi/generated/requests/prompt_to_segmentation_request.rb +55 -0
  45. data/lib/thecompaniesapi/generated/requests/request_action_request.rb +80 -0
  46. data/lib/thecompaniesapi/generated/requests/retry_action_request.rb +30 -0
  47. data/lib/thecompaniesapi/generated/requests/search_companies_post_request.rb +90 -0
  48. data/lib/thecompaniesapi/generated/requests/toggle_companies_in_list_request.rb +50 -0
  49. data/lib/thecompaniesapi/generated/requests/update_list_request.rb +65 -0
  50. data/lib/thecompaniesapi/generated/requests/update_team_request.rb +45 -0
  51. data/lib/thecompaniesapi/generated/responses/ask_company_response.rb +38 -0
  52. data/lib/thecompaniesapi/generated/responses/count_companies_post_response.rb +34 -0
  53. data/lib/thecompaniesapi/generated/responses/count_companies_response.rb +34 -0
  54. data/lib/thecompaniesapi/generated/responses/create_list_response.rb +25 -0
  55. data/lib/thecompaniesapi/generated/responses/delete_list_response.rb +25 -0
  56. data/lib/thecompaniesapi/generated/responses/delete_prompt_response.rb +25 -0
  57. data/lib/thecompaniesapi/generated/responses/enrich_job_titles_response.rb +25 -0
  58. data/lib/thecompaniesapi/generated/responses/export_companies_analytics_response.rb +38 -0
  59. data/lib/thecompaniesapi/generated/responses/fetch_actions_response.rb +38 -0
  60. data/lib/thecompaniesapi/generated/responses/fetch_api_health_response.rb +42 -0
  61. data/lib/thecompaniesapi/generated/responses/fetch_companies_analytics_response.rb +38 -0
  62. data/lib/thecompaniesapi/generated/responses/fetch_companies_in_list_post_response.rb +42 -0
  63. data/lib/thecompaniesapi/generated/responses/fetch_companies_in_list_response.rb +42 -0
  64. data/lib/thecompaniesapi/generated/responses/fetch_company_by_email_response.rb +42 -0
  65. data/lib/thecompaniesapi/generated/responses/fetch_company_by_social_response.rb +25 -0
  66. data/lib/thecompaniesapi/generated/responses/fetch_company_context_response.rb +38 -0
  67. data/lib/thecompaniesapi/generated/responses/fetch_company_email_patterns_response.rb +25 -0
  68. data/lib/thecompaniesapi/generated/responses/fetch_company_in_list_response.rb +25 -0
  69. data/lib/thecompaniesapi/generated/responses/fetch_company_response.rb +25 -0
  70. data/lib/thecompaniesapi/generated/responses/fetch_lists_response.rb +38 -0
  71. data/lib/thecompaniesapi/generated/responses/fetch_open_api_response.rb +30 -0
  72. data/lib/thecompaniesapi/generated/responses/fetch_prompts_response.rb +38 -0
  73. data/lib/thecompaniesapi/generated/responses/fetch_team_response.rb +25 -0
  74. data/lib/thecompaniesapi/generated/responses/fetch_user_response.rb +25 -0
  75. data/lib/thecompaniesapi/generated/responses/product_prompt_response.rb +42 -0
  76. data/lib/thecompaniesapi/generated/responses/prompt_to_segmentation_response.rb +42 -0
  77. data/lib/thecompaniesapi/generated/responses/request_action_response.rb +34 -0
  78. data/lib/thecompaniesapi/generated/responses/retry_action_response.rb +34 -0
  79. data/lib/thecompaniesapi/generated/responses/search_cities_response.rb +38 -0
  80. data/lib/thecompaniesapi/generated/responses/search_companies_by_name_response.rb +38 -0
  81. data/lib/thecompaniesapi/generated/responses/search_companies_by_prompt_response.rb +38 -0
  82. data/lib/thecompaniesapi/generated/responses/search_companies_post_response.rb +42 -0
  83. data/lib/thecompaniesapi/generated/responses/search_companies_response.rb +42 -0
  84. data/lib/thecompaniesapi/generated/responses/search_continents_response.rb +38 -0
  85. data/lib/thecompaniesapi/generated/responses/search_counties_response.rb +38 -0
  86. data/lib/thecompaniesapi/generated/responses/search_countries_response.rb +38 -0
  87. data/lib/thecompaniesapi/generated/responses/search_industries_response.rb +38 -0
  88. data/lib/thecompaniesapi/generated/responses/search_industries_similar_response.rb +38 -0
  89. data/lib/thecompaniesapi/generated/responses/search_similar_companies_response.rb +38 -0
  90. data/lib/thecompaniesapi/generated/responses/search_states_response.rb +38 -0
  91. data/lib/thecompaniesapi/generated/responses/search_technologies_response.rb +38 -0
  92. data/lib/thecompaniesapi/generated/responses/toggle_companies_in_list_response.rb +25 -0
  93. data/lib/thecompaniesapi/generated/responses/update_list_response.rb +25 -0
  94. data/lib/thecompaniesapi/generated/responses/update_team_response.rb +25 -0
  95. data/lib/thecompaniesapi/http_client.rb +146 -0
  96. data/lib/thecompaniesapi/version.rb +3 -0
  97. data/lib/thecompaniesapi.rb +7 -0
  98. data/script/generate_client.rb +653 -0
  99. data/thecompaniesapi.gemspec +34 -0
  100. metadata +188 -0
metadata ADDED
@@ -0,0 +1,188 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: thecompaniesapi
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.1
5
+ platform: ruby
6
+ authors:
7
+ - The Companies API SARL
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2025-07-23 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: faraday
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '2.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: faraday-net_http
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '3.0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '3.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: dotenv
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '2.8'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '2.8'
55
+ description: A fully-featured Ruby SDK for The Companies API, providing type-safe
56
+ access to company data, locations, industries, technologies, job titles, lists,
57
+ and more.
58
+ email:
59
+ - yael@thecompaniesapi.com
60
+ executables: []
61
+ extensions: []
62
+ extra_rdoc_files: []
63
+ files:
64
+ - ".env.example"
65
+ - ".github/workflows/release.yml"
66
+ - ".github/workflows/tests.yml"
67
+ - ".gitignore"
68
+ - CODE_OF_CONDUCT.md
69
+ - Gemfile
70
+ - Gemfile.lock
71
+ - LICENSE.txt
72
+ - README.md
73
+ - Rakefile
74
+ - bin/console
75
+ - bin/setup
76
+ - lib/thecompaniesapi.rb
77
+ - lib/thecompaniesapi/client.rb
78
+ - lib/thecompaniesapi/error.rb
79
+ - lib/thecompaniesapi/generated/models/action.rb
80
+ - lib/thecompaniesapi/generated/models/company_v2.rb
81
+ - lib/thecompaniesapi/generated/models/email_pattern.rb
82
+ - lib/thecompaniesapi/generated/models/job_title.rb
83
+ - lib/thecompaniesapi/generated/models/list.rb
84
+ - lib/thecompaniesapi/generated/models/list_analytics.rb
85
+ - lib/thecompaniesapi/generated/models/llmanswer.rb
86
+ - lib/thecompaniesapi/generated/models/nominatim_city.rb
87
+ - lib/thecompaniesapi/generated/models/nominatim_continent.rb
88
+ - lib/thecompaniesapi/generated/models/nominatim_country.rb
89
+ - lib/thecompaniesapi/generated/models/nominatim_county.rb
90
+ - lib/thecompaniesapi/generated/models/nominatim_state.rb
91
+ - lib/thecompaniesapi/generated/models/page_contents_ideated.rb
92
+ - lib/thecompaniesapi/generated/models/page_contents_link.rb
93
+ - lib/thecompaniesapi/generated/models/page_contents_page.rb
94
+ - lib/thecompaniesapi/generated/models/pagination_meta.rb
95
+ - lib/thecompaniesapi/generated/models/prompt.rb
96
+ - lib/thecompaniesapi/generated/models/segmentation_condition.rb
97
+ - lib/thecompaniesapi/generated/models/team.rb
98
+ - lib/thecompaniesapi/generated/models/technology.rb
99
+ - lib/thecompaniesapi/generated/models/user.rb
100
+ - lib/thecompaniesapi/generated/operations_map.rb
101
+ - lib/thecompaniesapi/generated/requests/ask_company_request.rb
102
+ - lib/thecompaniesapi/generated/requests/count_companies_post_request.rb
103
+ - lib/thecompaniesapi/generated/requests/create_list_request.rb
104
+ - lib/thecompaniesapi/generated/requests/export_companies_analytics_request.rb
105
+ - lib/thecompaniesapi/generated/requests/fetch_companies_in_list_post_request.rb
106
+ - lib/thecompaniesapi/generated/requests/product_prompt_request.rb
107
+ - lib/thecompaniesapi/generated/requests/prompt_to_segmentation_request.rb
108
+ - lib/thecompaniesapi/generated/requests/request_action_request.rb
109
+ - lib/thecompaniesapi/generated/requests/retry_action_request.rb
110
+ - lib/thecompaniesapi/generated/requests/search_companies_post_request.rb
111
+ - lib/thecompaniesapi/generated/requests/toggle_companies_in_list_request.rb
112
+ - lib/thecompaniesapi/generated/requests/update_list_request.rb
113
+ - lib/thecompaniesapi/generated/requests/update_team_request.rb
114
+ - lib/thecompaniesapi/generated/responses/ask_company_response.rb
115
+ - lib/thecompaniesapi/generated/responses/count_companies_post_response.rb
116
+ - lib/thecompaniesapi/generated/responses/count_companies_response.rb
117
+ - lib/thecompaniesapi/generated/responses/create_list_response.rb
118
+ - lib/thecompaniesapi/generated/responses/delete_list_response.rb
119
+ - lib/thecompaniesapi/generated/responses/delete_prompt_response.rb
120
+ - lib/thecompaniesapi/generated/responses/enrich_job_titles_response.rb
121
+ - lib/thecompaniesapi/generated/responses/export_companies_analytics_response.rb
122
+ - lib/thecompaniesapi/generated/responses/fetch_actions_response.rb
123
+ - lib/thecompaniesapi/generated/responses/fetch_api_health_response.rb
124
+ - lib/thecompaniesapi/generated/responses/fetch_companies_analytics_response.rb
125
+ - lib/thecompaniesapi/generated/responses/fetch_companies_in_list_post_response.rb
126
+ - lib/thecompaniesapi/generated/responses/fetch_companies_in_list_response.rb
127
+ - lib/thecompaniesapi/generated/responses/fetch_company_by_email_response.rb
128
+ - lib/thecompaniesapi/generated/responses/fetch_company_by_social_response.rb
129
+ - lib/thecompaniesapi/generated/responses/fetch_company_context_response.rb
130
+ - lib/thecompaniesapi/generated/responses/fetch_company_email_patterns_response.rb
131
+ - lib/thecompaniesapi/generated/responses/fetch_company_in_list_response.rb
132
+ - lib/thecompaniesapi/generated/responses/fetch_company_response.rb
133
+ - lib/thecompaniesapi/generated/responses/fetch_lists_response.rb
134
+ - lib/thecompaniesapi/generated/responses/fetch_open_api_response.rb
135
+ - lib/thecompaniesapi/generated/responses/fetch_prompts_response.rb
136
+ - lib/thecompaniesapi/generated/responses/fetch_team_response.rb
137
+ - lib/thecompaniesapi/generated/responses/fetch_user_response.rb
138
+ - lib/thecompaniesapi/generated/responses/product_prompt_response.rb
139
+ - lib/thecompaniesapi/generated/responses/prompt_to_segmentation_response.rb
140
+ - lib/thecompaniesapi/generated/responses/request_action_response.rb
141
+ - lib/thecompaniesapi/generated/responses/retry_action_response.rb
142
+ - lib/thecompaniesapi/generated/responses/search_cities_response.rb
143
+ - lib/thecompaniesapi/generated/responses/search_companies_by_name_response.rb
144
+ - lib/thecompaniesapi/generated/responses/search_companies_by_prompt_response.rb
145
+ - lib/thecompaniesapi/generated/responses/search_companies_post_response.rb
146
+ - lib/thecompaniesapi/generated/responses/search_companies_response.rb
147
+ - lib/thecompaniesapi/generated/responses/search_continents_response.rb
148
+ - lib/thecompaniesapi/generated/responses/search_counties_response.rb
149
+ - lib/thecompaniesapi/generated/responses/search_countries_response.rb
150
+ - lib/thecompaniesapi/generated/responses/search_industries_response.rb
151
+ - lib/thecompaniesapi/generated/responses/search_industries_similar_response.rb
152
+ - lib/thecompaniesapi/generated/responses/search_similar_companies_response.rb
153
+ - lib/thecompaniesapi/generated/responses/search_states_response.rb
154
+ - lib/thecompaniesapi/generated/responses/search_technologies_response.rb
155
+ - lib/thecompaniesapi/generated/responses/toggle_companies_in_list_response.rb
156
+ - lib/thecompaniesapi/generated/responses/update_list_response.rb
157
+ - lib/thecompaniesapi/generated/responses/update_team_response.rb
158
+ - lib/thecompaniesapi/http_client.rb
159
+ - lib/thecompaniesapi/version.rb
160
+ - script/generate_client.rb
161
+ - thecompaniesapi.gemspec
162
+ homepage: https://github.com/thecompaniesapi/sdk-ruby
163
+ licenses:
164
+ - MIT
165
+ metadata:
166
+ homepage_uri: https://www.thecompaniesapi.com
167
+ source_code_uri: https://github.com/thecompaniesapi/sdk-ruby
168
+ changelog_uri: https://github.com/thecompaniesapi/sdk-ruby/releases
169
+ post_install_message:
170
+ rdoc_options: []
171
+ require_paths:
172
+ - lib
173
+ required_ruby_version: !ruby/object:Gem::Requirement
174
+ requirements:
175
+ - - ">="
176
+ - !ruby/object:Gem::Version
177
+ version: 2.3.0
178
+ required_rubygems_version: !ruby/object:Gem::Requirement
179
+ requirements:
180
+ - - ">="
181
+ - !ruby/object:Gem::Version
182
+ version: '0'
183
+ requirements: []
184
+ rubygems_version: 3.3.27
185
+ signing_key:
186
+ specification_version: 4
187
+ summary: Ruby SDK for The Companies API
188
+ test_files: []