active_call-zoho_crm 0.1.0 → 0.1.2

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5692f8ba47b601d8c6781d92154ae4f2b229923bfdb34c5b1537eef054558bc3
4
- data.tar.gz: 95346571658eddc07819ad96a8b8d2bda19942dcd8d20d23fc6efc4283ff0a24
3
+ metadata.gz: dc5cad9fef5bdf6d08af960ad947f15e473339e0487024272f17eaee430a67ea
4
+ data.tar.gz: 22003443fa06c65c935742fb9c73ca7dd5308004a8fdb8a3456dc4ed9cf3abda
5
5
  SHA512:
6
- metadata.gz: 5f2d97143511747fec70a48323a0590cd633592b38e379be100c8a12666d31ff20e83c0d6975be5cbe97be265c3792ab931debaa431fe2b46b8e653eab32533e
7
- data.tar.gz: da622d9adc9047203d77e8c76340ddb3c800f898097d93562b0d381593b7641361d7120dd2c4b88fb8b154d2c74039c37cf2fc615ffcc573c7b33bfca59e24d7
6
+ metadata.gz: e9a94286dd658e2133fc957308f1855e9c6fdf76b00848e28240c99e1c525b321db9d278264316f9ebdac5cfb0b5d3b0d70a6e1db1f4131c842c2a9cb09948b4
7
+ data.tar.gz: 50a4ee9b4ab232926fb0560f4ec725cebe2c2d062b7ad00c09416f81a869b07e3257ac46550b72ee84658a59d89610741127baf6d74a1fd1e788e36f47f34713
data/CHANGELOG.md CHANGED
@@ -1,4 +1,11 @@
1
- ## [Unreleased]
1
+ ## [0.1.2] - 2025-04-11
2
+
3
+ - No changes. Gem version 0.1.1 does not seem to be findable.
4
+
5
+ ## [0.1.1] - 2025-04-11
6
+
7
+ - Update `CACHE_KEY` base `zoho_sign/...` -> `zoho_crm/...`
8
+ - README updates with links to API endpoint docs
2
9
 
3
10
  ## [0.1.0] - 2025-04-02
4
11
 
data/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # Active Call - Zoho CRM
2
2
 
3
+ [![Gem Version](https://badge.fury.io/rb/active_call-zoho_crm.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/active_call-zoho_crm)
4
+
3
5
  Zoho CRM exposes the [Zoho CRM API](https://www.zoho.com/crm/developer/docs/api) endpoints through service objects.
4
6
 
5
7
  - [Installation](#installation)
@@ -16,18 +18,16 @@ Zoho CRM exposes the [Zoho CRM API](https://www.zoho.com/crm/developer/docs/api)
16
18
 
17
19
  ## Installation
18
20
 
19
- TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
20
-
21
21
  Install the gem and add to the application's Gemfile by executing:
22
22
 
23
23
  ```bash
24
- bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
24
+ bundle add active_call-zoho_crm
25
25
  ```
26
26
 
27
27
  If bundler is not being used to manage dependencies, install the gem by executing:
28
28
 
29
29
  ```bash
30
- gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
30
+ gem install active_call-zoho_crm
31
31
  ```
32
32
 
33
33
  ## Configuration
@@ -228,6 +228,8 @@ For custom modules, use their respective API names in the request URL. You can o
228
228
  #### List records
229
229
 
230
230
  ```ruby
231
+ # https://www.zoho.com/crm/developer/docs/api/v7/get-records.html
232
+
231
233
  ZohoCrm::Record::ListService.call(module_name: 'Contacts', fields: 'Email,Last_Name', page: 1, per_page: 10).each do |facade|
232
234
  facade.attributes
233
235
  end
@@ -244,6 +246,8 @@ Columns to sort by are `id`, `Created_Time` and `Modified_Time`.
244
246
  #### Search records
245
247
 
246
248
  ```ruby
249
+ # https://www.zoho.com/crm/developer/docs/api/v7/search-records.html
250
+
247
251
  ZohoCrm::Record::SearchService.call(module_name: 'Contacts', email: 'eric.cartman@example.com', page: 1, per_page: 10).each do |facade|
248
252
  facade.attributes
249
253
  end
@@ -284,6 +288,8 @@ ZohoCrm::Record::SearchService.call(module_name: 'Contacts', word: 'eric').map {
284
288
  #### Get a record
285
289
 
286
290
  ```ruby
291
+ # https://www.zoho.com/crm/developer/docs/api/v7/get-records.html
292
+
287
293
  service = ZohoCrm::Record::GetService.call(module_name: 'Contacts', id: '')
288
294
  service.id
289
295
  service.attributes
@@ -296,7 +302,9 @@ service.attributes['Owner']['name']
296
302
  #### Create a record
297
303
 
298
304
  ```ruby
299
- service = ZohoCrm::Record::CreateService.call(
305
+ # https://www.zoho.com/crm/developer/docs/api/v7/insert-records.html
306
+
307
+ ZohoCrm::Record::CreateService.call(
300
308
  module_name: 'Contacts',
301
309
  data: {
302
310
  'Email' => 'eric.cartman@example.com',
@@ -309,7 +317,9 @@ service = ZohoCrm::Record::CreateService.call(
309
317
  #### Update a record
310
318
 
311
319
  ```ruby
312
- service = ZohoCrm::Record::UpdateService.call(
320
+ # https://www.zoho.com/crm/developer/docs/api/v7/update-records.html
321
+
322
+ ZohoCrm::Record::UpdateService.call(
313
323
  module_name: 'Contacts',
314
324
  data: {
315
325
  'id' => '',
@@ -321,7 +331,9 @@ service = ZohoCrm::Record::UpdateService.call(
321
331
  #### Upsert a record
322
332
 
323
333
  ```ruby
324
- service = ZohoCrm::Record::UpsertService.call(
334
+ # https://www.zoho.com/crm/developer/docs/api/v7/upsert-records.html
335
+
336
+ ZohoCrm::Record::UpsertService.call(
325
337
  module_name: 'Contacts',
326
338
  data: {
327
339
  'Email' => 'eric.cartman@example.com',
@@ -335,7 +347,25 @@ service = ZohoCrm::Record::UpsertService.call(
335
347
  #### Delete a record
336
348
 
337
349
  ```ruby
338
- service = ZohoCrm::Record::DeleteService.call(module_name: 'Contacts', id: '')
350
+ # https://www.zoho.com/crm/developer/docs/api/v7/delete-records.html
351
+
352
+ ZohoCrm::Record::DeleteService.call(module_name: 'Contacts', id: '')
353
+ ```
354
+
355
+ </details>
356
+
357
+ <details>
358
+ <summary>Organization</summary>
359
+
360
+ ### Organization
361
+
362
+ #### Get a organization
363
+
364
+ ```ruby
365
+ # https://www.zoho.com/crm/developer/docs/api/v7/get-org-data.html
366
+
367
+ service = ZohoCrm::Organization::GetService.call
368
+ service.attributes
339
369
  ```
340
370
 
341
371
  </details>
@@ -9,6 +9,8 @@ class ZohoCrm::AccessToken::GetService < ZohoCrm::BaseService
9
9
 
10
10
  # Get access token.
11
11
  #
12
+ # https://www.zoho.com/crm/developer/docs/api/v7/refresh.html
13
+ #
12
14
  # ==== Examples
13
15
  #
14
16
  # service = ZohoCrm::AccessToken::GetService.call
@@ -5,7 +5,7 @@ class ZohoCrm::BaseService < ActiveCall::Base
5
5
 
6
6
  self.abstract_class = true
7
7
 
8
- CACHE_KEY = { access_token: 'zoho_sign/base_service/access_token' }.freeze
8
+ CACHE_KEY = { access_token: 'zoho_crm/base_service/access_token' }.freeze
9
9
 
10
10
  config_accessor :base_url, default: 'https://www.zohoapis.com/crm/v7', instance_writer: false
11
11
  config_accessor :cache, default: ActiveSupport::Cache::MemoryStore.new, instance_writer: false
@@ -20,6 +20,8 @@ class ZohoCrm::GrantToken::GetService < ZohoCrm::BaseService
20
20
 
21
21
  # Get refresh token from grant token.
22
22
  #
23
+ # https://www.zoho.com/crm/developer/docs/api/v7/access-refresh.html
24
+ #
23
25
  # ==== Examples
24
26
  #
25
27
  # service = ZohoCrm::GrantToken::GetService.call(grant_token: '', client_id: '', client_secret: '')
@@ -7,6 +7,8 @@ class ZohoCrm::Organization::GetService < ZohoCrm::BaseService
7
7
 
8
8
  # Get a document.
9
9
  #
10
+ # https://www.zoho.com/crm/developer/docs/api/v7/get-org-data.html
11
+ #
10
12
  # ==== Examples
11
13
  #
12
14
  # service = ZohoCrm::Organization::GetService.call
@@ -16,6 +16,8 @@ class ZohoCrm::Record::CreateService < ZohoCrm::BaseService
16
16
 
17
17
  # Create a record.
18
18
  #
19
+ # https://www.zoho.com/crm/developer/docs/api/v7/insert-records.html
20
+ #
19
21
  # ==== Examples
20
22
  #
21
23
  # service = ZohoCrm::Record::CreateService.call(
@@ -16,6 +16,8 @@ class ZohoCrm::Record::DeleteService < ZohoCrm::BaseService
16
16
 
17
17
  # Delete a record.
18
18
  #
19
+ # https://www.zoho.com/crm/developer/docs/api/v7/delete-records.html
20
+ #
19
21
  # ==== Examples
20
22
  #
21
23
  # service = ZohoCrm::Record::DeleteService.call(module_name: 'Contacts', id: '')
@@ -16,6 +16,8 @@ class ZohoCrm::Record::GetService < ZohoCrm::BaseService
16
16
 
17
17
  # Get a document.
18
18
  #
19
+ # https://www.zoho.com/crm/developer/docs/api/v7/get-records.html
20
+ #
19
21
  # ==== Examples
20
22
  #
21
23
  # service = ZohoCrm::Record::GetService.call(module_name: 'Contacts', id: '')
@@ -18,6 +18,8 @@ class ZohoCrm::Record::ListService < ZohoCrm::BaseService
18
18
 
19
19
  # List records.
20
20
  #
21
+ # https://www.zoho.com/crm/developer/docs/api/v7/get-records.html
22
+ #
21
23
  # ==== Examples
22
24
  #
23
25
  # service = ZohoCrm::Record::ListService.call(module_name: 'Contacts', fields: 'Email,Last_Name').first
@@ -18,6 +18,8 @@ class ZohoCrm::Record::SearchService < ZohoCrm::BaseService
18
18
 
19
19
  # List records.
20
20
  #
21
+ # https://www.zoho.com/crm/developer/docs/api/v7/search-records.html
22
+ #
21
23
  # ==== Examples
22
24
  #
23
25
  # service = ZohoCrm::Record::SearchService.call(module_name: 'Contacts', email: 'eric.cartman@example.com').first
@@ -16,6 +16,8 @@ class ZohoCrm::Record::UpdateService < ZohoCrm::BaseService
16
16
 
17
17
  # Create a record.
18
18
  #
19
+ # https://www.zoho.com/crm/developer/docs/api/v7/update-records.html
20
+ #
19
21
  # ==== Examples
20
22
  #
21
23
  # service = ZohoCrm::Record::UpdateService.call(
@@ -19,6 +19,8 @@ class ZohoCrm::Record::UpsertService < ZohoCrm::BaseService
19
19
 
20
20
  # Create a record.
21
21
  #
22
+ # https://www.zoho.com/crm/developer/docs/api/v7/upsert-records.html
23
+ #
22
24
  # ==== Examples
23
25
  #
24
26
  # service = ZohoCrm::Record::UpsertService.call(
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module ZohoCrm
4
- VERSION = '0.1.0'
4
+ VERSION = '0.1.2'
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: active_call-zoho_crm
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Kobus Joubert
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2025-04-05 00:00:00.000000000 Z
11
+ date: 2025-04-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: active_call-api