README.md in rdstation-ruby-client-0.1.1 vs README.md in rdstation-ruby-client-1.0.0

- old
+ new

@@ -47,29 +47,29 @@ rdstation_client.change_lead_status(email: 'joe@foo.bar', status: 'won', value: 999) ``` ### Authentication -#### Getting authentication URL +#### Getting authentication URL ```ruby rdstation_authentication = RDStation::Authentication.new('client_id', 'client_secret') redirect_url = 'https://yourapp.org/auth/callback' rdstation_authentication.auth_url(redirect_url) ``` -#### Getting access_token +#### Getting access_token You will need the code param that is returned from RD Station to your application after the user confirms the access at the authorization dialog. ```ruby rdstation_authentication = RDStation::Authentication.new('client_id', 'client_secret') rdstation_authentication.authenticate(code_returned_from_rdstation) ``` -#### Updating access_token +#### Updating access_token ```ruby rdstation_authentication = RDStation::Authentication.new('client_id', 'client_secret') rdstation_authentication.update_access_token('refresh_token') ``` @@ -79,38 +79,38 @@ #### Getting a Contact by UUID Returns data about a specific Contact ```ruby -rdstation_contacts = RDStation::Contacts.new('auth_token') -rdstation_contacts.get_contact('uuid') +contact = RDStation::Contacts.new('auth_token') +contact.by_uuid('uuid') ``` More info: https://developers.rdstation.com/pt-BR/reference/contacts#methodGetDetailsuuid #### Getting a Contact by Email Returns data about a specific Contact ```ruby -rdstation_contacts = RDStation::Contacts.new('auth_token') -rdstation_contacts.get_contact_by_email('email') +contact = RDStation::Contacts.new('auth_token') +contact.by_email('email') ``` More info: https://developers.rdstation.com/pt-BR/reference/contacts#methodGetDetailsemail #### Update a Contact by UUID -Updates the properties of a Contact. +Updates the properties of a Contact. ```ruby contact_info = { name: "Joe Foo" } -rdstation_contacts = RDStation::Contacts.new('auth_token') -rdstation_contacts.update_contact('uuid', contact_info) +contact = RDStation::Contacts.new('auth_token') +contact.update('uuid', contact_info) ``` Contact Default Parameters - email - name - job_title @@ -125,21 +125,21 @@ More info: https://developers.rdstation.com/pt-BR/reference/contacts#methodPatchDetails #### Upsert a Contact by identifier and value -With an UPSERT like behavior, this method is capable of both updating the properties of a Contact or creating a new Contact. Whatever is used as an identifier cannot appear in the request payload as a field. This will result in a [BAD_REQUEST error](https://developers.rdstation.com/pt-BR/error-states#conflicting). +With an UPSERT like behavior, this method is capable of both updating the properties of a Contact or creating a new Contact. Whatever is used as an identifier cannot appear in the request payload as a field. This will result in a [BAD_REQUEST error](https://developers.rdstation.com/pt-BR/error-states#conflicting). ```ruby contact_info = { name: "Joe Foo" } identifier = "email" identifier_value = "joe@foo.bar" -rdstation_contacts = RDStation::Contacts.new('auth_token') -rdstation_contacts.upsert_contact(identifier, identifier_value, contact_info) +contact = RDStation::Contacts.new('auth_token') +contact.upsert(identifier, identifier_value, contact_info) ``` More info: https://developers.rdstation.com/pt-BR/reference/contacts#methodPatchUpsertDetails ## Contributing