Skip to content

Latest commit

 

History

History
229 lines (148 loc) · 10.1 KB

ContactsApi.md

File metadata and controls

229 lines (148 loc) · 10.1 KB
Raw

Zuora::ContactsApi

All URIs are relative to https://rest.zuora.com

Method HTTP request Description
object_delete_contact DELETE /v1/object/contact/{id} CRUD: Delete Contact
object_get_contact GET /v1/object/contact/{id} CRUD: Retrieve Contact
object_post_contact POST /v1/object/contact CRUD: Create Contact
object_put_contact PUT /v1/object/contact/{id} CRUD: Update Contact

object_delete_contact

ProxyDeleteResponse object_delete_contact(id, opts)

CRUD: Delete Contact

Example

# load the gem
require 'zuora'

api_instance = Zuora::ContactsApi.new

id = "id_example" # String | Object id

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #CRUD: Delete Contact
  result = api_instance.object_delete_contact(id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling ContactsApi->object_delete_contact: #{e}"
end

Parameters

Name Type Description Notes
id String Object id
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]

Return type

ProxyDeleteResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

object_get_contact

ProxyGetContact object_get_contact(id, opts)

CRUD: Retrieve Contact

Example

# load the gem
require 'zuora'

api_instance = Zuora::ContactsApi.new

id = "id_example" # String | Object id

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  fields: "fields_example" # String | Object fields to return
}

begin
  #CRUD: Retrieve Contact
  result = api_instance.object_get_contact(id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling ContactsApi->object_get_contact: #{e}"
end

Parameters

Name Type Description Notes
id String Object id
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
fields String Object fields to return [optional]

Return type

ProxyGetContact

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

object_post_contact

ProxyCreateOrModifyResponse object_post_contact(create_request, opts)

CRUD: Create Contact

Example

# load the gem
require 'zuora'

api_instance = Zuora::ContactsApi.new

create_request = Zuora::ProxyCreateContact.new # ProxyCreateContact | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #CRUD: Create Contact
  result = api_instance.object_post_contact(create_request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling ContactsApi->object_post_contact: #{e}"
end

Parameters

Name Type Description Notes
create_request ProxyCreateContact
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]

Return type

ProxyCreateOrModifyResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

object_put_contact

ProxyCreateOrModifyResponse object_put_contact(id, modify_request, opts)

CRUD: Update Contact

Example

# load the gem
require 'zuora'

api_instance = Zuora::ContactsApi.new

id = "id_example" # String | Object id

modify_request = Zuora::ProxyModifyContact.new # ProxyModifyContact | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #CRUD: Update Contact
  result = api_instance.object_put_contact(id, modify_request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling ContactsApi->object_put_contact: #{e}"
end

Parameters

Name Type Description Notes
id String Object id
modify_request ProxyModifyContact
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]

Return type

ProxyCreateOrModifyResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8