Skip to content
This repository was archived by the owner on Apr 28, 2023. It is now read-only.

Commit

Permalink
docs: Documented some API Response objects
Browse files Browse the repository at this point in the history
  • Loading branch information
maxrdz committed Jun 6, 2022
1 parent e99ba17 commit f7cbc4d
Show file tree
Hide file tree
Showing 5 changed files with 110 additions and 3 deletions.
28 changes: 25 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@
# SDK / API Documentation
Please feel free to make contributions to the documentation by submitting a pull request with your contribution.

### [Click here to jump to API documentation.](#API-Documentation)

### Key / Legend
```

⚠ - Missing more documentation
```

![](docs-icon.png) - Read full markdown documentation

## SDK Documentation

Expand All @@ -20,7 +23,9 @@ Please feel free to make contributions to the documentation by submitting a pull
- ### Interfaces
- [CLIENT_EVENTS](sdk-docs/interfaces/CLIENT_EVENTS.md)
- ### Classes
- ### `Client()` - [Client.md](sdk-docs/classes/Client.md)
- ### Client - [![See docs](docs-icon.png)](sdk-docs/classes/Client.md)
- [constructor()](sdk-docs/classes/Client.md#constructor)

- #### Public Methods (A-Z)
- [api_call()](sdk-docs/classes/Client.md#api_call)
- [authenticate_stream()](sdk-docs/classes/Client.md#authenticate_stream)
Expand All @@ -41,12 +46,29 @@ Please feel free to make contributions to the documentation by submitting a pull
- [sleep()](sdk-docs/classes/Client.md#sleep)
- [submit_phone_number()](sdk-docs/classes/Client.md#submit_phone_number)
- [submit_verification_code()](sdk-docs/classes/Client.md#submit_verification_code)

- #### Private Methods (A-Z)
- [send_device_token()](sdk-docs/classes/Client.md#send_device_token)
- [stream_send()](sdk-docs/classes/Client.md#stream_send)
- [submit_credential()](sdk-docs/classes/Client.md#submit_credential)
- [trigger_event()](sdk-docs/classes/Client.md#trigger_event)

- ### ApiResponseBase - [![See docs](docs-icon.png)](sdk-docs/classes/ApiResponseBase.md)
- [constructor()](sdk-docs/classes/ApiResponseBase.md#constructor)

- #### Public Methods (A-Z)
- [set_attributes()](sdk-docs/classes/ApiResponseBase.md#set_attributes)

- ### Session - [![See docs](docs-icon.png)](sdk-docs/classes/Session.md)
- [constructor()](sdk-docs/classes/Session.md#constructor)

- #### Public Methods (A-Z)
- [set_phone_number()](sdk-docs/classes/Session.md#set_phone_number)
- [set_verify_code()](sdk-docs/classes/Session.md#set_verify_code)

- ### Config - [![See docs](docs-icon.png)](sdk-docs/classes/Config.md)
- [constructor()](sdk-docs/classes/Config.md#constructor)

## API Documentation

- ### HTTPS Web API
Expand Down
Binary file added docs/docs-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions docs/sdk-docs/classes/ApiResponseBase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Class: `ApiResponseBase`

#### Short summary of the class object and what it does.

## Class Properties

- #### Private Properties
- `attribute_one`: **_string_**

# Public Methods

## constructor()

- #### constructor(args: { foo?: _[string]()_, bar?: _[string]()_, opt?: _[boolean]()_ })

- CShort description of the class method and what it does.

## set_attributes()

- #### set_attributes(args: { option?: _[boolean]()_ }): [return type]()

- Short description of the class method and what it does.
35 changes: 35 additions & 0 deletions docs/sdk-docs/classes/Config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Class: `Config` extends `ApiResponseBase`

#### Represents the response given from the Configs API endpoint.

## Class Properties

- #### Public Properties
- `attributes`: _[object]()_
- `is_app_update_required`: _[boolean]()_ | _null_
- `is_live`: _[boolean]()_ | _null_
- `is_uploads_enabled`: _[boolean]()_ | _null_
- `app_share_url`: _[string]()_ | _null_
- `multi_invite_text`: _[string]()_ | _null_
- `invite_text_body`: _[string]()_ | _null_
- `invite_share_view_description`: _[string]()_ | _null_
- `minimum_posts_hide_invite_share`: _[number]()_ | _null_
- `minimum_posted_hide_invite_share`: _[number]()_ | _null_
- `minimum_feed_hide_invite_share`: _[number]()_ | _null_
- `snap_username`: _[string]()_ | _null_
- `ig_username`: _[string]()_ | _null_
- `twitter_username`: _[string]()_ | _null_
- `default_reaction_emojis`: [Array]()<_[string]()_> | _null_
- `delete_account_available`: _[boolean]()_ | _null_
- `in_app_post_message`: _[string]()_ | _null_
- `onboarding_invite_user_filter`: _[boolean]()_ | _null_
- `is_auto_follow_on`: _[boolean]()_ | _null_
- `max_name_length`: _[number]()_ | _null_

# Public Methods

## constructor()

- #### constructor(bundle_version: _[string]()_, args: {})

- Sets the bundle version on a new Config object. Still a WIP.
28 changes: 28 additions & 0 deletions docs/sdk-docs/classes/Session.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Class: `Session` extends `ApiResponseBase`

#### Short summary of the class object and what it does.

## Class Properties

- #### Private Properties
- `attribute_one`: **_string_**

# Public Methods

## constructor()

- #### constructor(args: { foo?: _[string]()_, bar?: _[string]()_, opt?: _[boolean]()_ })

- CShort description of the class method and what it does.

## set_phone_number()

- #### set_attributes(args: { option?: _[boolean]()_ }): [return type]()

- Short description of the class method and what it does.

## set_verify_code()

- #### set_attributes(args: { option?: _[boolean]()_ }): [return type]()

- Short description of the class method and what it does.

0 comments on commit f7cbc4d

Please sign in to comment.